public sealed class DataAgent : IMessage<DataAgent>, IEquatable<DataAgent>, IDeepCloneable<DataAgent>, IBufferMessage, IMessageReference documentation and code samples for the Data Analytics API with Gemini v1beta API class DataAgent.
Message describing a DataAgent object.
Implements
IMessageDataAgent, IEquatableDataAgent, IDeepCloneableDataAgent, IBufferMessage, IMessageNamespace
Google.Cloud.GeminiDataAnalytics.V1BetaAssembly
Google.Cloud.GeminiDataAnalytics.V1Beta.dll
Constructors
DataAgent()
public DataAgent()DataAgent(DataAgent)
public DataAgent(DataAgent other)| Parameter | |
|---|---|
| Name | Description |
other |
DataAgent |
Properties
BigqueryAgentAnalyticsEnabled
public bool BigqueryAgentAnalyticsEnabled { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
BigqueryAgentAnalyticsTable
public BigQueryTableReference BigqueryAgentAnalyticsTable { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
BigQueryTableReference |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. The time when the data agent was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DataAgentName
public DataAgentName DataAgentName { get; set; }DataAgentName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
DataAgentName |
|
DataAnalyticsAgent
public DataAnalyticsAgent DataAnalyticsAgent { get; set; }Data analytics agent.
| Property Value | |
|---|---|
| Type | Description |
DataAnalyticsAgent |
|
DeleteTime
public Timestamp DeleteTime { get; set; }Output only. [Output only] The time the data agent was soft deleted.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
Description
public string Description { get; set; }Optional. Description of the agent.
- Must be between 1-1024 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
DisplayName
public string DisplayName { get; set; }Optional. User friendly display name.
- Must be between 1-256 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
HasBigqueryAgentAnalyticsEnabled
public bool HasBigqueryAgentAnalyticsEnabled { get; }Gets whether the "bigquery_agent_analytics_enabled" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasKmsKey
public bool HasKmsKey { get; }Gets whether the "kms_key" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
KmsKey
public string KmsKey { get; set; }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/*.
| Property Value | |
|---|---|
| Type | Description |
string |
|
KmsKeyAsCryptoKeyName
public CryptoKeyName KmsKeyAsCryptoKeyName { get; set; }CryptoKeyName-typed view over the KmsKey resource name property.
| Property Value | |
|---|---|
| Type | Description |
CryptoKeyName |
|
Labels
public MapField<string, string> Labels { get; }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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring |
|
Name
public string Name { get; set; }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}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
PurgeTime
public Timestamp PurgeTime { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
TypeCase
public DataAgent.TypeOneofCase TypeCase { get; }| Property Value | |
|---|---|
| Type | Description |
DataAgentTypeOneofCase |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. The time when the data agent was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|