Interface SetAgentOpsObservabilityRequestOrBuilder (0.27.0) 

public interface SetAgentOpsObservabilityRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBqaaEnabled()

public abstract boolean getBqaaEnabled()

Optional. Whether BigQuery Agent Analytics is enabled. Note: An explicit update_mask containing "bqaa_enabled" is required to modify this field. If update_mask is omitted, this field is ignored and an existing enabled setting cannot be disabled.

This is a project-level setting and does not by itself enable trace logging for any individual agent. Per-agent trace logging is controlled by DataAgent.bigquery_agent_analytics_enabled together with DataAgent.bigquery_agent_analytics_table; an agent does not inherit this setting.

bool bqaa_enabled = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The bqaaEnabled.

getDataSourceType()

public abstract String getDataSourceType()

Required. The data source type for which to set observability settings. Examples: "bigquery", "looker"

string data_source_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The dataSourceType.

getDataSourceTypeBytes()

public abstract ByteString getDataSourceTypeBytes()

Required. The data source type for which to set observability settings. Examples: "bigquery", "looker"

string data_source_type = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for dataSourceType.

getParent()

public abstract String getParent()

Required. Parent value for SetAgentOpsObservabilityRequest. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. Parent value for SetAgentOpsObservabilityRequest. Format: projects/{project}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getTelemetryEnabled()

public abstract boolean getTelemetryEnabled()

Optional. Whether to enable or disable AgentOps observability. When update_mask is provided, this field is ignored unless specified in the mask.

bool telemetry_enabled = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The telemetryEnabled.

getUpdateMask()

public abstract FieldMask getUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten by the update. The fields specified in the update_mask are relative to the resource. A field will be overwritten if it is in the mask.

If the user does not provide a mask, only telemetry_enabled will be updated (for backward compatibility with legacy callers). Note that disabling BigQuery Agent Analytics (bqaa_enabled = false) requires providing an explicit update_mask containing "bqaa_enabled".

Per AIP-161:

  • The special wildcard value '*' is supported to update all fields.
  • Field paths should use snake_case, though camelCase equivalents (telemetryEnabled, bqaaEnabled) are accepted for REST/JSON transcoding compatibility.

.google.protobuf.FieldMask update_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Field mask is used to specify the fields to be overwritten by the update. The fields specified in the update_mask are relative to the resource. A field will be overwritten if it is in the mask.

If the user does not provide a mask, only telemetry_enabled will be updated (for backward compatibility with legacy callers). Note that disabling BigQuery Agent Analytics (bqaa_enabled = false) requires providing an explicit update_mask containing "bqaa_enabled".

Per AIP-161:

  • The special wildcard value '*' is supported to update all fields.
  • Field paths should use snake_case, though camelCase equivalents (telemetryEnabled, bqaaEnabled) are accepted for REST/JSON transcoding compatibility.

.google.protobuf.FieldMask update_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasUpdateMask()

public abstract boolean hasUpdateMask()

Optional. Field mask is used to specify the fields to be overwritten by the update. The fields specified in the update_mask are relative to the resource. A field will be overwritten if it is in the mask.

If the user does not provide a mask, only telemetry_enabled will be updated (for backward compatibility with legacy callers). Note that disabling BigQuery Agent Analytics (bqaa_enabled = false) requires providing an explicit update_mask containing "bqaa_enabled".

Per AIP-161:

  • The special wildcard value '*' is supported to update all fields.
  • Field paths should use snake_case, though camelCase equivalents (telemetryEnabled, bqaaEnabled) are accepted for REST/JSON transcoding compatibility.

.google.protobuf.FieldMask update_mask = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the updateMask field is set.