lib/google/cloud/domains/v1beta1/domains/rest/client.rb in google-cloud-domains-v1beta1-0.6.0 vs lib/google/cloud/domains/v1beta1/domains/rest/client.rb in google-cloud-domains-v1beta1-0.7.0

- old
+ new

@@ -179,10 +179,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Domains::V1beta1::SearchDomainsResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::SearchDomainsRequest.new + # + # # Call the search_domains method. + # result = client.search_domains request + # + # # The returned object is of type Google::Cloud::Domains::V1beta1::SearchDomainsResponse. + # p result + # def search_domains request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::SearchDomainsRequest @@ -244,10 +260,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Domains::V1beta1::RetrieveRegisterParametersResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::RetrieveRegisterParametersRequest.new + # + # # Call the retrieve_register_parameters method. + # result = client.retrieve_register_parameters request + # + # # The returned object is of type Google::Cloud::Domains::V1beta1::RetrieveRegisterParametersResponse. + # p result + # def retrieve_register_parameters request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::RetrieveRegisterParametersRequest @@ -336,10 +368,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::RegisterDomainRequest.new + # + # # Call the register_domain method. + # result = client.register_domain request + # + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "No response received." + # end + # def register_domain request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::RegisterDomainRequest @@ -406,10 +461,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::RetrieveTransferParametersRequest.new + # + # # Call the retrieve_transfer_parameters method. + # result = client.retrieve_transfer_parameters request + # + # # The returned object is of type Google::Cloud::Domains::V1beta1::RetrieveTransferParametersResponse. + # p result + # def retrieve_transfer_parameters request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersRequest @@ -510,10 +581,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::TransferDomainRequest.new + # + # # Call the transfer_domain method. + # result = client.transfer_domain request + # + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "No response received." + # end + # def transfer_domain request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::TransferDomainRequest @@ -596,10 +690,30 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Domains::V1beta1::Registration>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::ListRegistrationsRequest.new + # + # # Call the list_registrations method. + # result = client.list_registrations request + # + # # The returned object is of type Gapic::PagedEnumerable. You can iterate + # # over elements, and API calls will be issued to fetch pages as needed. + # result.each do |item| + # # Each element is of type ::Google::Cloud::Domains::V1beta1::Registration. + # p item + # end + # def list_registrations request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::ListRegistrationsRequest @@ -660,10 +774,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Domains::V1beta1::Registration] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::GetRegistrationRequest.new + # + # # Call the get_registration method. + # result = client.get_registration request + # + # # The returned object is of type Google::Cloud::Domains::V1beta1::Registration. + # p result + # def get_registration request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::GetRegistrationRequest @@ -731,10 +861,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::UpdateRegistrationRequest.new + # + # # Call the update_registration method. + # result = client.update_registration request + # + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "No response received." + # end + # def update_registration request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::UpdateRegistrationRequest @@ -801,10 +954,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::ConfigureManagementSettingsRequest.new + # + # # Call the configure_management_settings method. + # result = client.configure_management_settings request + # + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "No response received." + # end + # def configure_management_settings request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::ConfigureManagementSettingsRequest @@ -879,10 +1055,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::ConfigureDnsSettingsRequest.new + # + # # Call the configure_dns_settings method. + # result = client.configure_dns_settings request + # + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "No response received." + # end + # def configure_dns_settings request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::ConfigureDnsSettingsRequest @@ -955,10 +1154,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::ConfigureContactSettingsRequest.new + # + # # Call the configure_contact_settings method. + # result = client.configure_contact_settings request + # + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "No response received." + # end + # def configure_contact_settings request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::ConfigureContactSettingsRequest @@ -1027,10 +1249,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::ExportRegistrationRequest.new + # + # # Call the export_registration method. + # result = client.export_registration request + # + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "No response received." + # end + # def export_registration request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::ExportRegistrationRequest @@ -1109,10 +1354,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::DeleteRegistrationRequest.new + # + # # Call the delete_registration method. + # result = client.delete_registration request + # + # # The returned object is of type Gapic::Operation. You can use it to + # # check the status of an operation, cancel it, or wait for results. + # # Here is how to wait for a response. + # result.wait_until_done! timeout: 60 + # if result.response? + # p result.response + # else + # puts "No response received." + # end + # def delete_registration request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::DeleteRegistrationRequest @@ -1177,10 +1445,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Domains::V1beta1::AuthorizationCode] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::RetrieveAuthorizationCodeRequest.new + # + # # Call the retrieve_authorization_code method. + # result = client.retrieve_authorization_code request + # + # # The returned object is of type Google::Cloud::Domains::V1beta1::AuthorizationCode. + # p result + # def retrieve_authorization_code request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::RetrieveAuthorizationCodeRequest @@ -1243,9 +1527,25 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Domains::V1beta1::AuthorizationCode] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/domains/v1beta1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Domains::V1beta1::Domains::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Domains::V1beta1::ResetAuthorizationCodeRequest.new + # + # # Call the reset_authorization_code method. + # result = client.reset_authorization_code request + # + # # The returned object is of type Google::Cloud::Domains::V1beta1::AuthorizationCode. + # p result + # def reset_authorization_code request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Domains::V1beta1::ResetAuthorizationCodeRequest