semantic_governance_policy_engine

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

Overview

Name	semantic_governance_policy_engine
Type	Resource
Id	google.aiplatform.semantic_governance_policy_engine

Fields

The following fields are returned by SELECT queries:

get_semantic_governance_policy_engine

Name	Datatype	Description
name	string	Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine
createTime	string (google-datetime)	Output only. Timestamp when this SemanticGovernancePolicyEngine was created.
gatewayConfigs	object	Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed.
ipAddress	string	Output only. The private IPv4 address of the PSC endpoint.
pscForwardingRule	string	Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
pscServiceAttachment	string	Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
state	string	Output only. The state of the SemanticGovernancePolicyEngine. (STATE_UNSPECIFIED, PROVISIONING, ACTIVE, DEPROVISIONING, INACTIVE, FAILED)
updateTime	string (google-datetime)	Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_semantic_governance_policy_engine	select	projectsId, locationsId		Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.
update_semantic_governance_policy_engine	update	projectsId, locationsId	updateMask	Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.
deprovision	exec	projectsId, locationsId		Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.

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
updateMask	string (google-fieldmask)

SELECT examples

get_semantic_governance_policy_engine

Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.

SELECT
name,
createTime,
gatewayConfigs,
ipAddress,
pscForwardingRule,
pscServiceAttachment,
state,
updateTime
FROM google.aiplatform.semantic_governance_policy_engine
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
;

UPDATE examples

update_semantic_governance_policy_engine

Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.

UPDATE google.aiplatform.semantic_governance_policy_engine
SET 
data__name = '{{ name }}',
data__gatewayConfigs = '{{ gatewayConfigs }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

Lifecycle Methods

deprovision

Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.

EXEC google.aiplatform.semantic_governance_policy_engine.deprovision 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"force": {{ force }}
}'
;