google-cloud-domains-v1beta1 0.2.1 → 0.3.1

data/lib/google/cloud/domains/v1beta1/domains/operations.rb

@@ -82,7 +82,7 @@ module Google
               # Create credentials
               credentials = @config.credentials
               credentials ||= Credentials.default scope: @config.scope
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -143,6 +143,27 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::ListOperationsRequest.new
+            #
+            #   # Call the list_operations method.
+            #   result = client.list_operations request
+            #
+            #   # The returned object is of type Gapic::PagedEnumerable. You can
+            #   # iterate over all elements by calling #each, and the enumerable
+            #   # will lazily make API calls to fetch subsequent pages. Other
+            #   # methods are also available for managing paging directly.
+            #   result.each do |response|
+            #     # Each element is of type ::Google::Longrunning::Operation.
+            #     p response
+            #   end
+            #
             def list_operations request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -160,16 +181,20 @@ module Google
                 gapic_version: ::Google::Cloud::Domains::V1beta1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.list_operations.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_operations.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -213,6 +238,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::GetOperationRequest.new
+            #
+            #   # Call the get_operation method.
+            #   result = client.get_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def get_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -230,16 +277,20 @@ module Google
                 gapic_version: ::Google::Cloud::Domains::V1beta1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.get_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -283,6 +334,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::DeleteOperationRequest.new
+            #
+            #   # Call the delete_operation method.
+            #   result = client.delete_operation request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def delete_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -300,16 +366,20 @@ module Google
                 gapic_version: ::Google::Cloud::Domains::V1beta1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.delete_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -358,6 +428,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::CancelOperationRequest.new
+            #
+            #   # Call the cancel_operation method.
+            #   result = client.cancel_operation request
+            #
+            #   # The returned object is of type Google::Protobuf::Empty.
+            #   p result
+            #
             def cancel_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -375,16 +460,20 @@ module Google
                 gapic_version: ::Google::Cloud::Domains::V1beta1::VERSION
               metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
 
-              header_params = {
-                "name" => request.name
-              }
+              header_params = {}
+              if request.name
+                header_params["name"] = request.name
+              end
+
               request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
               metadata[:"x-goog-request-params"] ||= request_params_header
 
               options.apply_defaults timeout:      @config.rpcs.cancel_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.cancel_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -396,9 +485,9 @@ module Google
             end
 
             ##
-            # Waits for the specified long-running operation until it is done or reaches
-            # at most a specified timeout, returning the latest state.  If the operation
-            # is already done, the latest state is immediately returned.  If the timeout
+            # Waits until the specified long-running operation is done or reaches at most
+            # a specified timeout, returning the latest state.  If the operation is
+            # already done, the latest state is immediately returned.  If the timeout
             # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
             # timeout is used.  If the server does not support this method, it returns
             # `google.rpc.Code.UNIMPLEMENTED`.
@@ -436,6 +525,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/longrunning"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Longrunning::Operations::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Longrunning::WaitOperationRequest.new
+            #
+            #   # Call the wait_operation method.
+            #   result = client.wait_operation request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def wait_operation request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -456,7 +567,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.wait_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +594,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for list_operations
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Longrunning::Operations::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_operations.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Longrunning::Operations::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_operations.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_operations to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Longrunning::Operations::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_operations.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Longrunning::Operations::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_operations.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

data/lib/google/cloud/domains/v1beta1/domains_pb.rb

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/domains/v1beta1/domains.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -12,6 +10,8 @@ require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/type/money_pb'
 require 'google/type/postal_address_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/domains/v1beta1/domains.proto", :syntax => :proto3) do
     add_message "google.cloud.domains.v1beta1.Registration" do
@@ -32,6 +32,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :STATE_UNSPECIFIED, 0
       value :REGISTRATION_PENDING, 1
       value :REGISTRATION_FAILED, 2
+      value :TRANSFER_PENDING, 3
+      value :TRANSFER_FAILED, 4
       value :ACTIVE, 6
       value :SUSPENDED, 7
       value :EXPORTED, 8
@@ -74,6 +76,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_enum "google.cloud.domains.v1beta1.DnsSettings.DsRecord.Algorithm" do
       value :ALGORITHM_UNSPECIFIED, 0
+      value :RSAMD5, 1
+      value :DH, 2
       value :DSA, 3
       value :ECC, 4
       value :RSASHA1, 5
@@ -86,6 +90,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :ECDSAP384SHA384, 14
       value :ED25519, 15
       value :ED448, 16
+      value :INDIRECT, 252
+      value :PRIVATEDNS, 253
+      value :PRIVATEOID, 254
     end
     add_enum "google.cloud.domains.v1beta1.DnsSettings.DsRecord.DigestType" do
       value :DIGEST_TYPE_UNSPECIFIED, 0
@@ -138,6 +145,21 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :yearly_price, :message, 5, "google.type.Money"
       optional :validate_only, :bool, 6
     end
+    add_message "google.cloud.domains.v1beta1.RetrieveTransferParametersRequest" do
+      optional :domain_name, :string, 1
+      optional :location, :string, 2
+    end
+    add_message "google.cloud.domains.v1beta1.RetrieveTransferParametersResponse" do
+      optional :transfer_parameters, :message, 1, "google.cloud.domains.v1beta1.TransferParameters"
+    end
+    add_message "google.cloud.domains.v1beta1.TransferDomainRequest" do
+      optional :parent, :string, 1
+      optional :registration, :message, 2, "google.cloud.domains.v1beta1.Registration"
+      repeated :contact_notices, :enum, 3, "google.cloud.domains.v1beta1.ContactNotice"
+      optional :yearly_price, :message, 4, "google.type.Money"
+      optional :authorization_code, :message, 5, "google.cloud.domains.v1beta1.AuthorizationCode"
+      optional :validate_only, :bool, 6
+    end
     add_message "google.cloud.domains.v1beta1.ListRegistrationsRequest" do
       optional :parent, :string, 1
       optional :page_size, :int32, 2
@@ -199,6 +221,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :UNSUPPORTED, 3
       value :UNKNOWN, 4
     end
+    add_message "google.cloud.domains.v1beta1.TransferParameters" do
+      optional :domain_name, :string, 1
+      optional :current_registrar, :string, 2
+      repeated :name_servers, :string, 3
+      optional :transfer_lock_state, :enum, 4, "google.cloud.domains.v1beta1.TransferLockState"
+      repeated :supported_privacy, :enum, 5, "google.cloud.domains.v1beta1.ContactPrivacy"
+      optional :yearly_price, :message, 6, "google.type.Money"
+    end
     add_message "google.cloud.domains.v1beta1.AuthorizationCode" do
       optional :code, :string, 1
     end
@@ -256,6 +286,9 @@ module Google
         RetrieveRegisterParametersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RetrieveRegisterParametersRequest").msgclass
         RetrieveRegisterParametersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RetrieveRegisterParametersResponse").msgclass
         RegisterDomainRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RegisterDomainRequest").msgclass
+        RetrieveTransferParametersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RetrieveTransferParametersRequest").msgclass
+        RetrieveTransferParametersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RetrieveTransferParametersResponse").msgclass
+        TransferDomainRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.TransferDomainRequest").msgclass
         ListRegistrationsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.ListRegistrationsRequest").msgclass
         ListRegistrationsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.ListRegistrationsResponse").msgclass
         GetRegistrationRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.GetRegistrationRequest").msgclass
@@ -269,6 +302,7 @@ module Google
         ResetAuthorizationCodeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.ResetAuthorizationCodeRequest").msgclass
         RegisterParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RegisterParameters").msgclass
         RegisterParameters::Availability = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.RegisterParameters.Availability").enummodule
+        TransferParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.TransferParameters").msgclass
         AuthorizationCode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.AuthorizationCode").msgclass
         OperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.OperationMetadata").msgclass
         ContactPrivacy = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.domains.v1beta1.ContactPrivacy").enummodule

data/lib/google/cloud/domains/v1beta1/domains_services_pb.rb

@@ -56,6 +56,35 @@ module Google
             # domain was not registered successfully, and you can safely delete the
             # resource and retry registration.
             rpc :RegisterDomain, ::Google::Cloud::Domains::V1beta1::RegisterDomainRequest, ::Google::Longrunning::Operation
+            # Gets parameters needed to transfer a domain name from another registrar to
+            # Cloud Domains. For domains managed by Google Domains, transferring to Cloud
+            # Domains is not supported.
+            #
+            #
+            # Use the returned values to call `TransferDomain`.
+            rpc :RetrieveTransferParameters, ::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersRequest, ::Google::Cloud::Domains::V1beta1::RetrieveTransferParametersResponse
+            # Transfers a domain name from another registrar to Cloud Domains.  For
+            # domains managed by Google Domains, transferring to Cloud Domains is not
+            # supported.
+            #
+            #
+            # Before calling this method, go to the domain's current registrar to unlock
+            # the domain for transfer and retrieve the domain's transfer authorization
+            # code. Then call `RetrieveTransferParameters` to confirm that the domain is
+            # unlocked and to get values needed to build a call to this method.
+            #
+            # A successful call creates a `Registration` resource in state
+            # `TRANSFER_PENDING`. It can take several days to complete the transfer
+            # process. The registrant can often speed up this process by approving the
+            # transfer through the current registrar, either by clicking a link in an
+            # email from the registrar or by visiting the registrar's website.
+            #
+            # A few minutes after transfer approval, the resource transitions to state
+            # `ACTIVE`, indicating that the transfer was successful. If the transfer is
+            # rejected or the request expires without being approved, the resource can
+            # end up in state `TRANSFER_FAILED`. If transfer fails, you can safely delete
+            # the resource and retry the transfer.
+            rpc :TransferDomain, ::Google::Cloud::Domains::V1beta1::TransferDomainRequest, ::Google::Longrunning::Operation
             # Lists the `Registration` resources in a project.
             rpc :ListRegistrations, ::Google::Cloud::Domains::V1beta1::ListRegistrationsRequest, ::Google::Cloud::Domains::V1beta1::ListRegistrationsResponse
             # Gets the details of a `Registration` resource.
@@ -74,27 +103,35 @@ module Google
             # Updates a `Registration`'s contact settings. Some changes require
             # confirmation by the domain's registrant contact .
             rpc :ConfigureContactSettings, ::Google::Cloud::Domains::V1beta1::ConfigureContactSettingsRequest, ::Google::Longrunning::Operation
-            # Exports a `Registration` that you no longer want to use with
-            # Cloud Domains. You can continue to use the domain in
-            # [Google Domains](https://domains.google/) until it expires.
-            #
-            # If the export is successful:
-            #
-            # * The resource's `state` becomes `EXPORTED`, meaning that it is no longer
-            # managed by Cloud Domains
-            # * Because individual users can own domains in Google Domains, the calling
-            # user becomes the domain's sole owner. Permissions for the domain are
-            # subsequently managed in Google Domains.
-            # * Without further action, the domain does not renew automatically.
-            # The new owner can set up billing in Google Domains to renew the domain
-            # if needed.
+            # Exports a `Registration` resource, such that it is no longer managed by
+            # Cloud Domains.
+            #
+            # When an active domain is successfully exported, you can continue to use the
+            # domain in [Google Domains](https://domains.google/) until it expires. The
+            # calling user becomes the domain's sole owner in Google Domains, and
+            # permissions for the domain are subsequently managed there. The domain does
+            # not renew automatically unless the new owner sets up billing in Google
+            # Domains.
             rpc :ExportRegistration, ::Google::Cloud::Domains::V1beta1::ExportRegistrationRequest, ::Google::Longrunning::Operation
             # Deletes a `Registration` resource.
             #
-            # This method only works on resources in one of the following states:
+            # This method works on any `Registration` resource using [Subscription or
+            # Commitment billing](/domains/pricing#billing-models), provided that the
+            # resource was created at least 1 day in the past.
+            #
+            # For `Registration` resources using
+            # [Monthly billing](/domains/pricing#billing-models), this method works if:
             #
             # * `state` is `EXPORTED` with `expire_time` in the past
             # * `state` is `REGISTRATION_FAILED`
+            # * `state` is `TRANSFER_FAILED`
+            #
+            # When an active registration is successfully deleted, you can continue to
+            # use the domain in [Google Domains](https://domains.google/) until it
+            # expires. The calling user becomes the domain's sole owner in Google
+            # Domains, and permissions for the domain are subsequently managed there. The
+            # domain does not renew automatically unless the new owner sets up billing in
+            # Google Domains.
             rpc :DeleteRegistration, ::Google::Cloud::Domains::V1beta1::DeleteRegistrationRequest, ::Google::Longrunning::Operation
             # Gets the authorization code of the `Registration` for the purpose of
             # transferring the domain to another registrar.

data/lib/google/cloud/domains/v1beta1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Domains
       module V1beta1
-        VERSION = "0.2.1"
+        VERSION = "0.3.1"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # Denotes that a (repeated) field is an unordered list.
       # This indicates that the service may provide the elements of the list
-      # in any arbitrary order, rather than the order the user originally
+      # in any arbitrary  order, rather than the order the user originally
       # provided. Additionally, the list's order may or may not be stable.
       UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end