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

0.16.0 (latest) 0.15.0 0.14.1 0.11.1 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

getBigqueryAgentAnalyticsEnabled

Optional. Controls whether BigQuery Agent Analytics trace logging is enabled for the agent.

BigQuery Agent Analytics is in Preview and is delivered to enrolled projects only. In a project that is not enrolled this field is accepted and stored, but no trace rows are written and no error is returned. Trace logging is additionally suppressed for the entire turn, without error, when any table in the agent's datasource carries row-level security, column-level security or policy tags. It is also suppressed when that determination cannot be made, for example when the caller lacks permission to list a table's row access policies. Trace rows are written only when this is true and bigquery_agent_analytics_table is set. On a BigQuery agent, enabling this without a table has no effect: no table is created for the agent and no rows are written. On an agent whose datasource is not BigQuery, CreateDataAgent and UpdateDataAgent reject setting this field to true or setting bigquery_agent_analytics_table with INVALID_ARGUMENT. See bigquery_agent_analytics_table for when this is checked. This setting is independent of the project-level BigQuery Agent Analytics setting configured through SetAgentOpsObservability. An agent does not inherit that setting.

Returns
Type	Description
bool

hasBigqueryAgentAnalyticsEnabled

clearBigqueryAgentAnalyticsEnabled

setBigqueryAgentAnalyticsEnabled

Optional. Controls whether BigQuery Agent Analytics trace logging is enabled for the agent.

BigQuery Agent Analytics is in Preview and is delivered to enrolled projects only. In a project that is not enrolled this field is accepted and stored, but no trace rows are written and no error is returned. Trace logging is additionally suppressed for the entire turn, without error, when any table in the agent's datasource carries row-level security, column-level security or policy tags. It is also suppressed when that determination cannot be made, for example when the caller lacks permission to list a table's row access policies. Trace rows are written only when this is true and bigquery_agent_analytics_table is set. On a BigQuery agent, enabling this without a table has no effect: no table is created for the agent and no rows are written. On an agent whose datasource is not BigQuery, CreateDataAgent and UpdateDataAgent reject setting this field to true or setting bigquery_agent_analytics_table with INVALID_ARGUMENT. See bigquery_agent_analytics_table for when this is checked. This setting is independent of the project-level BigQuery Agent Analytics setting configured through SetAgentOpsObservability. An agent does not inherit that setting.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getBigqueryAgentAnalyticsTable

Optional. The BigQuery table that BigQuery Agent Analytics trace rows are written to. Has no effect unless bigquery_agent_analytics_enabled is true. The Preview enrollment described on that field applies here too.

The trace table is validated when it is set on CreateDataAgent, or when an UpdateDataAgent call writes a table to it. An UpdateDataAgent call writes a field if the field is in update_mask or, when update_mask is omitted, if the field is present in the request, even if its value is unchanged. An update that only clears this field is not validated. The following are rejected with INVALID_ARGUMENT:

• The table must belong to the same project as the agent.
• The agent's datasource must be BigQuery. BigQuery Agent Analytics is not supported for Looker, Looker Studio or AlloyDB agents. On CreateDataAgent, the datasource is validated against the agent in the request. On UpdateDataAgent, it is validated against the stored agent after applying the update whenever the call writes a table to this field or writes true to bigquery_agent_analytics_enabled. For example, an UpdateDataAgent call without update_mask that carries an unchanged bigquery_agent_analytics_enabled = true is rejected on an agent whose datasource is not BigQuery. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource by an update that does neither is not re-validated; in the latter case no trace rows are written. The destination dataset must already exist and must grant write access to the project's Gemini Data Analytics service agent, whose address is service-PROJECT_NUMBER\@gcp-sa-geminidataanalytics.iam.gserviceaccount.com (that grant is not performed on your behalf). Without it the agent answers normally and no trace rows are written. Changing the table on an existing agent affects subsequent turns only. Rows already written to the previous table are left in place.

Returns
Type	Description
BigQueryTableReference|null

hasBigqueryAgentAnalyticsTable

clearBigqueryAgentAnalyticsTable

setBigqueryAgentAnalyticsTable

Optional. The BigQuery table that BigQuery Agent Analytics trace rows are written to. Has no effect unless bigquery_agent_analytics_enabled is true. The Preview enrollment described on that field applies here too.

The trace table is validated when it is set on CreateDataAgent, or when an UpdateDataAgent call writes a table to it. An UpdateDataAgent call writes a field if the field is in update_mask or, when update_mask is omitted, if the field is present in the request, even if its value is unchanged. An update that only clears this field is not validated. The following are rejected with INVALID_ARGUMENT:

• The table must belong to the same project as the agent.
• The agent's datasource must be BigQuery. BigQuery Agent Analytics is not supported for Looker, Looker Studio or AlloyDB agents. On CreateDataAgent, the datasource is validated against the agent in the request. On UpdateDataAgent, it is validated against the stored agent after applying the update whenever the call writes a table to this field or writes true to bigquery_agent_analytics_enabled. For example, an UpdateDataAgent call without update_mask that carries an unchanged bigquery_agent_analytics_enabled = true is rejected on an agent whose datasource is not BigQuery. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource by an update that does neither is not re-validated; in the latter case no trace rows are written. The destination dataset must already exist and must grant write access to the project's Gemini Data Analytics service agent, whose address is service-PROJECT_NUMBER\@gcp-sa-geminidataanalytics.iam.gserviceaccount.com (that grant is not performed on your behalf). Without it the agent answers normally and no trace rows are written. Changing the table on an existing agent affects subsequent turns only. Rows already written to the previous table are left in place.

Parameter
Name	Description
var	BigQueryTableReference

Returns
Type	Description
$this

getType

Returns
Type	Description
string