Class DataAgent.Builder (0.27.0) 

public static final class DataAgent.Builder extends GeneratedMessage.Builder<DataAgent.Builder> implements DataAgentOrBuilder

Message describing a DataAgent object.

Protobuf type google.cloud.geminidataanalytics.v1.DataAgent

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > DataAgent.Builder

Implements

DataAgentOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public DataAgent build()
Returns
Type Description
DataAgent

buildPartial()

public DataAgent buildPartial()
Returns
Type Description
DataAgent

clear()

public DataAgent.Builder clear()
Returns
Type Description
DataAgent.Builder
Overrides

clearBigqueryAgentAnalyticsEnabled()

public DataAgent.Builder clearBigqueryAgentAnalyticsEnabled()

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 rejects either field with INVALID_ARGUMENT.

This setting is independent of the project-level BigQuery Agent Analytics setting configured through SetAgentOpsObservability. An agent does not inherit that setting.

optional bool bigquery_agent_analytics_enabled = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataAgent.Builder

This builder for chaining.

clearBigqueryAgentAnalyticsTable()

public DataAgent.Builder clearBigqueryAgentAnalyticsTable()

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 it is included in the update_mask of an UpdateDataAgent call. 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.

    These are validated against the agent as sent in the request. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource 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.

.google.cloud.geminidataanalytics.v1.BigQueryTableReference bigquery_agent_analytics_table = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataAgent.Builder

clearCreateTime()

public DataAgent.Builder clearCreateTime()

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

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataAgent.Builder

clearDataAnalyticsAgent()

public DataAgent.Builder clearDataAnalyticsAgent()

Data analytics agent.

.google.cloud.geminidataanalytics.v1.DataAnalyticsAgent data_analytics_agent = 101;

Returns
Type Description
DataAgent.Builder

clearDeleteTime()

public DataAgent.Builder clearDeleteTime()

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

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataAgent.Builder

clearDescription()

public DataAgent.Builder clearDescription()

Optional. Description of the agent.

  • Must be between 1-1024 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataAgent.Builder

This builder for chaining.

clearDisplayName()

public DataAgent.Builder clearDisplayName()

Optional. User friendly display name.

  • Must be between 1-256 characters.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DataAgent.Builder

This builder for chaining.

clearKmsKey()

public DataAgent.Builder clearKmsKey()

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/*.

optional string kms_key = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
DataAgent.Builder

This builder for chaining.

clearLabels()

public DataAgent.Builder clearLabels()
Returns
Type Description
DataAgent.Builder

clearName()

public DataAgent.Builder clearName()

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 name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
DataAgent.Builder

This builder for chaining.

clearPurgeTime()

public DataAgent.Builder clearPurgeTime()

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.

.google.protobuf.Timestamp purge_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataAgent.Builder

clearType()

public DataAgent.Builder clearType()
Returns
Type Description
DataAgent.Builder

clearUpdateTime()

public DataAgent.Builder clearUpdateTime()

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

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataAgent.Builder

containsLabels(String key)

public boolean containsLabels(String key)

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.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getBigqueryAgentAnalyticsEnabled()

public boolean 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 rejects either field with INVALID_ARGUMENT.

This setting is independent of the project-level BigQuery Agent Analytics setting configured through SetAgentOpsObservability. An agent does not inherit that setting.

optional bool bigquery_agent_analytics_enabled = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The bigqueryAgentAnalyticsEnabled.

getBigqueryAgentAnalyticsTable()

public BigQueryTableReference 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 it is included in the update_mask of an UpdateDataAgent call. 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.

    These are validated against the agent as sent in the request. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource 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.

.google.cloud.geminidataanalytics.v1.BigQueryTableReference bigquery_agent_analytics_table = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigQueryTableReference

The bigqueryAgentAnalyticsTable.

getBigqueryAgentAnalyticsTableBuilder()

public BigQueryTableReference.Builder getBigqueryAgentAnalyticsTableBuilder()

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 it is included in the update_mask of an UpdateDataAgent call. 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.

    These are validated against the agent as sent in the request. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource 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.

.google.cloud.geminidataanalytics.v1.BigQueryTableReference bigquery_agent_analytics_table = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigQueryTableReference.Builder

getBigqueryAgentAnalyticsTableOrBuilder()

public BigQueryTableReferenceOrBuilder getBigqueryAgentAnalyticsTableOrBuilder()

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 it is included in the update_mask of an UpdateDataAgent call. 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.

    These are validated against the agent as sent in the request. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource 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.

.google.cloud.geminidataanalytics.v1.BigQueryTableReference bigquery_agent_analytics_table = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
BigQueryTableReferenceOrBuilder

getCreateTime()

public Timestamp getCreateTime()

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

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDataAnalyticsAgent()

public DataAnalyticsAgent getDataAnalyticsAgent()

Data analytics agent.

.google.cloud.geminidataanalytics.v1.DataAnalyticsAgent data_analytics_agent = 101;

Returns
Type Description
DataAnalyticsAgent

The dataAnalyticsAgent.

getDataAnalyticsAgentBuilder()

public DataAnalyticsAgent.Builder getDataAnalyticsAgentBuilder()

Data analytics agent.

.google.cloud.geminidataanalytics.v1.DataAnalyticsAgent data_analytics_agent = 101;

Returns
Type Description
DataAnalyticsAgent.Builder

getDataAnalyticsAgentOrBuilder()

public DataAnalyticsAgentOrBuilder getDataAnalyticsAgentOrBuilder()

Data analytics agent.

.google.cloud.geminidataanalytics.v1.DataAnalyticsAgent data_analytics_agent = 101;

Returns
Type Description
DataAnalyticsAgentOrBuilder

getDefaultInstanceForType()

public DataAgent getDefaultInstanceForType()
Returns
Type Description
DataAgent

getDeleteTime()

public Timestamp getDeleteTime()

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

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeBuilder()

public Timestamp.Builder getDeleteTimeBuilder()

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

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

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

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescription()

public String getDescription()

Optional. Description of the agent.

  • Must be between 1-1024 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the agent.

  • Must be between 1-1024 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Optional. User friendly display name.

  • Must be between 1-256 characters.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. User friendly display name.

  • Must be between 1-256 characters.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getKmsKey()

public String 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/*.

optional string kms_key = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public ByteString getKmsKeyBytes()

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/*.

optional string kms_key = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for kmsKey.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String 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 name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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 name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getPurgeTime()

public Timestamp 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.

.google.protobuf.Timestamp purge_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The purgeTime.

getPurgeTimeBuilder()

public Timestamp.Builder getPurgeTimeBuilder()

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.

.google.protobuf.Timestamp purge_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getPurgeTimeOrBuilder()

public TimestampOrBuilder getPurgeTimeOrBuilder()

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.

.google.protobuf.Timestamp purge_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getTypeCase()

public DataAgent.TypeCase getTypeCase()
Returns
Type Description
DataAgent.TypeCase

getUpdateTime()

public Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasBigqueryAgentAnalyticsEnabled()

public boolean hasBigqueryAgentAnalyticsEnabled()

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 rejects either field with INVALID_ARGUMENT.

This setting is independent of the project-level BigQuery Agent Analytics setting configured through SetAgentOpsObservability. An agent does not inherit that setting.

optional bool bigquery_agent_analytics_enabled = 18 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the bigqueryAgentAnalyticsEnabled field is set.

hasBigqueryAgentAnalyticsTable()

public boolean hasBigqueryAgentAnalyticsTable()

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 it is included in the update_mask of an UpdateDataAgent call. 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.

    These are validated against the agent as sent in the request. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource 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.

.google.cloud.geminidataanalytics.v1.BigQueryTableReference bigquery_agent_analytics_table = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the bigqueryAgentAnalyticsTable field is set.

hasCreateTime()

public boolean hasCreateTime()

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

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDataAnalyticsAgent()

public boolean hasDataAnalyticsAgent()

Data analytics agent.

.google.cloud.geminidataanalytics.v1.DataAnalyticsAgent data_analytics_agent = 101;

Returns
Type Description
boolean

Whether the dataAnalyticsAgent field is set.

hasDeleteTime()

public boolean hasDeleteTime()

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

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasKmsKey()

public boolean hasKmsKey()

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/*.

optional string kms_key = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the kmsKey field is set.

hasPurgeTime()

public boolean hasPurgeTime()

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.

.google.protobuf.Timestamp purge_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the purgeTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBigqueryAgentAnalyticsTable(BigQueryTableReference value)

public DataAgent.Builder mergeBigqueryAgentAnalyticsTable(BigQueryTableReference value)

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 it is included in the update_mask of an UpdateDataAgent call. 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.

    These are validated against the agent as sent in the request. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource 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.

.google.cloud.geminidataanalytics.v1.BigQueryTableReference bigquery_agent_analytics_table = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value BigQueryTableReference
Returns
Type Description
DataAgent.Builder

mergeCreateTime(Timestamp value)

public DataAgent.Builder mergeCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAgent.Builder

mergeDataAnalyticsAgent(DataAnalyticsAgent value)

public DataAgent.Builder mergeDataAnalyticsAgent(DataAnalyticsAgent value)

Data analytics agent.

.google.cloud.geminidataanalytics.v1.DataAnalyticsAgent data_analytics_agent = 101;

Parameter
Name Description
value DataAnalyticsAgent
Returns
Type Description
DataAgent.Builder

mergeDeleteTime(Timestamp value)

public DataAgent.Builder mergeDeleteTime(Timestamp value)

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

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAgent.Builder

mergeFrom(DataAgent other)

public DataAgent.Builder mergeFrom(DataAgent other)
Parameter
Name Description
other DataAgent
Returns
Type Description
DataAgent.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataAgent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataAgent.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DataAgent.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DataAgent.Builder
Overrides

mergePurgeTime(Timestamp value)

public DataAgent.Builder mergePurgeTime(Timestamp value)

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.

.google.protobuf.Timestamp purge_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAgent.Builder

mergeUpdateTime(Timestamp value)

public DataAgent.Builder mergeUpdateTime(Timestamp value)

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

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAgent.Builder

putAllLabels(Map<String,String> values)

public DataAgent.Builder putAllLabels(Map<String,String> values)

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.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
DataAgent.Builder

putLabels(String key, String value)

public DataAgent.Builder putLabels(String key, String value)

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.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
DataAgent.Builder

removeLabels(String key)

public DataAgent.Builder removeLabels(String key)

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.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
DataAgent.Builder

setBigqueryAgentAnalyticsEnabled(boolean value)

public DataAgent.Builder setBigqueryAgentAnalyticsEnabled(boolean value)

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 rejects either field with INVALID_ARGUMENT.

This setting is independent of the project-level BigQuery Agent Analytics setting configured through SetAgentOpsObservability. An agent does not inherit that setting.

optional bool bigquery_agent_analytics_enabled = 18 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The bigqueryAgentAnalyticsEnabled to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setBigqueryAgentAnalyticsTable(BigQueryTableReference value)

public DataAgent.Builder setBigqueryAgentAnalyticsTable(BigQueryTableReference value)

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 it is included in the update_mask of an UpdateDataAgent call. 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.

    These are validated against the agent as sent in the request. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource 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.

.google.cloud.geminidataanalytics.v1.BigQueryTableReference bigquery_agent_analytics_table = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value BigQueryTableReference
Returns
Type Description
DataAgent.Builder

setBigqueryAgentAnalyticsTable(BigQueryTableReference.Builder builderForValue)

public DataAgent.Builder setBigqueryAgentAnalyticsTable(BigQueryTableReference.Builder builderForValue)

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 it is included in the update_mask of an UpdateDataAgent call. 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.

    These are validated against the agent as sent in the request. An agent that carries no datasource is not validated, and an agent switched to a non-BigQuery datasource 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.

.google.cloud.geminidataanalytics.v1.BigQueryTableReference bigquery_agent_analytics_table = 19 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue BigQueryTableReference.Builder
Returns
Type Description
DataAgent.Builder

setCreateTime(Timestamp value)

public DataAgent.Builder setCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAgent.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DataAgent.Builder setCreateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataAgent.Builder

setDataAnalyticsAgent(DataAnalyticsAgent value)

public DataAgent.Builder setDataAnalyticsAgent(DataAnalyticsAgent value)

Data analytics agent.

.google.cloud.geminidataanalytics.v1.DataAnalyticsAgent data_analytics_agent = 101;

Parameter
Name Description
value DataAnalyticsAgent
Returns
Type Description
DataAgent.Builder

setDataAnalyticsAgent(DataAnalyticsAgent.Builder builderForValue)

public DataAgent.Builder setDataAnalyticsAgent(DataAnalyticsAgent.Builder builderForValue)

Data analytics agent.

.google.cloud.geminidataanalytics.v1.DataAnalyticsAgent data_analytics_agent = 101;

Parameter
Name Description
builderForValue DataAnalyticsAgent.Builder
Returns
Type Description
DataAgent.Builder

setDeleteTime(Timestamp value)

public DataAgent.Builder setDeleteTime(Timestamp value)

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

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAgent.Builder

setDeleteTime(Timestamp.Builder builderForValue)

public DataAgent.Builder setDeleteTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp delete_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataAgent.Builder

setDescription(String value)

public DataAgent.Builder setDescription(String value)

Optional. Description of the agent.

  • Must be between 1-1024 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The description to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DataAgent.Builder setDescriptionBytes(ByteString value)

Optional. Description of the agent.

  • Must be between 1-1024 characters.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setDisplayName(String value)

public DataAgent.Builder setDisplayName(String value)

Optional. User friendly display name.

  • Must be between 1-256 characters.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DataAgent.Builder setDisplayNameBytes(ByteString value)

Optional. User friendly display name.

  • Must be between 1-256 characters.

string display_name = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setKmsKey(String value)

public DataAgent.Builder setKmsKey(String value)

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/*.

optional string kms_key = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The kmsKey to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setKmsKeyBytes(ByteString value)

public DataAgent.Builder setKmsKeyBytes(ByteString value)

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/*.

optional string kms_key = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for kmsKey to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setName(String value)

public DataAgent.Builder setName(String value)

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 name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DataAgent.Builder setNameBytes(ByteString value)

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 name = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
DataAgent.Builder

This builder for chaining.

setPurgeTime(Timestamp value)

public DataAgent.Builder setPurgeTime(Timestamp value)

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.

.google.protobuf.Timestamp purge_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAgent.Builder

setPurgeTime(Timestamp.Builder builderForValue)

public DataAgent.Builder setPurgeTime(Timestamp.Builder builderForValue)

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.

.google.protobuf.Timestamp purge_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataAgent.Builder

setUpdateTime(Timestamp value)

public DataAgent.Builder setUpdateTime(Timestamp value)

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

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DataAgent.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DataAgent.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DataAgent.Builder