Google Cloud Gemini Data Analytics V1 Client - Class SetAgentOpsObservabilityRequest (0.14.0)

Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1 Client class SetAgentOpsObservabilityRequest.

Request for SetAgentOpsObservability.

Generated from protobuf message google.cloud.geminidataanalytics.v1.SetAgentOpsObservabilityRequest

Namespace

Google \ Cloud \ GeminiDataAnalytics \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. Parent value for SetAgentOpsObservabilityRequest. Format: projects/{project}/locations/{location}
`↳ telemetry_enabled`	`bool` Optional. Whether to enable or disable AgentOps observability. When update_mask is provided, this field is ignored unless specified in the mask.
`↳ data_source_type`	`string` Required. The data source type for which to set observability settings. Examples: "bigquery", "looker"
`↳ bqaa_enabled`	`bool` 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.
`↳ update_mask`	`Google\Protobuf\FieldMask` 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.

getParent

Required. Parent value for SetAgentOpsObservabilityRequest.

Format: projects/{project}/locations/{location}

Returns
Type	Description
`string`

setParent

Required. Parent value for SetAgentOpsObservabilityRequest.

Format: projects/{project}/locations/{location}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTelemetryEnabled

Optional. Whether to enable or disable AgentOps observability.

When update_mask is provided, this field is ignored unless specified in the mask.

Returns
Type	Description
`bool`

setTelemetryEnabled

Optional. Whether to enable or disable AgentOps observability.

When update_mask is provided, this field is ignored unless specified in the mask.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getDataSourceType

Required. The data source type for which to set observability settings.

Examples: "bigquery", "looker"

Returns
Type	Description
`string`

setDataSourceType

Required. The data source type for which to set observability settings.

Examples: "bigquery", "looker"

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`bool`

setBqaaEnabled

Optional. Whether BigQuery Agent Analytics is enabled.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

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.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

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.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. Parent value for SetAgentOpsObservabilityRequest. Format: projects/{project}/locations/{location} Please see DataAgentServiceClient::locationName() for help formatting this field.
`telemetryEnabled`	`bool` Optional. Whether to enable or disable AgentOps observability. When update_mask is provided, this field is ignored unless specified in the mask.
`dataSourceType`	`string` Required. The data source type for which to set observability settings. Examples: "bigquery", "looker"

Returns
Type	Description
`SetAgentOpsObservabilityRequest`

Google Cloud Gemini Data Analytics V1 Client - Class SetAgentOpsObservabilityRequest (0.14.0) Stay organized with collections Save and categorize content based on your preferences.