Data Analytics API with Gemini V1 API - Class Google::Cloud::GeminiDataAnalytics::V1::DataAgent (v1.2.0)

Reference documentation and code samples for the Data Analytics API with Gemini V1 API class Google::Cloud::GeminiDataAnalytics::V1::DataAgent.

Message describing a DataAgent object.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bigquery_agent_analytics_enabled

def bigquery_agent_analytics_enabled() -> ::Boolean
Returns
  • (::Boolean) — 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.

#bigquery_agent_analytics_enabled=

def bigquery_agent_analytics_enabled=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#bigquery_agent_analytics_table

def bigquery_agent_analytics_table() -> ::Google::Cloud::GeminiDataAnalytics::V1::BigQueryTableReference
Returns
  • (::Google::Cloud::GeminiDataAnalytics::V1::BigQueryTableReference) — 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.

#bigquery_agent_analytics_table=

def bigquery_agent_analytics_table=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::BigQueryTableReference
Parameter
  • value (::Google::Cloud::GeminiDataAnalytics::V1::BigQueryTableReference) — 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.

Returns
  • (::Google::Cloud::GeminiDataAnalytics::V1::BigQueryTableReference) — 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.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#data_analytics_agent

def data_analytics_agent() -> ::Google::Cloud::GeminiDataAnalytics::V1::DataAnalyticsAgent
Returns

#data_analytics_agent=

def data_analytics_agent=(value) -> ::Google::Cloud::GeminiDataAnalytics::V1::DataAnalyticsAgent
Parameter
Returns

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) —

    Optional. Description of the agent.

    • Must be between 1-1024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) —

    Optional. Description of the agent.

    • Must be between 1-1024 characters.
Returns
  • (::String) —

    Optional. Description of the agent.

    • Must be between 1-1024 characters.

#display_name

def display_name() -> ::String
Returns
  • (::String) —

    Optional. User friendly display name.

    • Must be between 1-256 characters.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) —

    Optional. User friendly display name.

    • Must be between 1-256 characters.
Returns
  • (::String) —

    Optional. User friendly display name.

    • Must be between 1-256 characters.

#kms_key

def kms_key() -> ::String
Returns
  • (::String) — 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/*.

#kms_key=

def kms_key=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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/*.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String
Returns
  • (::String) — 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}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — 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
  • (::String) — 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}.

#purge_time

def purge_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns