Service Health V1 API - Class Google::Cloud::ServiceHealth::V1::ServiceHealth::Rest::ServiceStub (v0.2.0)

Version 0.2.0

• 1.0.0 (latest)
• 0.2.0
• 0.1.2

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

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

Inherits

• Object

Methods

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#get_event

def get_event(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ServiceHealth::V1::Event

Baseline implementation for the get_event REST call

Parameters

• request_pb (::Google::Cloud::ServiceHealth::V1::GetEventRequest) — 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::ServiceHealth::V1::Event)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#get_organization_event

def get_organization_event(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ServiceHealth::V1::OrganizationEvent

Baseline implementation for the get_organization_event REST call

Parameters

• request_pb (::Google::Cloud::ServiceHealth::V1::GetOrganizationEventRequest) — 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::ServiceHealth::V1::OrganizationEvent)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#get_organization_impact

def get_organization_impact(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ServiceHealth::V1::OrganizationImpact

Baseline implementation for the get_organization_impact REST call

Parameters

• request_pb (::Google::Cloud::ServiceHealth::V1::GetOrganizationImpactRequest) — 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::ServiceHealth::V1::OrganizationImpact)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_events

def list_events(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ServiceHealth::V1::ListEventsResponse

Baseline implementation for the list_events REST call

Parameters

• request_pb (::Google::Cloud::ServiceHealth::V1::ListEventsRequest) — 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::ServiceHealth::V1::ListEventsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#list_organization_events

def list_organization_events(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ServiceHealth::V1::ListOrganizationEventsResponse

Baseline implementation for the list_organization_events REST call

Parameters

• request_pb (::Google::Cloud::ServiceHealth::V1::ListOrganizationEventsRequest) — 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::ServiceHealth::V1::ListOrganizationEventsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#list_organization_impacts

def list_organization_impacts(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::ServiceHealth::V1::ListOrganizationImpactsResponse

Baseline implementation for the list_organization_impacts REST call

Parameters

• request_pb (::Google::Cloud::ServiceHealth::V1::ListOrganizationImpactsRequest) — 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::ServiceHealth::V1::ListOrganizationImpactsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)