Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1 Client class DataAgent.
Message describing a DataAgent object.
Generated from protobuf message google.cloud.geminidataanalytics.v1.DataAgent
Namespace
Google \ Cloud \ GeminiDataAnalytics \ V1Methods
__construct
Constructor.
data
mixed
getDataAnalyticsAgent
Data analytics agent.
hasDataAnalyticsAgent
setDataAnalyticsAgent
Data analytics agent.
$this
getName
Optional. Identifier. The unique resource name of a DataAgent.
Format: projects/{project}/locations/{location}/dataAgents/{data_agent_id}
{data_agent}
is the resource id and should be 63 characters or less and
must match the format described in https://google.aip.dev/122#resource-id-segments
Example: projects/1234567890/locations/global/dataAgents/my-agent
.
It is recommended to skip setting this field during agent creation as it
will be inferred automatically and overwritten with the
{parent}/dataAgents/{data_agent_id}.
string
setName
Optional. Identifier. The unique resource name of a DataAgent.
Format: projects/{project}/locations/{location}/dataAgents/{data_agent_id}
{data_agent}
is the resource id and should be 63 characters or less and
must match the format described in https://google.aip.dev/122#resource-id-segments
Example: projects/1234567890/locations/global/dataAgents/my-agent
.
It is recommended to skip setting this field during agent creation as it
will be inferred automatically and overwritten with the
{parent}/dataAgents/{data_agent_id}.
var
string
$this
getDisplayName
Optional. User friendly display name.
- Must be between 1-256 characters.
string
setDisplayName
Optional. User friendly display name.
- Must be between 1-256 characters.
var
string
$this
getDescription
Optional. Description of the agent.
- Must be between 1-1024 characters.
string
setDescription
Optional. Description of the agent.
- Must be between 1-1024 characters.
var
string
$this
getLabels
Optional. Labels to help users filter related agents.
For example, "sales", "business", "etl", and so on. Note labels are used only for filtering and not for policies. See the labels documentation for more details on label usage.
setLabels
Optional. Labels to help users filter related agents.
For example, "sales", "business", "etl", and so on. Note labels are used only for filtering and not for policies. See the labels documentation for more details on label usage.
$this
getCreateTime
Output only. The time when the data agent was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time when the data agent was created.
$this
getUpdateTime
Output only. The time when the data agent was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time when the data agent was last updated.
$this
getDeleteTime
Output only. [Output only] The time the data agent was soft deleted.
hasDeleteTime
clearDeleteTime
setDeleteTime
Output only. [Output only] The time the data agent was soft deleted.
$this
getPurgeTime
Output only. Timestamp in UTC of when this data agent is considered expired. This is always provided on output, regardless of what was sent on input.
hasPurgeTime
clearPurgeTime
setPurgeTime
Output only. Timestamp in UTC of when this data agent is considered expired. This is always provided on output, regardless of what was sent on input.
$this
getKmsKey
Optional. Customer managed encryption key (CMEK) to use for encrypting the
DataAgent resources. Cloud KMS CryptoKeys must reside in the same location
as the DataAgent. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*
.
string
hasKmsKey
clearKmsKey
setKmsKey
Optional. Customer managed encryption key (CMEK) to use for encrypting the
DataAgent resources. Cloud KMS CryptoKeys must reside in the same location
as the DataAgent. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*
.
var
string
$this
getType
string
