Observability

import { Observability } from "https://googleapis.deno.dev/v1/observability:v1.ts";

Provides functionality for configuring the observability scope, which controls the log, metric, and trace data that you can view.

class Observability {

constructor(client?: CredentialsClient, baseUrl?: string);

async foldersLocationsGet(name: string): Promise<Location>;

async foldersLocationsList(name: string, opts?: FoldersLocationsListOptions): Promise<ListLocationsResponse>;

async foldersLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async foldersLocationsOperationsDelete(name: string): Promise<Empty>;

async foldersLocationsOperationsGet(name: string): Promise<Operation>;

async foldersLocationsOperationsList(name: string, opts?: FoldersLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async organizationsLocationsGet(name: string): Promise<Location>;

async organizationsLocationsList(name: string, opts?: OrganizationsLocationsListOptions): Promise<ListLocationsResponse>;

async organizationsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async organizationsLocationsOperationsDelete(name: string): Promise<Empty>;

async organizationsLocationsOperationsGet(name: string): Promise<Operation>;

async organizationsLocationsOperationsList(name: string, opts?: OrganizationsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsBucketsDatasetsGet(name: string): Promise<Dataset>;

async projectsLocationsBucketsDatasetsLinksCreate(

parent: string,

req: Link,

opts?: ProjectsLocationsBucketsDatasetsLinksCreateOptions,

): Promise<Operation>;

async projectsLocationsBucketsDatasetsLinksDelete(name: string): Promise<Operation>;

async projectsLocationsBucketsDatasetsLinksGet(name: string): Promise<Link>;

async projectsLocationsBucketsDatasetsLinksList(parent: string, opts?: ProjectsLocationsBucketsDatasetsLinksListOptions): Promise<ListLinksResponse>;

async projectsLocationsBucketsDatasetsLinksPatch(

req: Link,

opts?: ProjectsLocationsBucketsDatasetsLinksPatchOptions,

): Promise<Operation>;

async projectsLocationsBucketsDatasetsList(parent: string, opts?: ProjectsLocationsBucketsDatasetsListOptions): Promise<ListDatasetsResponse>;

async projectsLocationsBucketsDatasetsViewsGet(name: string): Promise<View>;

async projectsLocationsBucketsDatasetsViewsList(parent: string, opts?: ProjectsLocationsBucketsDatasetsViewsListOptions): Promise<ListViewsResponse>;

async projectsLocationsBucketsGet(name: string): Promise<Bucket>;

async projectsLocationsBucketsList(parent: string, opts?: ProjectsLocationsBucketsListOptions): Promise<ListBucketsResponse>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsScopesGet(name: string): Promise<Scope>;

async projectsLocationsScopesPatch(

req: Scope,

opts?: ProjectsLocationsScopesPatchOptions,

): Promise<Scope>;

async projectsLocationsTraceScopesCreate(

parent: string,

req: TraceScope,

opts?: ProjectsLocationsTraceScopesCreateOptions,

): Promise<TraceScope>;

async projectsLocationsTraceScopesDelete(name: string): Promise<Empty>;

async projectsLocationsTraceScopesGet(name: string): Promise<TraceScope>;

async projectsLocationsTraceScopesList(parent: string, opts?: ProjectsLocationsTraceScopesListOptions): Promise<ListTraceScopesResponse>;

async projectsLocationsTraceScopesPatch(

req: TraceScope,

opts?: ProjectsLocationsTraceScopesPatchOptions,

): Promise<TraceScope>;

}

§Constructors

new Observability(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

foldersLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

foldersLocationsList(name: string, opts?: FoldersLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service. This method can be called in two ways: * List all public locations: Use the path GET /v1/locations. * List project-visible locations: Use the path GET /v1/projects/{project_id}/locations. This may include public locations as well as private or other locations specifically visible to the project.

@param name

The resource that owns the locations collection, if applicable.

foldersLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

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. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

foldersLocationsOperationsDelete(name: string): Promise<Empty>

[src]

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.

@param name

The name of the operation resource to be deleted.

foldersLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

foldersLocationsOperationsList(name: string, opts?: FoldersLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

organizationsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

organizationsLocationsList(name: string, opts?: OrganizationsLocationsListOptions): Promise<ListLocationsResponse>

[src]

@param name

The resource that owns the locations collection, if applicable.

organizationsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

organizationsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

organizationsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

organizationsLocationsOperationsList(name: string, opts?: OrganizationsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsBucketsDatasetsGet(name: string): Promise<Dataset>

[src]

Get a dataset.

@param name

Required. Name of the dataset to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

projectsLocationsBucketsDatasetsLinksCreate(parent: string, req: Link, opts?: ProjectsLocationsBucketsDatasetsLinksCreateOptions): Promise<Operation>

[src]

Create a new link.

@param parent

Required. Name of the containing dataset for this link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

projectsLocationsBucketsDatasetsLinksDelete(name: string): Promise<Operation>

[src]

Delete a link.

@param name

Required. Name of the link to delete. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

projectsLocationsBucketsDatasetsLinksGet(name: string): Promise<Link>

[src]

Get a link.

@param name

Required. Name of the link to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

projectsLocationsBucketsDatasetsLinksList(parent: string, opts?: ProjectsLocationsBucketsDatasetsLinksListOptions): Promise<ListLinksResponse>

[src]

List links of a dataset.

@param parent

Required. The parent dataset that owns this collection of links. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

projectsLocationsBucketsDatasetsLinksPatch(name: string, req: Link, opts?: ProjectsLocationsBucketsDatasetsLinksPatchOptions): Promise<Operation>

[src]

Update a link.

@param name

Identifier. Name of the link. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LINK_ID]

projectsLocationsBucketsDatasetsList(parent: string, opts?: ProjectsLocationsBucketsDatasetsListOptions): Promise<ListDatasetsResponse>

[src]

List datasets of a bucket.

@param parent

Required. The parent bucket that owns this collection of datasets. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

projectsLocationsBucketsDatasetsViewsGet(name: string): Promise<View>

[src]

Get a view.

@param name

Required. Name of the view to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIEW_ID]

projectsLocationsBucketsDatasetsViewsList(parent: string, opts?: ProjectsLocationsBucketsDatasetsViewsListOptions): Promise<ListViewsResponse>

[src]

List views of a dataset.

@param parent

Required. Dataset whose views are to be listed. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]

projectsLocationsBucketsGet(name: string): Promise<Bucket>

[src]

Get bucket resource.

@param name

Required. Name of the bucket to retrieve. The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]

projectsLocationsBucketsList(parent: string, opts?: ProjectsLocationsBucketsListOptions): Promise<ListBucketsResponse>

[src]

List buckets of a project in a particular location.

@param parent

Required. The parent, which owns this collection of buckets. The format is: projects/[PROJECT_ID]/locations/[LOCATION]

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsScopesGet(name: string): Promise<Scope>

[src]

Gets details of a single Scope.

@param name

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.

projectsLocationsScopesPatch(name: string, req: Scope, opts?: ProjectsLocationsScopesPatchOptions): Promise<Scope>

[src]

Updates the parameters of a single Scope.

@param name

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.

projectsLocationsTraceScopesCreate(parent: string, req: TraceScope, opts?: ProjectsLocationsTraceScopesCreateOptions): Promise<TraceScope>

[src]

Create a new TraceScope.

@param parent

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

projectsLocationsTraceScopesDelete(name: string): Promise<Empty>

[src]

Delete a TraceScope.

@param name

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

projectsLocationsTraceScopesGet(name: string): Promise<TraceScope>

[src]

Get TraceScope resource.

@param name

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

projectsLocationsTraceScopesList(parent: string, opts?: ProjectsLocationsTraceScopesListOptions): Promise<ListTraceScopesResponse>

[src]

List TraceScopes of a project in a particular location.

@param parent

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

projectsLocationsTraceScopesPatch(name: string, req: TraceScope, opts?: ProjectsLocationsTraceScopesPatchOptions): Promise<TraceScope>

[src]

Update a TraceScope.

@param name

Identifier. The resource name of the trace scope. For example: projects/my-project/locations/global/traceScopes/my-trace-scope