Package google.cloud.observability.v1

Index

Observability

Service describing handlers for resources

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

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.

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

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 will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
scope

Scope

Required. The resource being updated.