Essential Contacts V1 API - Class Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::ServiceStub (v1.0.1)

Version 1.0.1

• 1.1.0 (latest)
• 1.0.2
• 0.7.0
• 0.6.2
• 0.5.0
• 0.4.1
• 0.3.0
• 0.2.0
• 0.1.4

Reference documentation and code samples for the Essential Contacts V1 API class Google::Cloud::EssentialContacts::V1::EssentialContactsService::Rest::ServiceStub.

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

Inherits

• Object

Methods

#compute_contacts

def compute_contacts(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::EssentialContacts::V1::ComputeContactsResponse

Baseline implementation for the compute_contacts REST call

Parameters

• request_pb (::Google::Cloud::EssentialContacts::V1::ComputeContactsRequest) — 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::EssentialContacts::V1::ComputeContactsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#create_contact

def create_contact(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::EssentialContacts::V1::Contact

Baseline implementation for the create_contact REST call

Parameters

• request_pb (::Google::Cloud::EssentialContacts::V1::CreateContactRequest) — 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::EssentialContacts::V1::Contact)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#delete_contact

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

Baseline implementation for the delete_contact REST call

Parameters

• request_pb (::Google::Cloud::EssentialContacts::V1::DeleteContactRequest) — 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_contact

def get_contact(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::EssentialContacts::V1::Contact

Baseline implementation for the get_contact REST call

Parameters

• request_pb (::Google::Cloud::EssentialContacts::V1::GetContactRequest) — 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::EssentialContacts::V1::Contact)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::EssentialContacts::V1::Contact) — 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_contacts

def list_contacts(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::EssentialContacts::V1::ListContactsResponse

Baseline implementation for the list_contacts REST call

Parameters

• request_pb (::Google::Cloud::EssentialContacts::V1::ListContactsRequest) — 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::EssentialContacts::V1::ListContactsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#send_test_message

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

Baseline implementation for the send_test_message REST call

Parameters

• request_pb (::Google::Cloud::EssentialContacts::V1::SendTestMessageRequest) — 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)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_contact

def update_contact(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::EssentialContacts::V1::Contact

Baseline implementation for the update_contact REST call

Parameters

• request_pb (::Google::Cloud::EssentialContacts::V1::UpdateContactRequest) — 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::EssentialContacts::V1::Contact)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)