google-cloud-vm_migration-v1 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d37ba3a7ce9890c0507ec039eb6e3f8884b375cfb8ca6bba7d1dfee2a10b9436
-  data.tar.gz: 2103cc017d7d8e3db5fbc8eb09d8c957b73f2805ec9ce2f76dc1f91d89b481e5
+  metadata.gz: f1a7b21b9ceb7fb0fb74bc6d87982ca2f325508255fabb29002f2d5d41142a93
+  data.tar.gz: eb0cd904ee33122798df3bba81dc6ceff8a8e9e5f3d9946894c9e49ab8bb8bd5
 SHA512:
-  metadata.gz: 3d552cd9c7b863fa2db0d1cb9fbc0ac85dd720677a635acb34ccca8b947895dd5e5370ffa396edb317a28db5b64720ab0e0685119398f1043a50fd59ac1764b2
-  data.tar.gz: 91476fbf742843087e24187a1270d5455a40389ded629a3ab020a87fbf6942ee4d72dd0eb14a836634da50e48b18a9fbadc0c88e50bb29ce75d39a0bd555305f
+  metadata.gz: e4221887a0ce71e8bf8650e9094735ed2e0f4a0bbc1268523d3742a94b1c896a5caeeafd800f71707d7b5fb848aae81758a2ff634c17124c0e8243ca3647d29c
+  data.tar.gz: 6748582517ca2cad348072857a0cab7323363524fc1314d4e2aab5073330f3ff0eb4df4b2dcf931e8fa63b04b713913c4fa2106e421331b89fe3e10a4ea0cddf

data/AUTHENTICATION.md

@@ -112,7 +112,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

data/lib/google/cloud/vm_migration/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module VMMigration
       module V1
-        VERSION = "0.3.0"
+        VERSION = "0.4.0"
       end
     end
   end

data/lib/google/cloud/vm_migration/v1/vm_migration/client.rb

@@ -18,6 +18,8 @@
 
 require "google/cloud/errors"
 require "google/cloud/vmmigration/v1/vmmigration_pb"
+require "google/cloud/location"
+require "google/iam/v1"
 
 module Google
   module Cloud
@@ -147,6 +149,18 @@ module Google
                 config.endpoint = @config.endpoint
               end
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
+              @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @vm_migration_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::VMMigration::V1::VmMigration::Stub,
                 credentials:  credentials,
@@ -163,6 +177,20 @@ module Google
             #
             attr_reader :operations_client
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
+            ##
+            # Get the associated client for mix-in of the IAMPolicy.
+            #
+            # @return [Google::Iam::V1::IAMPolicy::Client]
+            #
+            attr_reader :iam_policy_client
+
             # Service calls
 
             ##
@@ -4660,6 +4688,198 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Lists ReplicationCycles in a given MigratingVM.
+            #
+            # @overload list_replication_cycles(request, options = nil)
+            #   Pass arguments to `list_replication_cycles` via a request object, either of type
+            #   {::Google::Cloud::VMMigration::V1::ListReplicationCyclesRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::VMMigration::V1::ListReplicationCyclesRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload list_replication_cycles(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
+            #   Pass arguments to `list_replication_cycles` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param parent [::String]
+            #     Required. The parent, which owns this collection of ReplicationCycles.
+            #   @param page_size [::Integer]
+            #     Optional. The maximum number of replication cycles to return. The service
+            #     may return fewer than this value. If unspecified, at most 100 migrating VMs
+            #     will be returned. The maximum value is 100; values above 100 will be
+            #     coerced to 100.
+            #   @param page_token [::String]
+            #     Required. A page token, received from a previous `ListReplicationCycles`
+            #     call. Provide this to retrieve the subsequent page.
+            #
+            #     When paginating, all other parameters provided to `ListReplicationCycles`
+            #     must match the call that provided the page token.
+            #   @param filter [::String]
+            #     Optional. The filter request.
+            #   @param order_by [::String]
+            #     Optional. the order by fields for the result.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::ReplicationCycle>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::ReplicationCycle>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/vm_migration/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::VMMigration::V1::ListReplicationCyclesRequest.new
+            #
+            #   # Call the list_replication_cycles method.
+            #   result = client.list_replication_cycles 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::Cloud::VMMigration::V1::ReplicationCycle.
+            #     p response
+            #   end
+            #
+            def list_replication_cycles request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::ListReplicationCyclesRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.list_replication_cycles.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.parent
+                header_params["parent"] = request.parent
+              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_replication_cycles.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.list_replication_cycles.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @vm_migration_stub.call_rpc :list_replication_cycles, request, options: options do |response, operation|
+                response = ::Gapic::PagedEnumerable.new @vm_migration_stub, :list_replication_cycles, request, response, operation, options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Gets details of a single ReplicationCycle.
+            #
+            # @overload get_replication_cycle(request, options = nil)
+            #   Pass arguments to `get_replication_cycle` via a request object, either of type
+            #   {::Google::Cloud::VMMigration::V1::GetReplicationCycleRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::VMMigration::V1::GetReplicationCycleRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload get_replication_cycle(name: nil)
+            #   Pass arguments to `get_replication_cycle` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     Required. The name of the ReplicationCycle.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::VMMigration::V1::ReplicationCycle]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::VMMigration::V1::ReplicationCycle]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/vm_migration/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::VMMigration::V1::GetReplicationCycleRequest.new
+            #
+            #   # Call the get_replication_cycle method.
+            #   result = client.get_replication_cycle request
+            #
+            #   # The returned object is of type Google::Cloud::VMMigration::V1::ReplicationCycle.
+            #   p result
+            #
+            def get_replication_cycle request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::GetReplicationCycleRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.get_replication_cycle.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              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_replication_cycle.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.get_replication_cycle.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @vm_migration_stub.call_rpc :get_replication_cycle, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the VmMigration API.
             #
@@ -5015,6 +5235,16 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :delete_target_project
+                ##
+                # RPC-specific configuration for `list_replication_cycles`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :list_replication_cycles
+                ##
+                # RPC-specific configuration for `get_replication_cycle`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :get_replication_cycle
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -5106,6 +5336,10 @@ module Google
                   @update_target_project = ::Gapic::Config::Method.new update_target_project_config
                   delete_target_project_config = parent_rpcs.delete_target_project if parent_rpcs.respond_to? :delete_target_project
                   @delete_target_project = ::Gapic::Config::Method.new delete_target_project_config
+                  list_replication_cycles_config = parent_rpcs.list_replication_cycles if parent_rpcs.respond_to? :list_replication_cycles
+                  @list_replication_cycles = ::Gapic::Config::Method.new list_replication_cycles_config
+                  get_replication_cycle_config = parent_rpcs.get_replication_cycle if parent_rpcs.respond_to? :get_replication_cycle
+                  @get_replication_cycle = ::Gapic::Config::Method.new get_replication_cycle_config
 
                   yield self if block_given?
                 end

data/lib/google/cloud/vm_migration/v1/vm_migration/paths.rb

@@ -148,6 +148,29 @@ module Google
               "projects/#{project}/locations/#{location}/sources/#{source}/migratingVms/#{migrating_vm}"
             end
 
+            ##
+            # Create a fully-qualified ReplicationCycle resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/sources/{source}/migratingVms/{migrating_vm}/replicationCycles/{replication_cycle}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param source [String]
+            # @param migrating_vm [String]
+            # @param replication_cycle [String]
+            #
+            # @return [::String]
+            def replication_cycle_path project:, location:, source:, migrating_vm:, replication_cycle:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "source cannot contain /" if source.to_s.include? "/"
+              raise ::ArgumentError, "migrating_vm cannot contain /" if migrating_vm.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/sources/#{source}/migratingVms/#{migrating_vm}/replicationCycles/#{replication_cycle}"
+            end
+
             ##
             # Create a fully-qualified Source resource string.
             #

data/lib/google/cloud/vm_migration/v1/vm_migration.rb

@@ -34,7 +34,7 @@ module Google
         ##
         # VM Migration Service
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/vm_migration/v1/vm_migration"
         #     client = ::Google::Cloud::VMMigration::V1::VMMigration::Client.new

data/lib/google/cloud/vm_migration/v1.rb

@@ -23,9 +23,9 @@ module Google
   module Cloud
     module VMMigration
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/vm_migration/v1"
       #     client = ::Google::Cloud::VMMigration::V1::VMMigration::Client.new