Class SetAgentOpsObservabilityRequest.Builder (0.27.0)

public static final class SetAgentOpsObservabilityRequest.Builder extends GeneratedMessage.Builder<SetAgentOpsObservabilityRequest.Builder> implements SetAgentOpsObservabilityRequestOrBuilder

Request for SetAgentOpsObservability.

Protobuf type google.cloud.geminidataanalytics.v1.SetAgentOpsObservabilityRequest

Static Methods

getDescriptor()

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

Methods

build()

public SetAgentOpsObservabilityRequest build()
Returns
Type Description
SetAgentOpsObservabilityRequest

buildPartial()

public SetAgentOpsObservabilityRequest buildPartial()
Returns
Type Description
SetAgentOpsObservabilityRequest

clear()

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

clearBqaaEnabled()

public SetAgentOpsObservabilityRequest.Builder clearBqaaEnabled()

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
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

clearDataSourceType()

public SetAgentOpsObservabilityRequest.Builder clearDataSourceType()

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
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

clearParent()

public SetAgentOpsObservabilityRequest.Builder clearParent()

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
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

clearTelemetryEnabled()

public SetAgentOpsObservabilityRequest.Builder clearTelemetryEnabled()

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
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

clearUpdateMask()

public SetAgentOpsObservabilityRequest.Builder clearUpdateMask()

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
SetAgentOpsObservabilityRequest.Builder

getBqaaEnabled()

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

getDefaultInstanceForType()

public SetAgentOpsObservabilityRequest getDefaultInstanceForType()
Returns
Type Description
SetAgentOpsObservabilityRequest

getDescriptorForType()

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

getParent()

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

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
Builder

getUpdateMaskOrBuilder()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SetAgentOpsObservabilityRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUpdateMask(FieldMask value)

public SetAgentOpsObservabilityRequest.Builder mergeUpdateMask(FieldMask value)

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];

Parameter
Name Description
value FieldMask
Returns
Type Description
SetAgentOpsObservabilityRequest.Builder

setBqaaEnabled(boolean value)

public SetAgentOpsObservabilityRequest.Builder setBqaaEnabled(boolean value)

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];

Parameter
Name Description
value boolean

The bqaaEnabled to set.

Returns
Type Description
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

setDataSourceType(String value)

public SetAgentOpsObservabilityRequest.Builder setDataSourceType(String value)

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

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

Parameter
Name Description
value String

The dataSourceType to set.

Returns
Type Description
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

setDataSourceTypeBytes(ByteString value)

public SetAgentOpsObservabilityRequest.Builder setDataSourceTypeBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for dataSourceType to set.

Returns
Type Description
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

setParent(String value)

public SetAgentOpsObservabilityRequest.Builder setParent(String value)

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

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SetAgentOpsObservabilityRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

setTelemetryEnabled(boolean value)

public SetAgentOpsObservabilityRequest.Builder setTelemetryEnabled(boolean value)

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];

Parameter
Name Description
value boolean

The telemetryEnabled to set.

Returns
Type Description
SetAgentOpsObservabilityRequest.Builder

This builder for chaining.

setUpdateMask(FieldMask value)

public SetAgentOpsObservabilityRequest.Builder setUpdateMask(FieldMask value)

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];

Parameter
Name Description
value FieldMask
Returns
Type Description
SetAgentOpsObservabilityRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public SetAgentOpsObservabilityRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SetAgentOpsObservabilityRequest.Builder