Package google.cloud.observability.v1

Index

Observability

Service describing handlers for resources

CreateTraceScope

rpc CreateTraceScope(CreateTraceScopeRequest ) returns (TraceScope )

Create a new TraceScope.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • observability.traceScopes.create

For more information, see the IAM documentation.
DeleteTraceScope

rpc DeleteTraceScope(DeleteTraceScopeRequest ) returns (Empty )

Delete a TraceScope.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • observability.traceScopes.delete

For more information, see the IAM documentation.
GetScope

rpc GetScope(GetScopeRequest ) returns (Scope )

Gets details of a single Scope.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • observability.scopes.get

For more information, see the IAM documentation.
GetTraceScope

rpc GetTraceScope(GetTraceScopeRequest ) returns (TraceScope )

Get TraceScope resource.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • observability.traceScopes.get

For more information, see the IAM documentation.
ListTraceScopes

rpc ListTraceScopes(ListTraceScopesRequest ) returns (ListTraceScopesResponse )

List TraceScopes of a project in a particular location.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • observability.traceScopes.list

For more information, see the IAM documentation.
UpdateScope

rpc UpdateScope(UpdateScopeRequest ) returns (Scope )

Updates the parameters of a single Scope.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • observability.scopes.update

For more information, see the IAM documentation.
UpdateTraceScope

rpc UpdateTraceScope(UpdateTraceScopeRequest ) returns (TraceScope )

Update a TraceScope.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • observability.traceScopes.update

For more information, see the IAM documentation.

CreateTraceScopeRequest

Request for creating a TraceScope.

Fields
parent

string

Required. The full resource name of the location where the trace scope should be created

projects/[PROJECT_ID]/locations/[LOCATION_ID]

For example:

projects/my-project/locations/global
trace_scope_id

string

Required. A client-assigned identifier for the trace scope.
trace_scope

TraceScope

Required. The new trace scope.

DeleteTraceScopeRequest

Request for deleting a TraceScope.

Fields
name

string

Required. The full resource name of the trace scope to delete:

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

For example:

projects/my-project/locations/global/traceScopes/my-trace-scope

GetScopeRequest

Message for getting a Scope.

Fields
name

string

Required. Name of the resource. The format is:

projects/{project}/locations/{location}/scopes/{scope}

The {location} field must be set to global. The {scope} field must be set to _Default.

GetTraceScopeRequest

Request for getting a TraceScope.

Fields
name

string

Required. The resource name of the trace scope:

projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_ID]

For example:

projects/my-project/locations/global/traceScopes/my-trace-scope

ListTraceScopesRequest

Request for listing TraceScopes.

Fields
parent

string

Required. The full resource name of the location to look for trace scopes:

projects/[PROJECT_ID]/locations/[LOCATION_ID]

For example:

projects/my-project/locations/global
page_size

int32

Optional. The maximum number of results to return from this request.

Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.
page_token

string

Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.

ListTraceScopesResponse

Response for listing TraceScopes.

Fields
trace_scopes[]

TraceScope

Optional. A list of trace scopes.
next_page_token

string

Optional. If there might be more results than appear in this response, then next_page_token is included. To get the next set of results, call the same method again using the value of next_page_token as page_token.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

Output only. The time the operation was created.
end_time

Timestamp

Output only. The time the operation finished running.
target

string

Output only. Server-defined resource path for the target of the operation.
verb

string

Output only. Name of the verb executed by the operation.
status_message

string

Output only. Human-readable status of the operation, if any.
requested_cancellation

bool

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
api_version

string

Output only. API version used to start the operation.

Scope

Message describing Scope object

Fields
name

string

Identifier. Name of the resource. The format is:

projects/{project}/locations/{location}/scopes/{scope}

The {location} field must be set to global. The {scope} field must be set to _Default.
update_time

Timestamp

Output only. Update timestamp. Note: The Update timestamp for the default scope is initially unset.
log_scope

string

Required. The full resource name of the LogScope. For example:

//logging.googleapis.com/projects/myproject/locations/global/logScopes/my-log-scope
trace_scope

string

Required. The resource name of the TraceScope. For example:

projects/myproject/locations/global/traceScopes/my-trace-scope

TraceScope

A trace scope is a collection of resources whose traces are queried together.

Fields
name

string

Identifier. The resource name of the trace scope.

For example:

projects/my-project/locations/global/traceScopes/my-trace-scope
resource_names[]

string

Required. Names of the projects that are included in this trace scope.

  • projects/[PROJECT_ID]

A trace scope can include a maximum of 20 projects.
description

string

Optional. Describes this trace scope.

The maximum length of the description is 8000 characters.
create_time

Timestamp

Output only. The creation timestamp of the trace scope.
update_time

Timestamp

Output only. The last update timestamp of the trace scope.

UpdateScopeRequest

Message for updating a Scope.

Fields
update_mask

FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Scope resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten when it is in the mask. If the user does not provide a mask, then all fields present in the request are overwritten.
scope

Scope

Required. The resource being updated.

UpdateTraceScopeRequest

Request for updating a TraceScope.

Fields
trace_scope

TraceScope

Required. The updated trace scope.
update_mask

FieldMask

Optional. The list of fields to update.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年08月27日 UTC.