Google Cloud Gemini Data Analytics V1beta Client - Class DataAgent (0.11.1)

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class DataAgent.

Message describing a DataAgent object.

Generated from protobuf message google.cloud.geminidataanalytics.v1beta.DataAgent

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1beta

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

getDataAnalyticsAgent

Data analytics agent.

Returns
Type Description
DataAnalyticsAgent|null

hasDataAnalyticsAgent

setDataAnalyticsAgent

Data analytics agent.

Parameter
Name Description
var DataAnalyticsAgent
Returns
Type Description
$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}.

Returns
Type Description
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}.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Optional. User friendly display name.

  • Must be between 1-256 characters.
Returns
Type Description
string

setDisplayName

Optional. User friendly display name.

  • Must be between 1-256 characters.
Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Optional. Description of the agent.

  • Must be between 1-1024 characters.
Returns
Type Description
string

setDescription

Optional. Description of the agent.

  • Must be between 1-1024 characters.
Parameter
Name Description
var string
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Internal\MapField

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.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getCreateTime

Output only. The time when the data agent was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the data agent was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time when the data agent was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the data agent was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDeleteTime

Output only. [Output only] The time the data agent was soft deleted.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. [Output only] The time the data agent was soft deleted.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Timestamp|null

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.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$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/*.

Returns
Type Description
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/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Returns
Type Description
string