Observability V1 API - Class Google::Cloud::Observability::V1::Observability::Rest::ServiceStub (v0.1.0)

Reference documentation and code samples for the Observability V1 API class Google::Cloud::Observability::V1::Observability::Rest::ServiceStub.

REST service stub for the Observability service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

• Object

Methods

#create_bucket

def create_bucket(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_bucket REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::CreateBucketRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_link

def create_link(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_link REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::CreateLinkRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_trace_scope

def create_trace_scope(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::TraceScope

Baseline implementation for the create_trace_scope REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::CreateTraceScopeRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::TraceScope)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::TraceScope) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_link

def delete_link(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_link REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::DeleteLinkRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_trace_scope

def delete_trace_scope(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_trace_scope REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::DeleteTraceScopeRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Protobuf::Empty)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Protobuf::Empty) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#get_bucket

def get_bucket(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::Bucket

Baseline implementation for the get_bucket REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::GetBucketRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::Bucket)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::Bucket) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_dataset

def get_dataset(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::Dataset

Baseline implementation for the get_dataset REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::GetDatasetRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::Dataset)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::Dataset) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_link

def get_link(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::Link

Baseline implementation for the get_link REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::GetLinkRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::Link)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::Link) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_scope

def get_scope(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::Scope

Baseline implementation for the get_scope REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::GetScopeRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::Scope)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::Scope) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_settings

def get_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::Settings

Baseline implementation for the get_settings REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::GetSettingsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::Settings)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::Settings) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_trace_scope

def get_trace_scope(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::TraceScope

Baseline implementation for the get_trace_scope REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::GetTraceScopeRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::TraceScope)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::TraceScope) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#get_view

def get_view(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::View

Baseline implementation for the get_view REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::GetViewRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::View)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::View) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_buckets

def list_buckets(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::ListBucketsResponse

Baseline implementation for the list_buckets REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::ListBucketsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::ListBucketsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::ListBucketsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_datasets

def list_datasets(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::ListDatasetsResponse

Baseline implementation for the list_datasets REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::ListDatasetsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::ListDatasetsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::ListDatasetsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_links

def list_links(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::ListLinksResponse

Baseline implementation for the list_links REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::ListLinksRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::ListLinksResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::ListLinksResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_trace_scopes

def list_trace_scopes(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::ListTraceScopesResponse

Baseline implementation for the list_trace_scopes REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::ListTraceScopesRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::ListTraceScopesResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::ListTraceScopesResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#list_views

def list_views(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::ListViewsResponse

Baseline implementation for the list_views REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::ListViewsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::ListViewsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::ListViewsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns

• (Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_bucket

def update_bucket(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_bucket REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::UpdateBucketRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_link

def update_link(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_link REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::UpdateLinkRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_scope

def update_scope(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::Scope

Baseline implementation for the update_scope REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::UpdateScopeRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::Scope)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::Scope) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_settings

def update_settings(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_settings REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::UpdateSettingsRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#update_trace_scope

def update_trace_scope(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Observability::V1::TraceScope

Baseline implementation for the update_trace_scope REST call

Parameters

• request_pb (::Google::Cloud::Observability::V1::UpdateTraceScopeRequest) — A request object representing the call parameters. Required.
• options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

Yields

• (result, operation) — Access the result along with the TransportOperation object

Yield Parameters

• result (::Google::Cloud::Observability::V1::TraceScope)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Observability::V1::TraceScope) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)