Observability v1 API - Class ObservabilityClientImpl (1.0.0-beta01) 

public sealed class ObservabilityClientImpl : ObservabilityClient

Reference documentation and code samples for the Observability v1 API class ObservabilityClientImpl.

Observability client wrapper implementation, for convenient use.

Inheritance

object > ObservabilityClient > ObservabilityClientImpl

Namespace

Google.Cloud.Observability.V1

Assembly

Google.Cloud.Observability.V1.dll

Remarks

Service describing handlers for resources

Constructors

ObservabilityClientImpl(ObservabilityClient, ObservabilitySettings, ILogger)

public ObservabilityClientImpl(Observability.ObservabilityClient grpcClient, ObservabilitySettings settings, ILogger logger)

Constructs a client wrapper for the Observability service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ObservabilityObservabilityClient

The underlying gRPC client.
settings ObservabilitySettings

The base ObservabilitySettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateBucketOperationsClient

public override OperationsClient CreateBucketOperationsClient { get; }

The long-running operations client for CreateBucket.

Property Value
Type Description
OperationsClient
Overrides

CreateLinkOperationsClient

public override OperationsClient CreateLinkOperationsClient { get; }

The long-running operations client for CreateLink.

Property Value
Type Description
OperationsClient
Overrides

DeleteLinkOperationsClient

public override OperationsClient DeleteLinkOperationsClient { get; }

The long-running operations client for DeleteLink.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Observability.ObservabilityClient GrpcClient { get; }

The underlying gRPC Observability client

Property Value
Type Description
ObservabilityObservabilityClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateBucketOperationsClient

public override OperationsClient UpdateBucketOperationsClient { get; }

The long-running operations client for UpdateBucket.

Property Value
Type Description
OperationsClient
Overrides

UpdateLinkOperationsClient

public override OperationsClient UpdateLinkOperationsClient { get; }

The long-running operations client for UpdateLink.

Property Value
Type Description
OperationsClient
Overrides

UpdateSettingsOperationsClient

public override OperationsClient UpdateSettingsOperationsClient { get; }

The long-running operations client for UpdateSettings.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateBucket(CreateBucketRequest, CallSettings)

public override Operation<Bucket, OperationMetadata> CreateBucket(CreateBucketRequest request, CallSettings callSettings = null)

Create a new bucket.

Parameters
Name Description
request CreateBucketRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBucketOperationMetadata

The RPC response.
Overrides

CreateBucketAsync(CreateBucketRequest, CallSettings)

public override Task<Operation<Bucket, OperationMetadata>> CreateBucketAsync(CreateBucketRequest request, CallSettings callSettings = null)

Create a new bucket.

Parameters
Name Description
request CreateBucketRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBucketOperationMetadata

A Task containing the RPC response.
Overrides

CreateLink(CreateLinkRequest, CallSettings)

public override Operation<Link, OperationMetadata> CreateLink(CreateLinkRequest request, CallSettings callSettings = null)

Create a new link.

Parameters
Name Description
request CreateLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationLinkOperationMetadata

The RPC response.
Overrides

CreateLinkAsync(CreateLinkRequest, CallSettings)

public override Task<Operation<Link, OperationMetadata>> CreateLinkAsync(CreateLinkRequest request, CallSettings callSettings = null)

Create a new link.

Parameters
Name Description
request CreateLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationLinkOperationMetadata

A Task containing the RPC response.
Overrides

CreateTraceScope(CreateTraceScopeRequest, CallSettings)

public override TraceScope CreateTraceScope(CreateTraceScopeRequest request, CallSettings callSettings = null)

Create a new TraceScope.

Parameters
Name Description
request CreateTraceScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TraceScope

The RPC response.
Overrides

CreateTraceScopeAsync(CreateTraceScopeRequest, CallSettings)

public override Task<TraceScope> CreateTraceScopeAsync(CreateTraceScopeRequest request, CallSettings callSettings = null)

Create a new TraceScope.

Parameters
Name Description
request CreateTraceScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTraceScope

A Task containing the RPC response.
Overrides

DeleteLink(DeleteLinkRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteLink(DeleteLinkRequest request, CallSettings callSettings = null)

Delete a link.

Parameters
Name Description
request DeleteLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteLinkAsync(DeleteLinkRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteLinkAsync(DeleteLinkRequest request, CallSettings callSettings = null)

Delete a link.

Parameters
Name Description
request DeleteLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

DeleteTraceScope(DeleteTraceScopeRequest, CallSettings)

public override void DeleteTraceScope(DeleteTraceScopeRequest request, CallSettings callSettings = null)

Delete a TraceScope.

Parameters
Name Description
request DeleteTraceScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteTraceScopeAsync(DeleteTraceScopeRequest, CallSettings)

public override Task DeleteTraceScopeAsync(DeleteTraceScopeRequest request, CallSettings callSettings = null)

Delete a TraceScope.

Parameters
Name Description
request DeleteTraceScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Task

A Task containing the RPC response.
Overrides

GetBucket(GetBucketRequest, CallSettings)

public override Bucket GetBucket(GetBucketRequest request, CallSettings callSettings = null)

Get bucket resource.

Parameters
Name Description
request GetBucketRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Bucket

The RPC response.
Overrides

GetBucketAsync(GetBucketRequest, CallSettings)

public override Task<Bucket> GetBucketAsync(GetBucketRequest request, CallSettings callSettings = null)

Get bucket resource.

Parameters
Name Description
request GetBucketRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskBucket

A Task containing the RPC response.
Overrides

GetDataset(GetDatasetRequest, CallSettings)

public override Dataset GetDataset(GetDatasetRequest request, CallSettings callSettings = null)

Get a dataset.

Parameters
Name Description
request GetDatasetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Dataset

The RPC response.
Overrides

GetDatasetAsync(GetDatasetRequest, CallSettings)

public override Task<Dataset> GetDatasetAsync(GetDatasetRequest request, CallSettings callSettings = null)

Get a dataset.

Parameters
Name Description
request GetDatasetRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskDataset

A Task containing the RPC response.
Overrides

GetLink(GetLinkRequest, CallSettings)

public override Link GetLink(GetLinkRequest request, CallSettings callSettings = null)

Get a link.

Parameters
Name Description
request GetLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Link

The RPC response.
Overrides

GetLinkAsync(GetLinkRequest, CallSettings)

public override Task<Link> GetLinkAsync(GetLinkRequest request, CallSettings callSettings = null)

Get a link.

Parameters
Name Description
request GetLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskLink

A Task containing the RPC response.
Overrides

GetScope(GetScopeRequest, CallSettings)

public override Scope GetScope(GetScopeRequest request, CallSettings callSettings = null)

Gets details of a single Scope.

Parameters
Name Description
request GetScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Scope

The RPC response.
Overrides

GetScopeAsync(GetScopeRequest, CallSettings)

public override Task<Scope> GetScopeAsync(GetScopeRequest request, CallSettings callSettings = null)

Gets details of a single Scope.

Parameters
Name Description
request GetScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskScope

A Task containing the RPC response.
Overrides

GetSettings(GetSettingsRequest, CallSettings)

public override Settings GetSettings(GetSettingsRequest request, CallSettings callSettings = null)

Get Settings

Parameters
Name Description
request GetSettingsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Settings

The RPC response.
Overrides

GetSettingsAsync(GetSettingsRequest, CallSettings)

public override Task<Settings> GetSettingsAsync(GetSettingsRequest request, CallSettings callSettings = null)

Get Settings

Parameters
Name Description
request GetSettingsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSettings

A Task containing the RPC response.
Overrides

GetTraceScope(GetTraceScopeRequest, CallSettings)

public override TraceScope GetTraceScope(GetTraceScopeRequest request, CallSettings callSettings = null)

Get TraceScope resource.

Parameters
Name Description
request GetTraceScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TraceScope

The RPC response.
Overrides

GetTraceScopeAsync(GetTraceScopeRequest, CallSettings)

public override Task<TraceScope> GetTraceScopeAsync(GetTraceScopeRequest request, CallSettings callSettings = null)

Get TraceScope resource.

Parameters
Name Description
request GetTraceScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTraceScope

A Task containing the RPC response.
Overrides

GetView(GetViewRequest, CallSettings)

public override View GetView(GetViewRequest request, CallSettings callSettings = null)

Get a view.

Parameters
Name Description
request GetViewRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
View

The RPC response.
Overrides

GetViewAsync(GetViewRequest, CallSettings)

public override Task<View> GetViewAsync(GetViewRequest request, CallSettings callSettings = null)

Get a view.

Parameters
Name Description
request GetViewRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskView

A Task containing the RPC response.
Overrides

ListBuckets(ListBucketsRequest, CallSettings)

public override PagedEnumerable<ListBucketsResponse, Bucket> ListBuckets(ListBucketsRequest request, CallSettings callSettings = null)

List buckets of a project in a particular location.

Parameters
Name Description
request ListBucketsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListBucketsResponseBucket

A pageable sequence of Bucket resources.
Overrides

ListBucketsAsync(ListBucketsRequest, CallSettings)

public override PagedAsyncEnumerable<ListBucketsResponse, Bucket> ListBucketsAsync(ListBucketsRequest request, CallSettings callSettings = null)

List buckets of a project in a particular location.

Parameters
Name Description
request ListBucketsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListBucketsResponseBucket

A pageable asynchronous sequence of Bucket resources.
Overrides

ListDatasets(ListDatasetsRequest, CallSettings)

public override PagedEnumerable<ListDatasetsResponse, Dataset> ListDatasets(ListDatasetsRequest request, CallSettings callSettings = null)

List datasets of a bucket.

Parameters
Name Description
request ListDatasetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListDatasetsResponseDataset

A pageable sequence of Dataset resources.
Overrides

ListDatasetsAsync(ListDatasetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListDatasetsResponse, Dataset> ListDatasetsAsync(ListDatasetsRequest request, CallSettings callSettings = null)

List datasets of a bucket.

Parameters
Name Description
request ListDatasetsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListDatasetsResponseDataset

A pageable asynchronous sequence of Dataset resources.
Overrides

ListLinks(ListLinksRequest, CallSettings)

public override PagedEnumerable<ListLinksResponse, Link> ListLinks(ListLinksRequest request, CallSettings callSettings = null)

List links of a dataset.

Parameters
Name Description
request ListLinksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListLinksResponseLink

A pageable sequence of Link resources.
Overrides

ListLinksAsync(ListLinksRequest, CallSettings)

public override PagedAsyncEnumerable<ListLinksResponse, Link> ListLinksAsync(ListLinksRequest request, CallSettings callSettings = null)

List links of a dataset.

Parameters
Name Description
request ListLinksRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListLinksResponseLink

A pageable asynchronous sequence of Link resources.
Overrides

ListTraceScopes(ListTraceScopesRequest, CallSettings)

public override PagedEnumerable<ListTraceScopesResponse, TraceScope> ListTraceScopes(ListTraceScopesRequest request, CallSettings callSettings = null)

List TraceScopes of a project in a particular location.

Parameters
Name Description
request ListTraceScopesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTraceScopesResponseTraceScope

A pageable sequence of TraceScope resources.
Overrides

ListTraceScopesAsync(ListTraceScopesRequest, CallSettings)

public override PagedAsyncEnumerable<ListTraceScopesResponse, TraceScope> ListTraceScopesAsync(ListTraceScopesRequest request, CallSettings callSettings = null)

List TraceScopes of a project in a particular location.

Parameters
Name Description
request ListTraceScopesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTraceScopesResponseTraceScope

A pageable asynchronous sequence of TraceScope resources.
Overrides

ListViews(ListViewsRequest, CallSettings)

public override PagedEnumerable<ListViewsResponse, View> ListViews(ListViewsRequest request, CallSettings callSettings = null)

List views of a dataset.

Parameters
Name Description
request ListViewsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListViewsResponseView

A pageable sequence of View resources.
Overrides

ListViewsAsync(ListViewsRequest, CallSettings)

public override PagedAsyncEnumerable<ListViewsResponse, View> ListViewsAsync(ListViewsRequest request, CallSettings callSettings = null)

List views of a dataset.

Parameters
Name Description
request ListViewsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListViewsResponseView

A pageable asynchronous sequence of View resources.
Overrides

UpdateBucket(UpdateBucketRequest, CallSettings)

public override Operation<Bucket, OperationMetadata> UpdateBucket(UpdateBucketRequest request, CallSettings callSettings = null)

Update a bucket.

Parameters
Name Description
request UpdateBucketRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBucketOperationMetadata

The RPC response.
Overrides

UpdateBucketAsync(UpdateBucketRequest, CallSettings)

public override Task<Operation<Bucket, OperationMetadata>> UpdateBucketAsync(UpdateBucketRequest request, CallSettings callSettings = null)

Update a bucket.

Parameters
Name Description
request UpdateBucketRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBucketOperationMetadata

A Task containing the RPC response.
Overrides

UpdateLink(UpdateLinkRequest, CallSettings)

public override Operation<Link, OperationMetadata> UpdateLink(UpdateLinkRequest request, CallSettings callSettings = null)

Update a link.

Parameters
Name Description
request UpdateLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationLinkOperationMetadata

The RPC response.
Overrides

UpdateLinkAsync(UpdateLinkRequest, CallSettings)

public override Task<Operation<Link, OperationMetadata>> UpdateLinkAsync(UpdateLinkRequest request, CallSettings callSettings = null)

Update a link.

Parameters
Name Description
request UpdateLinkRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationLinkOperationMetadata

A Task containing the RPC response.
Overrides

UpdateScope(UpdateScopeRequest, CallSettings)

public override Scope UpdateScope(UpdateScopeRequest request, CallSettings callSettings = null)

Updates the parameters of a single Scope.

Parameters
Name Description
request UpdateScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Scope

The RPC response.
Overrides

UpdateScopeAsync(UpdateScopeRequest, CallSettings)

public override Task<Scope> UpdateScopeAsync(UpdateScopeRequest request, CallSettings callSettings = null)

Updates the parameters of a single Scope.

Parameters
Name Description
request UpdateScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskScope

A Task containing the RPC response.
Overrides

UpdateSettings(UpdateSettingsRequest, CallSettings)

public override Operation<Settings, OperationMetadata> UpdateSettings(UpdateSettingsRequest request, CallSettings callSettings = null)

Update Settings

Parameters
Name Description
request UpdateSettingsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationSettingsOperationMetadata

The RPC response.
Overrides

UpdateSettingsAsync(UpdateSettingsRequest, CallSettings)

public override Task<Operation<Settings, OperationMetadata>> UpdateSettingsAsync(UpdateSettingsRequest request, CallSettings callSettings = null)

Update Settings

Parameters
Name Description
request UpdateSettingsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationSettingsOperationMetadata

A Task containing the RPC response.
Overrides

UpdateTraceScope(UpdateTraceScopeRequest, CallSettings)

public override TraceScope UpdateTraceScope(UpdateTraceScopeRequest request, CallSettings callSettings = null)

Update a TraceScope.

Parameters
Name Description
request UpdateTraceScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TraceScope

The RPC response.
Overrides

UpdateTraceScopeAsync(UpdateTraceScopeRequest, CallSettings)

public override Task<TraceScope> UpdateTraceScopeAsync(UpdateTraceScopeRequest request, CallSettings callSettings = null)

Update a TraceScope.

Parameters
Name Description
request UpdateTraceScopeRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTraceScope

A Task containing the RPC response.
Overrides