Cloud Domains V1 API - Class Google::Cloud::Domains::V1::Domains::Rest::ServiceStub (v0.7.1)

Version latest

• 0.7.1 (latest)
• 0.7.0
• 0.6.2
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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

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

Inherits

• Object

Methods

#configure_contact_settings

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

Baseline implementation for the configure_contact_settings REST call

Parameters

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

#configure_dns_settings

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

Baseline implementation for the configure_dns_settings REST call

Parameters

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

#configure_management_settings

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

Baseline implementation for the configure_management_settings REST call

Parameters

• request_pb (::Google::Cloud::Domains::V1::ConfigureManagementSettingsRequest) — 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_registration

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

Baseline implementation for the delete_registration REST call

Parameters

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

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#export_registration

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

Baseline implementation for the export_registration REST call

Parameters

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

#get_registration

def get_registration(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Domains::V1::Registration

Baseline implementation for the get_registration REST call

Parameters

• request_pb (::Google::Cloud::Domains::V1::GetRegistrationRequest) — 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::Domains::V1::Registration)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Domains::V1::Registration) — 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_registrations

def list_registrations(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Domains::V1::ListRegistrationsResponse

Baseline implementation for the list_registrations REST call

Parameters

• request_pb (::Google::Cloud::Domains::V1::ListRegistrationsRequest) — 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::Domains::V1::ListRegistrationsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#register_domain

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

Baseline implementation for the register_domain REST call

Parameters

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

#reset_authorization_code

def reset_authorization_code(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Domains::V1::AuthorizationCode

Baseline implementation for the reset_authorization_code REST call

Parameters

• request_pb (::Google::Cloud::Domains::V1::ResetAuthorizationCodeRequest) — 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::Domains::V1::AuthorizationCode)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#retrieve_authorization_code

def retrieve_authorization_code(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Domains::V1::AuthorizationCode

Baseline implementation for the retrieve_authorization_code REST call

Parameters

• request_pb (::Google::Cloud::Domains::V1::RetrieveAuthorizationCodeRequest) — 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::Domains::V1::AuthorizationCode)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#retrieve_register_parameters

def retrieve_register_parameters(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Domains::V1::RetrieveRegisterParametersResponse

Baseline implementation for the retrieve_register_parameters REST call

Parameters

• request_pb (::Google::Cloud::Domains::V1::RetrieveRegisterParametersRequest) — 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::Domains::V1::RetrieveRegisterParametersResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#retrieve_transfer_parameters

def retrieve_transfer_parameters(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Domains::V1::RetrieveTransferParametersResponse

Baseline implementation for the retrieve_transfer_parameters REST call

Parameters

• request_pb (::Google::Cloud::Domains::V1::RetrieveTransferParametersRequest) — 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::Domains::V1::RetrieveTransferParametersResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#search_domains

def search_domains(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Domains::V1::SearchDomainsResponse

Baseline implementation for the search_domains REST call

Parameters

• request_pb (::Google::Cloud::Domains::V1::SearchDomainsRequest) — 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::Domains::V1::SearchDomainsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

• (::ArgumentError)

#transfer_domain

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

Baseline implementation for the transfer_domain REST call

Parameters

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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_registration

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

Baseline implementation for the update_registration REST call

Parameters

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