clients

Creates, updates, deletes, gets or lists a clients resource.

Overview

Name	clients
Type	Resource
Id	google.integrations.clients

Fields

The following fields are returned by SELECT queries:

projects_locations_get_clients

Successful response

Name	Datatype	Description
client	object	Required. Required: The client configuration that was requested (id: GoogleCloudIntegrationsV1alphaClientConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_get_clients	select	projectsId, locationsId		Gets the client configuration for the given project and location resource name
projects_locations_clients_replace	replace	projectsId, locationsId		Update run-as service account for provisioned client
projects_locations_clients_provision	exec	projectsId, locationsId		Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.
projects_locations_clients_provision_client_post_processor	exec	projectsId, locationsId		Perform post provisioning steps after client is provisioned.
projects_locations_clients_deprovision	exec	projectsId, locationsId		Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.
projects_locations_clients_change_config	exec	projectsId, locationsId		Updates the client customer configuration for the given project and location resource name
projects_locations_clients_switch	exec	projectsId, locationsId		Update client from GMEK to CMEK
projects_locations_clients_switch_variable_masking	exec	projectsId, locationsId		Update variable masking for provisioned client
projects_locations_clients_toggle_http	exec	projectsId, locationsId		Enable/Disable http call for provisioned client

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string

SELECT examples

projects_locations_get_clients

Gets the client configuration for the given project and location resource name

SELECT
client
FROM google.integrations.clients
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

REPLACE examples

projects_locations_clients_replace

Update run-as service account for provisioned client

REPLACE google.integrations.clients
SET 
data__runAsServiceAccount = '{{ runAsServiceAccount }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required;

Lifecycle Methods

projects_locations_clients_provision

Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.

EXEC google.integrations.clients.projects_locations_clients_provision 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"cloudKmsConfig": "{{ cloudKmsConfig }}", 
"createSampleWorkflows": {{ createSampleWorkflows }}, 
"provisionGmek": {{ provisionGmek }}, 
"runAsServiceAccount": "{{ runAsServiceAccount }}", 
"skipCpProvision": {{ skipCpProvision }}, 
"enableHttpCall": {{ enableHttpCall }}, 
"enableManagedAiFeatures": {{ enableManagedAiFeatures }}
}';

projects_locations_clients_provision_client_post_processor

Perform post provisioning steps after client is provisioned.

EXEC google.integrations.clients.projects_locations_clients_provision_client_post_processor 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"workflows": "{{ workflows }}"
}';

projects_locations_clients_deprovision

Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.

EXEC google.integrations.clients.projects_locations_clients_deprovision 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required;

projects_locations_clients_change_config

Updates the client customer configuration for the given project and location resource name

EXEC google.integrations.clients.projects_locations_clients_change_config 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"updateMask": "{{ updateMask }}", 
"customerConfig": "{{ customerConfig }}"
}';

projects_locations_clients_switch

Update client from GMEK to CMEK

EXEC google.integrations.clients.projects_locations_clients_switch 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"cloudKmsConfig": "{{ cloudKmsConfig }}"
}';

projects_locations_clients_switch_variable_masking

Update variable masking for provisioned client

EXEC google.integrations.clients.projects_locations_clients_switch_variable_masking 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"enableVariableMasking": {{ enableVariableMasking }}
}';

projects_locations_clients_toggle_http

Enable/Disable http call for provisioned client

EXEC google.integrations.clients.projects_locations_clients_toggle_http 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"enableHttpCall": {{ enableHttpCall }}
}';