Class ObservabilityAsyncClient (0.1.0) 

ObservabilityAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.observability_v1.services.observability.transports.base.ObservabilityTransport,
            typing.Callable[
                [...],
                google.cloud.observability_v1.services.observability.transports.base.ObservabilityTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Service describing handlers for resources

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
ObservabilityTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

ObservabilityAsyncClient

ObservabilityAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.observability_v1.services.observability.transports.base.ObservabilityTransport,
            typing.Callable[
                [...],
                google.cloud.observability_v1.services.observability.transports.base.ObservabilityTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the observability async client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,ObservabilityTransport,Callable[..., ObservabilityTransport]]]

The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the ObservabilityTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

bucket_path

bucket_path(project: str, location: str, bucket: str) -> str

Returns a fully-qualified bucket string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.CancelOperationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_bucket

create_bucket(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.CreateBucketRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    bucket: typing.Optional[
        google.cloud.observability_v1.types.observability.Bucket
    ] = None,
    bucket_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Create a new bucket.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_create_bucket():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.CreateBucketRequest(
        parent="parent_value",
        bucket_id="bucket_id_value",
    )

    # Make the request
    operation = await client.create_bucket(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.CreateBucketRequest, dict]]

The request object. Request for creating a bucket.
parent str

Required. Name of the project and location for the bucket. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION] This corresponds to the parent field on the request instance; if request is provided, this should not be set.
bucket Bucket

Required. Bucket to create. This corresponds to the bucket field on the request instance; if request is provided, this should not be set.
bucket_id str

Required. Id of the bucket to create. This corresponds to the bucket_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be Bucket Bucket configuration for storing observability data. 
create_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.CreateLinkRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    link: typing.Optional[
        google.cloud.observability_v1.types.observability.Link
    ] = None,
    link_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Create a new link.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_create_link():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.CreateLinkRequest(
        parent="parent_value",
        link_id="link_id_value",
    )

    # Make the request
    operation = await client.create_link(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.CreateLinkRequest, dict]]

The request object. Request for creating a link.
parent str

Required. Name of the containing dataset for this link. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID] This corresponds to the parent field on the request instance; if request is provided, this should not be set.
link Link

Required. Link to create. This corresponds to the link field on the request instance; if request is provided, this should not be set.
link_id str

Required. Id of the link to create. This corresponds to the link_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be Link A link lets a dataset be accessible to BigQuery via usage of linked datasets.

create_trace_scope

create_trace_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.CreateTraceScopeRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    trace_scope: typing.Optional[
        google.cloud.observability_v1.types.observability.TraceScope
    ] = None,
    trace_scope_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.TraceScope

Create a new TraceScope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_create_trace_scope():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    trace_scope = observability_v1.TraceScope()
    trace_scope.resource_names = ['resource_names_value1', 'resource_names_value2']

    request = observability_v1.CreateTraceScopeRequest(
        parent="parent_value",
        trace_scope_id="trace_scope_id_value",
        trace_scope=trace_scope,
    )

    # Make the request
    response = await client.create_trace_scope(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.CreateTraceScopeRequest, dict]]

The request object. Request for creating a TraceScope.
parent str

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 This corresponds to the parent field on the request instance; if request is provided, this should not be set.
trace_scope TraceScope

Required. The new trace scope. This corresponds to the trace_scope field on the request instance; if request is provided, this should not be set.
trace_scope_id str

Required. A client-assigned identifier for the trace scope. This corresponds to the trace_scope_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.TraceScope A trace scope is a collection of resources whose traces are queried together.

dataset_path

dataset_path(project: str, location: str, bucket: str, dataset: str) -> str

Returns a fully-qualified dataset string.

delete_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.DeleteLinkRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Delete a link.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_delete_link():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.DeleteLinkRequest(
        name="name_value",
    )

    # Make the request
    operation = await client.delete_link(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.DeleteLinkRequest, dict]]

The request object. Request for deleting a link.
name str

Required. Name of the link to delete. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID] This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_operation

delete_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.DeleteOperationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

delete_trace_scope

delete_trace_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.DeleteTraceScopeRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Delete a TraceScope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_delete_trace_scope():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.DeleteTraceScopeRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_trace_scope(request=request)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.DeleteTraceScopeRequest, dict]]

The request object. Request for deleting a TraceScope.
name str

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 This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
ObservabilityAsyncClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
ObservabilityAsyncClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
ObservabilityAsyncClient The constructed client.

get_bucket

get_bucket(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.GetBucketRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.Bucket

Get bucket resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_get_bucket():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.GetBucketRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_bucket(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.GetBucketRequest, dict]]

The request object. Request for getting a bucket.
name str

Required. Name of the bucket to retrieve. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID] This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.Bucket Bucket configuration for storing observability data.

get_dataset

get_dataset(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.GetDatasetRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.Dataset

Get a dataset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_get_dataset():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.GetDatasetRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_dataset(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.GetDatasetRequest, dict]]

The request object. Request for getting a dataset.
name str

Required. Name of the dataset to retrieve. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID] This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.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. 
get_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.GetLinkRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.Link

Get a link.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_get_link():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.GetLinkRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_link(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.GetLinkRequest, dict]]

The request object. Request for getting a link.
name str

Required. Name of the link to retrieve. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID] This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.Link A link lets a dataset be accessible to BigQuery via usage of linked datasets.

get_location

get_location(
    request: typing.Optional[
        typing.Union[google.cloud.location.locations_pb2.GetLocationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.GetOperationRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.Operation An Operation object.

get_scope

get_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.GetScopeRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.Scope

Gets details of a single Scope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_get_scope():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.GetScopeRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_scope(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.GetScopeRequest, dict]]

The request object. Message for getting a Scope.
name str

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. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.Scope Message describing Scope object

get_settings

get_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.GetSettingsRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.Settings

Get Settings

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_get_settings():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.GetSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_settings(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.GetSettingsRequest, dict]]

The request object. Request for getting Settings.
name str

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" This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.Settings Describes the settings associated with a project, organization, or folder.

get_trace_scope

get_trace_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.GetTraceScopeRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.TraceScope

Get TraceScope resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_get_trace_scope():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.GetTraceScopeRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_trace_scope(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.GetTraceScopeRequest, dict]]

The request object. Request for getting a TraceScope.
name str

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 This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.TraceScope A trace scope is a collection of resources whose traces are queried together.

get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.observability_v1.services.observability.transports.base.ObservabilityTransport
]

Returns an appropriate transport class.

Parameter
Name Description
label typing.Optional[str]

The name of the desired transport. If none is provided, then the first transport in the registry is used.

get_view

get_view(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.GetViewRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.View

Get a view.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_get_view():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.GetViewRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_view(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.GetViewRequest, dict]]

The request object. Request for getting a view.
name str

Required. Name of the view to retrieve. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID] This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.View A view corresponds to a read-only representation of a subset of the data in a dataset. 
link_path(project: str, location: str, bucket: str, dataset: str, link: str) -> str

Returns a fully-qualified link string.

list_buckets

list_buckets(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.ListBucketsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.services.observability.pagers.ListBucketsAsyncPager

List buckets of a project in a particular location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_list_buckets():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.ListBucketsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_buckets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.ListBucketsRequest, dict]]

The request object. Request for listing buckets.
parent str

Required. The parent, which owns this collection of buckets. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION] This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.services.observability.pagers.ListBucketsAsyncPager Response for listing buckets. Iterating over this object will yield results and resolve additional pages automatically.

list_datasets

list_datasets(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.ListDatasetsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.services.observability.pagers.ListDatasetsAsyncPager

List datasets of a bucket.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_list_datasets():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.ListDatasetsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_datasets(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.ListDatasetsRequest, dict]]

The request object. Request for listing datasets.
parent str

Required. The parent bucket that owns this collection of datasets. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID] This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.services.observability.pagers.ListDatasetsAsyncPager Response for listing datasets. Iterating over this object will yield results and resolve additional pages automatically. 
list_links(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.ListLinksRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.services.observability.pagers.ListLinksAsyncPager

List links of a dataset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_list_links():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.ListLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_links(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.ListLinksRequest, dict]]

The request object. Request for listing links.
parent str

Required. The parent dataset that owns this collection of links. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID] This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.services.observability.pagers.ListLinksAsyncPager Response for listing links. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        typing.Union[google.cloud.location.locations_pb2.ListLocationsRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        typing.Union[google.longrunning.operations_pb2.ListOperationsRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_trace_scopes

list_trace_scopes(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.ListTraceScopesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.observability_v1.services.observability.pagers.ListTraceScopesAsyncPager
)

List TraceScopes of a project in a particular location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_list_trace_scopes():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.ListTraceScopesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_trace_scopes(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.ListTraceScopesRequest, dict]]

The request object. Request for listing TraceScopes.
parent str

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 This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.services.observability.pagers.ListTraceScopesAsyncPager Response for listing TraceScopes. Iterating over this object will yield results and resolve additional pages automatically.

list_views

list_views(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.ListViewsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.services.observability.pagers.ListViewsAsyncPager

List views of a dataset.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_list_views():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.ListViewsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_views(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.ListViewsRequest, dict]]

The request object. Request for listing views.
parent str

Required. Dataset whose views are to be listed. The format is: :: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID] This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.services.observability.pagers.ListViewsAsyncPager Response for listing views. Iterating over this object will yield results and resolve additional pages automatically.

parse_bucket_path

parse_bucket_path(path: str) -> typing.Dict[str, str]

Parses a bucket path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_dataset_path

parse_dataset_path(path: str) -> typing.Dict[str, str]

Parses a dataset path into its component segments.

parse_link_path(path: str) -> typing.Dict[str, str]

Parses a link path into its component segments.

parse_scope_path

parse_scope_path(path: str) -> typing.Dict[str, str]

Parses a scope path into its component segments.

parse_settings_path

parse_settings_path(path: str) -> typing.Dict[str, str]

Parses a settings path into its component segments.

parse_trace_scope_path

parse_trace_scope_path(path: str) -> typing.Dict[str, str]

Parses a trace_scope path into its component segments.

parse_view_path

parse_view_path(path: str) -> typing.Dict[str, str]

Parses a view path into its component segments.

scope_path

scope_path(project: str, location: str, scope: str) -> str

Returns a fully-qualified scope string.

settings_path

settings_path(project: str, location: str) -> str

Returns a fully-qualified settings string.

trace_scope_path

trace_scope_path(project: str, location: str, trace_scope: str) -> str

Returns a fully-qualified trace_scope string.

update_bucket

update_bucket(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.UpdateBucketRequest, dict
        ]
    ] = None,
    *,
    bucket: typing.Optional[
        google.cloud.observability_v1.types.observability.Bucket
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Update a bucket.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_update_bucket():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.UpdateBucketRequest(
    )

    # Make the request
    operation = await client.update_bucket(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.UpdateBucketRequest, dict]]

The request object. Request for updating a bucket.
bucket Bucket

Required. The bucket to update. The name field of bucket identifies the resource to update. This corresponds to the bucket field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. The list of fields to update. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be Bucket Bucket configuration for storing observability data. 
update_link(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.UpdateLinkRequest, dict
        ]
    ] = None,
    *,
    link: typing.Optional[
        google.cloud.observability_v1.types.observability.Link
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Update a link.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_update_link():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.UpdateLinkRequest(
    )

    # Make the request
    operation = await client.update_link(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.UpdateLinkRequest, dict]]

The request object. Request for updating a link.
link Link

Required. Link to update. The name field of link identifies the resource to update. This corresponds to the link field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. The list of fields to update. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be Link A link lets a dataset be accessible to BigQuery via usage of linked datasets.

update_scope

update_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.UpdateScopeRequest, dict
        ]
    ] = None,
    *,
    scope: typing.Optional[
        google.cloud.observability_v1.types.observability.Scope
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.Scope

Updates the parameters of a single Scope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_update_scope():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    scope = observability_v1.Scope()
    scope.log_scope = "log_scope_value"
    scope.trace_scope = "trace_scope_value"

    request = observability_v1.UpdateScopeRequest(
        scope=scope,
    )

    # Make the request
    response = await client.update_scope(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.UpdateScopeRequest, dict]]

The request object. Message for updating a Scope.
scope Scope

Required. The resource being updated. This corresponds to the scope field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.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. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.Scope Message describing Scope object

update_settings

update_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.UpdateSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    settings: typing.Optional[
        google.cloud.observability_v1.types.observability.Settings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Update Settings

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_update_settings():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    request = observability_v1.UpdateSettingsRequest(
    )

    # Make the request
    operation = await client.update_settings(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.UpdateSettingsRequest, dict]]

The request object. Request for updating Settings.
settings Settings

Required. The settings to update. The name field of settings is used to identify the resource to be updated. This corresponds to the settings field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. The field mask specifying which fields of the settings are to be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be Settings Describes the settings associated with a project, organization, or folder.

update_trace_scope

update_trace_scope(
    request: typing.Optional[
        typing.Union[
            google.cloud.observability_v1.types.observability.UpdateTraceScopeRequest,
            dict,
        ]
    ] = None,
    *,
    trace_scope: typing.Optional[
        google.cloud.observability_v1.types.observability.TraceScope
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.observability_v1.types.observability.TraceScope

Update a TraceScope.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import observability_v1

async def sample_update_trace_scope():
    # Create a client
    client = observability_v1.ObservabilityAsyncClient()

    # Initialize request argument(s)
    trace_scope = observability_v1.TraceScope()
    trace_scope.resource_names = ['resource_names_value1', 'resource_names_value2']

    request = observability_v1.UpdateTraceScopeRequest(
        trace_scope=trace_scope,
    )

    # Make the request
    response = await client.update_trace_scope(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.observability_v1.types.UpdateTraceScopeRequest, dict]]

The request object. Request for updating a TraceScope.
trace_scope TraceScope

Required. The updated trace scope. This corresponds to the trace_scope field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. The list of fields to update. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

Designation of what errors, if any, should be retried.
timeout float

The timeout for this request.
metadata Sequence[Tuple[str, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.observability_v1.types.TraceScope A trace scope is a collection of resources whose traces are queried together.

view_path

view_path(project: str, location: str, bucket: str, dataset: str, view: str) -> str

Returns a fully-qualified view string.