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

rpc GetBucket(GetBucketRequest) returns (Bucket)

Get bucket 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.buckets.get

For more information, see the IAM documentation.
GetDataset

rpc GetDataset(GetDatasetRequest) returns (Dataset)

Get a dataset.

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

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

rpc GetSettings(GetSettingsRequest) returns (Settings)

Get Settings

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

rpc GetView(GetViewRequest) returns (View)

Get a view.

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

For more information, see the IAM documentation.
ListBuckets

rpc ListBuckets(ListBucketsRequest) returns (ListBucketsResponse)

List buckets 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.buckets.list

For more information, see the IAM documentation.
ListDatasets

rpc ListDatasets(ListDatasetsRequest) returns (ListDatasetsResponse)

List datasets of a bucket.

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

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

rpc ListViews(ListViewsRequest) returns (ListViewsResponse)

List views of a dataset.

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

rpc UpdateSettings(UpdateSettingsRequest) returns (Operation)

Update Settings

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

Bucket

Bucket configuration for storing observability data.

Fields
name

string

Identifier. Name of the bucket. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
display_name

string

Optional. User friendly display name.
description

string

Optional. Description of the bucket.
create_time

Timestamp

Output only. Create timestamp.
update_time

Timestamp

Output only. Update timestamp.
delete_time

Timestamp

Output only. Delete timestamp.
purge_time

Timestamp

Output only. Timestamp when the bucket in soft-deleted state is purged.
cmek_settings

CmekSettings

Optional. Settings for configuring CMEK on a bucket.

CmekSettings

Settings for configuring CMEK for a bucket.

Fields
kms_key

string

Optional. The resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key
kms_key_version

string

Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]

For example:

projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1

This read-only field is used to convey the specific configured CryptoKeyVersion of the kms_key that has been configured. It is populated when the CMEK settings are bound to a single key version.
service_account_id

string

Output only. The service account used to access the key.

CreateLinkRequest

Request for creating a link.

Fields
parent

string

Required. Name of the containing dataset for this link. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

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.

Dataset

A dataset is a collection of data that has a specific configuration. A dataset can be backed by multiple tables. One bucket can have multiple datasets.

Fields
name

string

Identifier. Name of the dataset. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
display_name

string

Optional. User friendly display name.
description

string

Optional. Description of the dataset.
create_time

Timestamp

Output only. Create timestamp.
delete_time

Timestamp

Output only. Delete timestamp.
purge_time

Timestamp

Output only. Timestamp when the dataset in soft-deleted state is purged.

DeleteLinkRequest

Request for deleting a link.

Fields
name

string

Required. Name of the link to delete. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

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

GetBucketRequest

Request for getting a bucket.

Fields
name

string

Required. Name of the bucket to retrieve. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

GetDatasetRequest

Request for getting a dataset.

Fields
name

string

Required. Name of the dataset to retrieve. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

GetLinkRequest

Request for getting a link.

Fields
name

string

Required. Name of the link to retrieve. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

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.

GetSettingsRequest

Request for getting Settings.

Fields
name

string

Required. Name of the settings to retrieve.

Name format:

"projects/[PROJECT_ID]/locations/[LOCATION]/settings"
"folders/[FOLDER_ID]/locations/[LOCATION]/settings"
"organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings"

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

GetViewRequest

Request for getting a view.

Fields
name

string

Required. Name of the view to retrieve. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]

ListBucketsRequest

Request for listing buckets.

Fields
parent

string

Required. The parent, which owns this collection of buckets. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]
page_size

int32

Optional. The maximum number of buckets to return. If unspecified, then at most 100 buckets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
page_token

string

Optional. A page token, received from a previous ListBuckets call. Provide this to retrieve the subsequent page.
show_deleted

bool

Optional. If true, then the response will include deleted buckets.

ListBucketsResponse

Response for listing buckets.

Fields
buckets[]

Bucket

Optional. The list of buckets.
next_page_token

string

Optional. A token that can be sent as page_token to retrieve the next page. When this field is omitted, there are no subsequent pages.

ListDatasetsRequest

Request for listing datasets.

Fields
parent

string

Required. The parent bucket that owns this collection of datasets. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
page_size

int32

Optional. The maximum number of datasets to return. If unspecified, then at most 100 datasets are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
page_token

string

Optional. A page token, received from a previous ListDatasets call. Provide this to retrieve the subsequent page.
show_deleted

bool

Optional. If true, then the response will include deleted datasets.

ListDatasetsResponse

Response for listing datasets.

Fields
datasets[]

Dataset

The list of datasets.
next_page_token

string

A token that can be sent as page_token to retrieve the next page. When this field is omitted, there are no subsequent pages.

ListLinksRequest

Request for listing links.

Fields
parent

string

Required. The parent dataset that owns this collection of links. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
page_size

int32

Optional. The maximum number of links to return. If unspecified, then at most 100 links are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
page_token

string

Optional. A page token, received from a previous ListLinks call. Provide this to retrieve the subsequent page.

ListLinksResponse

Response for listing links.

Fields
next_page_token

string

Optional. A token that can be sent as page_token to retrieve the next page. When this field is omitted, there are no subsequent pages.

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.

ListViewsRequest

Request for listing views.

Fields
parent

string

Required. Dataset whose views are to be listed. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
page_size

int32

Optional. The maximum number of views to return. If unspecified, then at most 100 views are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
page_token

string

Optional. A page token, received from a previous ListViews call. Provide this to retrieve the subsequent page.

ListViewsResponse

Response for listing views.

Fields
views[]

View

The list of views.
next_page_token

string

Optional. A token that can be sent as page_token to retrieve the next page. When this field is omitted, there are no subsequent pages.

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

Settings

Describes the settings associated with a project, organization, or folder.

Fields
name

string

Identifier. The resource name of the settings.
default_storage_location

string

Optional. The location which should be used when any regional resources are provisioned by Google Cloud.
service_account_id

string

Output only. The service account for the given resource container, such as project or folder. This will be used by Cloud Observability to perform actions in the container's project like access KMS keys or create Links. Always the same service account per resource container regardless of region.
kms_key_name

string

Optional. The resource name for the configured Cloud KMS key.

KMS key name format:

"projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]"

For example:

"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"

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.

UpdateLinkRequest

Request for updating a link.

Fields
update_mask

FieldMask

Optional. The list of fields to update.

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.

UpdateSettingsRequest

Request for updating Settings.

Fields
settings

Settings

Required. The settings to update.

The name field of settings is used to identify the resource to be updated.
update_mask

FieldMask

Optional. The field mask specifying which fields of the settings are to be 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.

View

A view corresponds to a read-only representation of a subset of the data in a dataset.

Fields
name

string

Identifier. Name of the view. The format is:

projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]
display_name

string

Optional. User friendly display name.
description

string

Optional. Description of the view.
create_time

Timestamp

Output only. Create timestamp.
update_time

Timestamp

Output only. Update timestamp.