google-cloud-vm_migration-v1 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -19,7 +19,6 @@
19
19
  require "google/cloud/errors"
20
20
  require "google/cloud/vmmigration/v1/vmmigration_pb"
21
21
  require "google/cloud/location"
22
- require "google/iam/v1"
23
22
 
24
23
  module Google
25
24
  module Cloud
@@ -195,14 +194,6 @@ module Google
195
194
  config.universe_domain = @vm_migration_stub.universe_domain
196
195
  config.logger = @vm_migration_stub.logger if config.respond_to? :logger=
197
196
  end
198
-
199
- @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
200
- config.credentials = credentials
201
- config.quota_project = @quota_project_id
202
- config.endpoint = @vm_migration_stub.endpoint
203
- config.universe_domain = @vm_migration_stub.universe_domain
204
- config.logger = @vm_migration_stub.logger if config.respond_to? :logger=
205
- end
206
197
  end
207
198
 
208
199
  ##
@@ -219,13 +210,6 @@ module Google
219
210
  #
220
211
  attr_reader :location_client
221
212
 
222
- ##
223
- # Get the associated client for mix-in of the IAMPolicy.
224
- #
225
- # @return [Google::Iam::V1::IAMPolicy::Client]
226
- #
227
- attr_reader :iam_policy_client
228
-
229
213
  ##
230
214
  # The logger used for request/response debug logging.
231
215
  #
@@ -458,8 +442,8 @@ module Google
458
442
  # the request if it has already been completed. The server will guarantee
459
443
  # that for at least 60 minutes since the first request.
460
444
  #
461
- # For example, consider a situation where you make an initial request and t
462
- # he request times out. If you make the request again with the same request
445
+ # For example, consider a situation where you make an initial request and
446
+ # the request times out. If you make the request again with the same request
463
447
  # ID, the server can check if original operation with the same request ID
464
448
  # was received, and if so, will ignore the second request. This prevents
465
449
  # clients from accidentally creating duplicate commitments.
@@ -572,8 +556,8 @@ module Google
572
556
  # the request if it has already been completed. The server will guarantee
573
557
  # that for at least 60 minutes since the first request.
574
558
  #
575
- # For example, consider a situation where you make an initial request and t
576
- # he request times out. If you make the request again with the same request
559
+ # For example, consider a situation where you make an initial request and
560
+ # the request times out. If you make the request again with the same request
577
561
  # ID, the server can check if original operation with the same request ID
578
562
  # was received, and if so, will ignore the second request. This prevents
579
563
  # clients from accidentally creating duplicate commitments.
@@ -680,8 +664,8 @@ module Google
680
664
  # the request if it has already been completed. The server will guarantee
681
665
  # that for at least 60 minutes after the first request.
682
666
  #
683
- # For example, consider a situation where you make an initial request and t
684
- # he request times out. If you make the request again with the same request
667
+ # For example, consider a situation where you make an initial request and
668
+ # the request times out. If you make the request again with the same request
685
669
  # ID, the server can check if original operation with the same request ID
686
670
  # was received, and if so, will ignore the second request. This prevents
687
671
  # clients from accidentally creating duplicate commitments.
@@ -854,6 +838,115 @@ module Google
854
838
  raise ::Google::Cloud::Error.from_error(e)
855
839
  end
856
840
 
841
+ ##
842
+ # List remote source's inventory of storage resources.
843
+ # The remote source is another cloud vendor (e.g. AWS, Azure).
844
+ # The inventory describes the list of existing storage resources in that
845
+ # source. Note that this operation lists the resources on the remote source,
846
+ # as opposed to listing the MigratingVms resources in the vmmigration
847
+ # service.
848
+ #
849
+ # @overload fetch_storage_inventory(request, options = nil)
850
+ # Pass arguments to `fetch_storage_inventory` via a request object, either of type
851
+ # {::Google::Cloud::VMMigration::V1::FetchStorageInventoryRequest} or an equivalent Hash.
852
+ #
853
+ # @param request [::Google::Cloud::VMMigration::V1::FetchStorageInventoryRequest, ::Hash]
854
+ # A request object representing the call parameters. Required. To specify no
855
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
856
+ # @param options [::Gapic::CallOptions, ::Hash]
857
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
858
+ #
859
+ # @overload fetch_storage_inventory(source: nil, type: nil, force_refresh: nil, page_size: nil, page_token: nil)
860
+ # Pass arguments to `fetch_storage_inventory` via keyword arguments. Note that at
861
+ # least one keyword argument is required. To specify no parameters, or to keep all
862
+ # the default parameter values, pass an empty Hash as a request object (see above).
863
+ #
864
+ # @param source [::String]
865
+ # Required. The name of the Source.
866
+ # @param type [::Google::Cloud::VMMigration::V1::FetchStorageInventoryRequest::StorageType]
867
+ # Required. The type of the storage inventory to fetch.
868
+ # @param force_refresh [::Boolean]
869
+ # Optional. If this flag is set to true, the source will be queried instead
870
+ # of using cached results. Using this flag will make the call slower.
871
+ # @param page_size [::Integer]
872
+ # Optional. The maximum number of VMs to return. The service may return
873
+ # fewer than this value.
874
+ # @param page_token [::String]
875
+ # Optional. A page token, received from a previous `FetchStorageInventory`
876
+ # call. Provide this to retrieve the subsequent page. When paginating, all
877
+ # other parameters provided to `FetchStorageInventory` must match the call
878
+ # that provided the page token.
879
+ #
880
+ # @yield [response, operation] Access the result along with the RPC operation
881
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::SourceStorageResource>]
882
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
883
+ #
884
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::SourceStorageResource>]
885
+ #
886
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
887
+ #
888
+ # @example Basic example
889
+ # require "google/cloud/vm_migration/v1"
890
+ #
891
+ # # Create a client object. The client can be reused for multiple calls.
892
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
893
+ #
894
+ # # Create a request. To set request fields, pass in keyword arguments.
895
+ # request = Google::Cloud::VMMigration::V1::FetchStorageInventoryRequest.new
896
+ #
897
+ # # Call the fetch_storage_inventory method.
898
+ # result = client.fetch_storage_inventory request
899
+ #
900
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
901
+ # # over elements, and API calls will be issued to fetch pages as needed.
902
+ # result.each do |item|
903
+ # # Each element is of type ::Google::Cloud::VMMigration::V1::SourceStorageResource.
904
+ # p item
905
+ # end
906
+ #
907
+ def fetch_storage_inventory request, options = nil
908
+ raise ::ArgumentError, "request must be provided" if request.nil?
909
+
910
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::FetchStorageInventoryRequest
911
+
912
+ # Converts hash and nil to an options object
913
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
914
+
915
+ # Customize the options with defaults
916
+ metadata = @config.rpcs.fetch_storage_inventory.metadata.to_h
917
+
918
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
919
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
920
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
921
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
922
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
923
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
924
+
925
+ header_params = {}
926
+ if request.source
927
+ header_params["source"] = request.source
928
+ end
929
+
930
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
931
+ metadata[:"x-goog-request-params"] ||= request_params_header
932
+
933
+ options.apply_defaults timeout: @config.rpcs.fetch_storage_inventory.timeout,
934
+ metadata: metadata,
935
+ retry_policy: @config.rpcs.fetch_storage_inventory.retry_policy
936
+
937
+ options.apply_defaults timeout: @config.timeout,
938
+ metadata: @config.metadata,
939
+ retry_policy: @config.retry_policy
940
+
941
+ @vm_migration_stub.call_rpc :fetch_storage_inventory, request, options: options do |response, operation|
942
+ response = ::Gapic::PagedEnumerable.new @vm_migration_stub, :fetch_storage_inventory, request, response, operation, options
943
+ yield response, operation if block_given?
944
+ throw :response, response
945
+ end
946
+ rescue ::GRPC::BadStatus => e
947
+ raise ::Google::Cloud::Error.from_error(e)
948
+ end
949
+
857
950
  ##
858
951
  # Lists Utilization Reports of the given Source.
859
952
  #
@@ -1086,8 +1179,8 @@ module Google
1086
1179
  # the request if it has already been completed. The server will guarantee
1087
1180
  # that for at least 60 minutes since the first request.
1088
1181
  #
1089
- # For example, consider a situation where you make an initial request and t
1090
- # he request times out. If you make the request again with the same request
1182
+ # For example, consider a situation where you make an initial request and
1183
+ # the request times out. If you make the request again with the same request
1091
1184
  # ID, the server can check if original operation with the same request ID
1092
1185
  # was received, and if so, will ignore the second request. This prevents
1093
1186
  # clients from accidentally creating duplicate commitments.
@@ -1194,8 +1287,8 @@ module Google
1194
1287
  # the request if it has already been completed. The server will guarantee
1195
1288
  # that for at least 60 minutes after the first request.
1196
1289
  #
1197
- # For example, consider a situation where you make an initial request and t
1198
- # he request times out. If you make the request again with the same request
1290
+ # For example, consider a situation where you make an initial request and
1291
+ # the request times out. If you make the request again with the same request
1199
1292
  # ID, the server can check if original operation with the same request ID
1200
1293
  # was received, and if so, will ignore the second request. This prevents
1201
1294
  # clients from accidentally creating duplicate commitments.
@@ -1501,8 +1594,8 @@ module Google
1501
1594
  # the request if it has already been completed. The server will guarantee
1502
1595
  # that for at least 60 minutes since the first request.
1503
1596
  #
1504
- # For example, consider a situation where you make an initial request and t
1505
- # he request times out. If you make the request again with the same request
1597
+ # For example, consider a situation where you make an initial request and
1598
+ # the request times out. If you make the request again with the same request
1506
1599
  # ID, the server can check if original operation with the same request ID
1507
1600
  # was received, and if so, will ignore the second request. This prevents
1508
1601
  # clients from accidentally creating duplicate commitments.
@@ -1609,8 +1702,8 @@ module Google
1609
1702
  # the request if it has already been completed. The server will guarantee
1610
1703
  # that for at least 60 minutes after the first request.
1611
1704
  #
1612
- # For example, consider a situation where you make an initial request and t
1613
- # he request times out. If you make the request again with the same request
1705
+ # For example, consider a situation where you make an initial request and
1706
+ # the request times out. If you make the request again with the same request
1614
1707
  # ID, the server can check if original operation with the same request ID
1615
1708
  # was received, and if so, will ignore the second request. This prevents
1616
1709
  # clients from accidentally creating duplicate commitments.
@@ -1718,8 +1811,8 @@ module Google
1718
1811
  # the request if it has already been completed. The server will guarantee
1719
1812
  # that for at least 60 minutes after the first request.
1720
1813
  #
1721
- # For example, consider a situation where you make an initial request and t
1722
- # he request times out. If you make the request again with the same request
1814
+ # For example, consider a situation where you make an initial request and
1815
+ # the request times out. If you make the request again with the same request
1723
1816
  # ID, the server can check if original operation with the same request ID
1724
1817
  # was received, and if so, will ignore the second request. This prevents
1725
1818
  # clients from accidentally creating duplicate commitments.
@@ -1830,8 +1923,8 @@ module Google
1830
1923
  # the request if it has already been completed. The server will guarantee
1831
1924
  # that for at least 60 minutes since the first request.
1832
1925
  #
1833
- # For example, consider a situation where you make an initial request and t
1834
- # he request times out. If you make the request again with the same request
1926
+ # For example, consider a situation where you make an initial request and
1927
+ # the request times out. If you make the request again with the same request
1835
1928
  # ID, the server can check if original operation with the same request ID
1836
1929
  # was received, and if so, will ignore the second request. This prevents
1837
1930
  # clients from accidentally creating duplicate commitments.
@@ -2139,8 +2232,8 @@ module Google
2139
2232
  # the request if it has already been completed. The server will guarantee
2140
2233
  # that for at least 60 minutes since the first request.
2141
2234
  #
2142
- # For example, consider a situation where you make an initial request and t
2143
- # he request times out. If you make the request again with the same request
2235
+ # For example, consider a situation where you make an initial request and
2236
+ # the request times out. If you make the request again with the same request
2144
2237
  # ID, the server can check if original operation with the same request ID
2145
2238
  # was received, and if so, will ignore the second request. This prevents
2146
2239
  # clients from accidentally creating duplicate commitments.
@@ -2698,6 +2791,100 @@ module Google
2698
2791
  raise ::Google::Cloud::Error.from_error(e)
2699
2792
  end
2700
2793
 
2794
+ ##
2795
+ # Extend the migrating VM time to live.
2796
+ #
2797
+ # @overload extend_migration(request, options = nil)
2798
+ # Pass arguments to `extend_migration` via a request object, either of type
2799
+ # {::Google::Cloud::VMMigration::V1::ExtendMigrationRequest} or an equivalent Hash.
2800
+ #
2801
+ # @param request [::Google::Cloud::VMMigration::V1::ExtendMigrationRequest, ::Hash]
2802
+ # A request object representing the call parameters. Required. To specify no
2803
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2804
+ # @param options [::Gapic::CallOptions, ::Hash]
2805
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2806
+ #
2807
+ # @overload extend_migration(migrating_vm: nil)
2808
+ # Pass arguments to `extend_migration` via keyword arguments. Note that at
2809
+ # least one keyword argument is required. To specify no parameters, or to keep all
2810
+ # the default parameter values, pass an empty Hash as a request object (see above).
2811
+ #
2812
+ # @param migrating_vm [::String]
2813
+ # Required. The name of the MigratingVm.
2814
+ #
2815
+ # @yield [response, operation] Access the result along with the RPC operation
2816
+ # @yieldparam response [::Gapic::Operation]
2817
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2818
+ #
2819
+ # @return [::Gapic::Operation]
2820
+ #
2821
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2822
+ #
2823
+ # @example Basic example
2824
+ # require "google/cloud/vm_migration/v1"
2825
+ #
2826
+ # # Create a client object. The client can be reused for multiple calls.
2827
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
2828
+ #
2829
+ # # Create a request. To set request fields, pass in keyword arguments.
2830
+ # request = Google::Cloud::VMMigration::V1::ExtendMigrationRequest.new
2831
+ #
2832
+ # # Call the extend_migration method.
2833
+ # result = client.extend_migration request
2834
+ #
2835
+ # # The returned object is of type Gapic::Operation. You can use it to
2836
+ # # check the status of an operation, cancel it, or wait for results.
2837
+ # # Here is how to wait for a response.
2838
+ # result.wait_until_done! timeout: 60
2839
+ # if result.response?
2840
+ # p result.response
2841
+ # else
2842
+ # puts "No response received."
2843
+ # end
2844
+ #
2845
+ def extend_migration request, options = nil
2846
+ raise ::ArgumentError, "request must be provided" if request.nil?
2847
+
2848
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::ExtendMigrationRequest
2849
+
2850
+ # Converts hash and nil to an options object
2851
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2852
+
2853
+ # Customize the options with defaults
2854
+ metadata = @config.rpcs.extend_migration.metadata.to_h
2855
+
2856
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2857
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2858
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2859
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
2860
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2861
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2862
+
2863
+ header_params = {}
2864
+ if request.migrating_vm
2865
+ header_params["migrating_vm"] = request.migrating_vm
2866
+ end
2867
+
2868
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2869
+ metadata[:"x-goog-request-params"] ||= request_params_header
2870
+
2871
+ options.apply_defaults timeout: @config.rpcs.extend_migration.timeout,
2872
+ metadata: metadata,
2873
+ retry_policy: @config.rpcs.extend_migration.retry_policy
2874
+
2875
+ options.apply_defaults timeout: @config.timeout,
2876
+ metadata: @config.metadata,
2877
+ retry_policy: @config.retry_policy
2878
+
2879
+ @vm_migration_stub.call_rpc :extend_migration, request, options: options do |response, operation|
2880
+ response = ::Gapic::Operation.new response, @operations_client, options: options
2881
+ yield response, operation if block_given?
2882
+ throw :response, response
2883
+ end
2884
+ rescue ::GRPC::BadStatus => e
2885
+ raise ::Google::Cloud::Error.from_error(e)
2886
+ end
2887
+
2701
2888
  ##
2702
2889
  # Initiates a Clone of a specific migrating VM.
2703
2890
  #
@@ -2728,8 +2915,8 @@ module Google
2728
2915
  # the request if it has already been completed. The server will guarantee
2729
2916
  # that for at least 60 minutes since the first request.
2730
2917
  #
2731
- # For example, consider a situation where you make an initial request and t
2732
- # he request times out. If you make the request again with the same request
2918
+ # For example, consider a situation where you make an initial request and
2919
+ # the request times out. If you make the request again with the same request
2733
2920
  # ID, the server can check if original operation with the same request ID
2734
2921
  # was received, and if so, will ignore the second request. This prevents
2735
2922
  # clients from accidentally creating duplicate commitments.
@@ -2905,7 +3092,8 @@ module Google
2905
3092
  end
2906
3093
 
2907
3094
  ##
2908
- # Lists CloneJobs of a given migrating VM.
3095
+ # Lists the CloneJobs of a migrating VM. Only 25 most recent CloneJobs are
3096
+ # listed.
2909
3097
  #
2910
3098
  # @overload list_clone_jobs(request, options = nil)
2911
3099
  # Pass arguments to `list_clone_jobs` via a request object, either of type
@@ -3127,8 +3315,8 @@ module Google
3127
3315
  # the request if it has already been completed. The server will guarantee
3128
3316
  # that for at least 60 minutes since the first request.
3129
3317
  #
3130
- # For example, consider a situation where you make an initial request and t
3131
- # he request times out. If you make the request again with the same request
3318
+ # For example, consider a situation where you make an initial request and
3319
+ # the request times out. If you make the request again with the same request
3132
3320
  # ID, the server can check if original operation with the same request ID
3133
3321
  # was received, and if so, will ignore the second request. This prevents
3134
3322
  # clients from accidentally creating duplicate commitments.
@@ -3304,7 +3492,8 @@ module Google
3304
3492
  end
3305
3493
 
3306
3494
  ##
3307
- # Lists CutoverJobs of a given migrating VM.
3495
+ # Lists the CutoverJobs of a migrating VM. Only 25 most recent CutoverJobs
3496
+ # are listed.
3308
3497
  #
3309
3498
  # @overload list_cutover_jobs(request, options = nil)
3310
3499
  # Pass arguments to `list_cutover_jobs` via a request object, either of type
@@ -3715,8 +3904,8 @@ module Google
3715
3904
  # the request if it has already been completed. The server will guarantee
3716
3905
  # that for at least 60 minutes since the first request.
3717
3906
  #
3718
- # For example, consider a situation where you make an initial request and t
3719
- # he request times out. If you make the request again with the same request
3907
+ # For example, consider a situation where you make an initial request and
3908
+ # the request times out. If you make the request again with the same request
3720
3909
  # ID, the server can check if original operation with the same request ID
3721
3910
  # was received, and if so, will ignore the second request. This prevents
3722
3911
  # clients from accidentally creating duplicate commitments.
@@ -3829,8 +4018,8 @@ module Google
3829
4018
  # the request if it has already been completed. The server will guarantee
3830
4019
  # that for at least 60 minutes since the first request.
3831
4020
  #
3832
- # For example, consider a situation where you make an initial request and t
3833
- # he request times out. If you make the request again with the same request
4021
+ # For example, consider a situation where you make an initial request and
4022
+ # the request times out. If you make the request again with the same request
3834
4023
  # ID, the server can check if original operation with the same request ID
3835
4024
  # was received, and if so, will ignore the second request. This prevents
3836
4025
  # clients from accidentally creating duplicate commitments.
@@ -3937,8 +4126,8 @@ module Google
3937
4126
  # the request if it has already been completed. The server will guarantee
3938
4127
  # that for at least 60 minutes after the first request.
3939
4128
  #
3940
- # For example, consider a situation where you make an initial request and t
3941
- # he request times out. If you make the request again with the same request
4129
+ # For example, consider a situation where you make an initial request and
4130
+ # the request times out. If you make the request again with the same request
3942
4131
  # ID, the server can check if original operation with the same request ID
3943
4132
  # was received, and if so, will ignore the second request. This prevents
3944
4133
  # clients from accidentally creating duplicate commitments.
@@ -4441,8 +4630,8 @@ module Google
4441
4630
  # the request if it has already been completed. The server will guarantee
4442
4631
  # that for at least 60 minutes since the first request.
4443
4632
  #
4444
- # For example, consider a situation where you make an initial request and t
4445
- # he request times out. If you make the request again with the same request
4633
+ # For example, consider a situation where you make an initial request and
4634
+ # the request times out. If you make the request again with the same request
4446
4635
  # ID, the server can check if original operation with the same request ID
4447
4636
  # was received, and if so, will ignore the second request. This prevents
4448
4637
  # clients from accidentally creating duplicate commitments.
@@ -4558,8 +4747,8 @@ module Google
4558
4747
  # the request if it has already been completed. The server will guarantee
4559
4748
  # that for at least 60 minutes since the first request.
4560
4749
  #
4561
- # For example, consider a situation where you make an initial request and t
4562
- # he request times out. If you make the request again with the same request
4750
+ # For example, consider a situation where you make an initial request and
4751
+ # the request times out. If you make the request again with the same request
4563
4752
  # ID, the server can check if original operation with the same request ID
4564
4753
  # was received, and if so, will ignore the second request. This prevents
4565
4754
  # clients from accidentally creating duplicate commitments.
@@ -4669,8 +4858,8 @@ module Google
4669
4858
  # the request if it has already been completed. The server will guarantee
4670
4859
  # that for at least 60 minutes after the first request.
4671
4860
  #
4672
- # For example, consider a situation where you make an initial request and t
4673
- # he request times out. If you make the request again with the same request
4861
+ # For example, consider a situation where you make an initial request and
4862
+ # the request times out. If you make the request again with the same request
4674
4863
  # ID, the server can check if original operation with the same request ID
4675
4864
  # was received, and if so, will ignore the second request. This prevents
4676
4865
  # clients from accidentally creating duplicate commitments.
@@ -4943,52 +5132,1461 @@ module Google
4943
5132
  end
4944
5133
 
4945
5134
  ##
4946
- # Configuration class for the VmMigration API.
5135
+ # Lists ImageImports in a given project.
4947
5136
  #
4948
- # This class represents the configuration for VmMigration,
4949
- # providing control over timeouts, retry behavior, logging, transport
4950
- # parameters, and other low-level controls. Certain parameters can also be
4951
- # applied individually to specific RPCs. See
4952
- # {::Google::Cloud::VMMigration::V1::VMMigration::Client::Configuration::Rpcs}
4953
- # for a list of RPCs that can be configured independently.
5137
+ # @overload list_image_imports(request, options = nil)
5138
+ # Pass arguments to `list_image_imports` via a request object, either of type
5139
+ # {::Google::Cloud::VMMigration::V1::ListImageImportsRequest} or an equivalent Hash.
4954
5140
  #
4955
- # Configuration can be applied globally to all clients, or to a single client
4956
- # on construction.
5141
+ # @param request [::Google::Cloud::VMMigration::V1::ListImageImportsRequest, ::Hash]
5142
+ # A request object representing the call parameters. Required. To specify no
5143
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5144
+ # @param options [::Gapic::CallOptions, ::Hash]
5145
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4957
5146
  #
4958
- # @example
5147
+ # @overload list_image_imports(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
5148
+ # Pass arguments to `list_image_imports` via keyword arguments. Note that at
5149
+ # least one keyword argument is required. To specify no parameters, or to keep all
5150
+ # the default parameter values, pass an empty Hash as a request object (see above).
4959
5151
  #
4960
- # # Modify the global config, setting the timeout for
4961
- # # list_sources to 20 seconds,
4962
- # # and all remaining timeouts to 10 seconds.
4963
- # ::Google::Cloud::VMMigration::V1::VMMigration::Client.configure do |config|
4964
- # config.timeout = 10.0
4965
- # config.rpcs.list_sources.timeout = 20.0
4966
- # end
5152
+ # @param parent [::String]
5153
+ # Required. The parent, which owns this collection of targets.
5154
+ # @param page_size [::Integer]
5155
+ # Optional. The maximum number of targets to return. The service may return
5156
+ # fewer than this value. If unspecified, at most 500 targets will be
5157
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
5158
+ # 1000.
5159
+ # @param page_token [::String]
5160
+ # Optional. A page token, received from a previous `ListImageImports` call.
5161
+ # Provide this to retrieve the subsequent page.
4967
5162
  #
4968
- # # Apply the above configuration only to a new client.
4969
- # client = ::Google::Cloud::VMMigration::V1::VMMigration::Client.new do |config|
4970
- # config.timeout = 10.0
4971
- # config.rpcs.list_sources.timeout = 20.0
4972
- # end
5163
+ # When paginating, all other parameters provided to `ListImageImports` must
5164
+ # match the call that provided the page token.
5165
+ # @param filter [::String]
5166
+ # Optional. The filter request (according to <a
5167
+ # href="https://google.aip.dev/160" target="_blank">AIP-160</a>).
5168
+ # @param order_by [::String]
5169
+ # Optional. The order by fields for the result (according to <a
5170
+ # href="https://google.aip.dev/132#ordering" target="_blank">AIP-132</a>).
5171
+ # Currently ordering is only possible by "name" field.
4973
5172
  #
4974
- # @!attribute [rw] endpoint
4975
- # A custom service endpoint, as a hostname or hostname:port. The default is
4976
- # nil, indicating to use the default endpoint in the current universe domain.
4977
- # @return [::String,nil]
4978
- # @!attribute [rw] credentials
4979
- # Credentials to send with calls. You may provide any of the following types:
4980
- # * (`String`) The path to a service account key file in JSON format
4981
- # * (`Hash`) A service account key as a Hash
4982
- # * (`Google::Auth::Credentials`) A googleauth credentials object
4983
- # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
4984
- # * (`Signet::OAuth2::Client`) A signet oauth2 client object
4985
- # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
4986
- # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
4987
- # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
4988
- # * (`nil`) indicating no credentials
5173
+ # @yield [response, operation] Access the result along with the RPC operation
5174
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::ImageImport>]
5175
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
4989
5176
  #
4990
- # Warning: If you accept a credential configuration (JSON file or Hash) from an
4991
- # external source for authentication to Google Cloud, you must validate it before
5177
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::ImageImport>]
5178
+ #
5179
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5180
+ #
5181
+ # @example Basic example
5182
+ # require "google/cloud/vm_migration/v1"
5183
+ #
5184
+ # # Create a client object. The client can be reused for multiple calls.
5185
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
5186
+ #
5187
+ # # Create a request. To set request fields, pass in keyword arguments.
5188
+ # request = Google::Cloud::VMMigration::V1::ListImageImportsRequest.new
5189
+ #
5190
+ # # Call the list_image_imports method.
5191
+ # result = client.list_image_imports request
5192
+ #
5193
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
5194
+ # # over elements, and API calls will be issued to fetch pages as needed.
5195
+ # result.each do |item|
5196
+ # # Each element is of type ::Google::Cloud::VMMigration::V1::ImageImport.
5197
+ # p item
5198
+ # end
5199
+ #
5200
+ def list_image_imports request, options = nil
5201
+ raise ::ArgumentError, "request must be provided" if request.nil?
5202
+
5203
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::ListImageImportsRequest
5204
+
5205
+ # Converts hash and nil to an options object
5206
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5207
+
5208
+ # Customize the options with defaults
5209
+ metadata = @config.rpcs.list_image_imports.metadata.to_h
5210
+
5211
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5212
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5213
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5214
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
5215
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5216
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5217
+
5218
+ header_params = {}
5219
+ if request.parent
5220
+ header_params["parent"] = request.parent
5221
+ end
5222
+
5223
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5224
+ metadata[:"x-goog-request-params"] ||= request_params_header
5225
+
5226
+ options.apply_defaults timeout: @config.rpcs.list_image_imports.timeout,
5227
+ metadata: metadata,
5228
+ retry_policy: @config.rpcs.list_image_imports.retry_policy
5229
+
5230
+ options.apply_defaults timeout: @config.timeout,
5231
+ metadata: @config.metadata,
5232
+ retry_policy: @config.retry_policy
5233
+
5234
+ @vm_migration_stub.call_rpc :list_image_imports, request, options: options do |response, operation|
5235
+ response = ::Gapic::PagedEnumerable.new @vm_migration_stub, :list_image_imports, request, response, operation, options
5236
+ yield response, operation if block_given?
5237
+ throw :response, response
5238
+ end
5239
+ rescue ::GRPC::BadStatus => e
5240
+ raise ::Google::Cloud::Error.from_error(e)
5241
+ end
5242
+
5243
+ ##
5244
+ # Gets details of a single ImageImport.
5245
+ #
5246
+ # @overload get_image_import(request, options = nil)
5247
+ # Pass arguments to `get_image_import` via a request object, either of type
5248
+ # {::Google::Cloud::VMMigration::V1::GetImageImportRequest} or an equivalent Hash.
5249
+ #
5250
+ # @param request [::Google::Cloud::VMMigration::V1::GetImageImportRequest, ::Hash]
5251
+ # A request object representing the call parameters. Required. To specify no
5252
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5253
+ # @param options [::Gapic::CallOptions, ::Hash]
5254
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5255
+ #
5256
+ # @overload get_image_import(name: nil)
5257
+ # Pass arguments to `get_image_import` via keyword arguments. Note that at
5258
+ # least one keyword argument is required. To specify no parameters, or to keep all
5259
+ # the default parameter values, pass an empty Hash as a request object (see above).
5260
+ #
5261
+ # @param name [::String]
5262
+ # Required. The ImageImport name.
5263
+ #
5264
+ # @yield [response, operation] Access the result along with the RPC operation
5265
+ # @yieldparam response [::Google::Cloud::VMMigration::V1::ImageImport]
5266
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5267
+ #
5268
+ # @return [::Google::Cloud::VMMigration::V1::ImageImport]
5269
+ #
5270
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5271
+ #
5272
+ # @example Basic example
5273
+ # require "google/cloud/vm_migration/v1"
5274
+ #
5275
+ # # Create a client object. The client can be reused for multiple calls.
5276
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
5277
+ #
5278
+ # # Create a request. To set request fields, pass in keyword arguments.
5279
+ # request = Google::Cloud::VMMigration::V1::GetImageImportRequest.new
5280
+ #
5281
+ # # Call the get_image_import method.
5282
+ # result = client.get_image_import request
5283
+ #
5284
+ # # The returned object is of type Google::Cloud::VMMigration::V1::ImageImport.
5285
+ # p result
5286
+ #
5287
+ def get_image_import request, options = nil
5288
+ raise ::ArgumentError, "request must be provided" if request.nil?
5289
+
5290
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::GetImageImportRequest
5291
+
5292
+ # Converts hash and nil to an options object
5293
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5294
+
5295
+ # Customize the options with defaults
5296
+ metadata = @config.rpcs.get_image_import.metadata.to_h
5297
+
5298
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5299
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5300
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5301
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
5302
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5303
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5304
+
5305
+ header_params = {}
5306
+ if request.name
5307
+ header_params["name"] = request.name
5308
+ end
5309
+
5310
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5311
+ metadata[:"x-goog-request-params"] ||= request_params_header
5312
+
5313
+ options.apply_defaults timeout: @config.rpcs.get_image_import.timeout,
5314
+ metadata: metadata,
5315
+ retry_policy: @config.rpcs.get_image_import.retry_policy
5316
+
5317
+ options.apply_defaults timeout: @config.timeout,
5318
+ metadata: @config.metadata,
5319
+ retry_policy: @config.retry_policy
5320
+
5321
+ @vm_migration_stub.call_rpc :get_image_import, request, options: options do |response, operation|
5322
+ yield response, operation if block_given?
5323
+ end
5324
+ rescue ::GRPC::BadStatus => e
5325
+ raise ::Google::Cloud::Error.from_error(e)
5326
+ end
5327
+
5328
+ ##
5329
+ # Creates a new ImageImport in a given project.
5330
+ #
5331
+ # @overload create_image_import(request, options = nil)
5332
+ # Pass arguments to `create_image_import` via a request object, either of type
5333
+ # {::Google::Cloud::VMMigration::V1::CreateImageImportRequest} or an equivalent Hash.
5334
+ #
5335
+ # @param request [::Google::Cloud::VMMigration::V1::CreateImageImportRequest, ::Hash]
5336
+ # A request object representing the call parameters. Required. To specify no
5337
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5338
+ # @param options [::Gapic::CallOptions, ::Hash]
5339
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5340
+ #
5341
+ # @overload create_image_import(parent: nil, image_import_id: nil, image_import: nil, request_id: nil)
5342
+ # Pass arguments to `create_image_import` via keyword arguments. Note that at
5343
+ # least one keyword argument is required. To specify no parameters, or to keep all
5344
+ # the default parameter values, pass an empty Hash as a request object (see above).
5345
+ #
5346
+ # @param parent [::String]
5347
+ # Required. The ImageImport's parent.
5348
+ # @param image_import_id [::String]
5349
+ # Required. The image import identifier.
5350
+ # This value maximum length is 63 characters, and valid characters are
5351
+ # /[a-z][0-9]-/. It must start with an english letter and must not end with a
5352
+ # hyphen.
5353
+ # @param image_import [::Google::Cloud::VMMigration::V1::ImageImport, ::Hash]
5354
+ # Required. The create request body.
5355
+ # @param request_id [::String]
5356
+ # Optional. A request ID to identify requests. Specify a unique request ID
5357
+ # so that if you must retry your request, the server will know to ignore
5358
+ # the request if it has already been completed. The server will guarantee
5359
+ # that for at least 60 minutes since the first request.
5360
+ #
5361
+ # For example, consider a situation where you make an initial request and
5362
+ # the request times out. If you make the request again with the same request
5363
+ # ID, the server can check if original operation with the same request ID
5364
+ # was received, and if so, will ignore the second request. This prevents
5365
+ # clients from accidentally creating duplicate commitments.
5366
+ #
5367
+ # The request ID must be a valid UUID with the exception that zero UUID is
5368
+ # not supported (00000000-0000-0000-0000-000000000000).
5369
+ #
5370
+ # @yield [response, operation] Access the result along with the RPC operation
5371
+ # @yieldparam response [::Gapic::Operation]
5372
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5373
+ #
5374
+ # @return [::Gapic::Operation]
5375
+ #
5376
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5377
+ #
5378
+ # @example Basic example
5379
+ # require "google/cloud/vm_migration/v1"
5380
+ #
5381
+ # # Create a client object. The client can be reused for multiple calls.
5382
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
5383
+ #
5384
+ # # Create a request. To set request fields, pass in keyword arguments.
5385
+ # request = Google::Cloud::VMMigration::V1::CreateImageImportRequest.new
5386
+ #
5387
+ # # Call the create_image_import method.
5388
+ # result = client.create_image_import request
5389
+ #
5390
+ # # The returned object is of type Gapic::Operation. You can use it to
5391
+ # # check the status of an operation, cancel it, or wait for results.
5392
+ # # Here is how to wait for a response.
5393
+ # result.wait_until_done! timeout: 60
5394
+ # if result.response?
5395
+ # p result.response
5396
+ # else
5397
+ # puts "No response received."
5398
+ # end
5399
+ #
5400
+ def create_image_import request, options = nil
5401
+ raise ::ArgumentError, "request must be provided" if request.nil?
5402
+
5403
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::CreateImageImportRequest
5404
+
5405
+ # Converts hash and nil to an options object
5406
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5407
+
5408
+ # Customize the options with defaults
5409
+ metadata = @config.rpcs.create_image_import.metadata.to_h
5410
+
5411
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5412
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5413
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5414
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
5415
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5416
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5417
+
5418
+ header_params = {}
5419
+ if request.parent
5420
+ header_params["parent"] = request.parent
5421
+ end
5422
+
5423
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5424
+ metadata[:"x-goog-request-params"] ||= request_params_header
5425
+
5426
+ options.apply_defaults timeout: @config.rpcs.create_image_import.timeout,
5427
+ metadata: metadata,
5428
+ retry_policy: @config.rpcs.create_image_import.retry_policy
5429
+
5430
+ options.apply_defaults timeout: @config.timeout,
5431
+ metadata: @config.metadata,
5432
+ retry_policy: @config.retry_policy
5433
+
5434
+ @vm_migration_stub.call_rpc :create_image_import, request, options: options do |response, operation|
5435
+ response = ::Gapic::Operation.new response, @operations_client, options: options
5436
+ yield response, operation if block_given?
5437
+ throw :response, response
5438
+ end
5439
+ rescue ::GRPC::BadStatus => e
5440
+ raise ::Google::Cloud::Error.from_error(e)
5441
+ end
5442
+
5443
+ ##
5444
+ # Deletes a single ImageImport.
5445
+ #
5446
+ # @overload delete_image_import(request, options = nil)
5447
+ # Pass arguments to `delete_image_import` via a request object, either of type
5448
+ # {::Google::Cloud::VMMigration::V1::DeleteImageImportRequest} or an equivalent Hash.
5449
+ #
5450
+ # @param request [::Google::Cloud::VMMigration::V1::DeleteImageImportRequest, ::Hash]
5451
+ # A request object representing the call parameters. Required. To specify no
5452
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5453
+ # @param options [::Gapic::CallOptions, ::Hash]
5454
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5455
+ #
5456
+ # @overload delete_image_import(name: nil, request_id: nil)
5457
+ # Pass arguments to `delete_image_import` via keyword arguments. Note that at
5458
+ # least one keyword argument is required. To specify no parameters, or to keep all
5459
+ # the default parameter values, pass an empty Hash as a request object (see above).
5460
+ #
5461
+ # @param name [::String]
5462
+ # Required. The ImageImport name.
5463
+ # @param request_id [::String]
5464
+ # Optional. A request ID to identify requests. Specify a unique request ID
5465
+ # so that if you must retry your request, the server will know to ignore
5466
+ # the request if it has already been completed. The server will guarantee
5467
+ # that for at least 60 minutes after the first request.
5468
+ #
5469
+ # For example, consider a situation where you make an initial request and t
5470
+ # he request times out. If you make the request again with the same request
5471
+ # ID, the server can check if original operation with the same request ID
5472
+ # was received, and if so, will ignore the second request. This prevents
5473
+ # clients from accidentally creating duplicate commitments.
5474
+ #
5475
+ # The request ID must be a valid UUID with the exception that zero UUID is
5476
+ # not supported (00000000-0000-0000-0000-000000000000).
5477
+ #
5478
+ # @yield [response, operation] Access the result along with the RPC operation
5479
+ # @yieldparam response [::Gapic::Operation]
5480
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5481
+ #
5482
+ # @return [::Gapic::Operation]
5483
+ #
5484
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5485
+ #
5486
+ # @example Basic example
5487
+ # require "google/cloud/vm_migration/v1"
5488
+ #
5489
+ # # Create a client object. The client can be reused for multiple calls.
5490
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
5491
+ #
5492
+ # # Create a request. To set request fields, pass in keyword arguments.
5493
+ # request = Google::Cloud::VMMigration::V1::DeleteImageImportRequest.new
5494
+ #
5495
+ # # Call the delete_image_import method.
5496
+ # result = client.delete_image_import request
5497
+ #
5498
+ # # The returned object is of type Gapic::Operation. You can use it to
5499
+ # # check the status of an operation, cancel it, or wait for results.
5500
+ # # Here is how to wait for a response.
5501
+ # result.wait_until_done! timeout: 60
5502
+ # if result.response?
5503
+ # p result.response
5504
+ # else
5505
+ # puts "No response received."
5506
+ # end
5507
+ #
5508
+ def delete_image_import request, options = nil
5509
+ raise ::ArgumentError, "request must be provided" if request.nil?
5510
+
5511
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::DeleteImageImportRequest
5512
+
5513
+ # Converts hash and nil to an options object
5514
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5515
+
5516
+ # Customize the options with defaults
5517
+ metadata = @config.rpcs.delete_image_import.metadata.to_h
5518
+
5519
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5520
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5521
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5522
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
5523
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5524
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5525
+
5526
+ header_params = {}
5527
+ if request.name
5528
+ header_params["name"] = request.name
5529
+ end
5530
+
5531
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5532
+ metadata[:"x-goog-request-params"] ||= request_params_header
5533
+
5534
+ options.apply_defaults timeout: @config.rpcs.delete_image_import.timeout,
5535
+ metadata: metadata,
5536
+ retry_policy: @config.rpcs.delete_image_import.retry_policy
5537
+
5538
+ options.apply_defaults timeout: @config.timeout,
5539
+ metadata: @config.metadata,
5540
+ retry_policy: @config.retry_policy
5541
+
5542
+ @vm_migration_stub.call_rpc :delete_image_import, request, options: options do |response, operation|
5543
+ response = ::Gapic::Operation.new response, @operations_client, options: options
5544
+ yield response, operation if block_given?
5545
+ throw :response, response
5546
+ end
5547
+ rescue ::GRPC::BadStatus => e
5548
+ raise ::Google::Cloud::Error.from_error(e)
5549
+ end
5550
+
5551
+ ##
5552
+ # Lists ImageImportJobs in a given project.
5553
+ #
5554
+ # @overload list_image_import_jobs(request, options = nil)
5555
+ # Pass arguments to `list_image_import_jobs` via a request object, either of type
5556
+ # {::Google::Cloud::VMMigration::V1::ListImageImportJobsRequest} or an equivalent Hash.
5557
+ #
5558
+ # @param request [::Google::Cloud::VMMigration::V1::ListImageImportJobsRequest, ::Hash]
5559
+ # A request object representing the call parameters. Required. To specify no
5560
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5561
+ # @param options [::Gapic::CallOptions, ::Hash]
5562
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5563
+ #
5564
+ # @overload list_image_import_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
5565
+ # Pass arguments to `list_image_import_jobs` via keyword arguments. Note that at
5566
+ # least one keyword argument is required. To specify no parameters, or to keep all
5567
+ # the default parameter values, pass an empty Hash as a request object (see above).
5568
+ #
5569
+ # @param parent [::String]
5570
+ # Required. The parent, which owns this collection of targets.
5571
+ # @param page_size [::Integer]
5572
+ # Optional. The maximum number of targets to return. The service may return
5573
+ # fewer than this value. If unspecified, at most 500 targets will be
5574
+ # returned. The maximum value is 1000; values above 1000 will be coerced to
5575
+ # 1000.
5576
+ # @param page_token [::String]
5577
+ # Optional. A page token, received from a previous `ListImageImportJobs`
5578
+ # call. Provide this to retrieve the subsequent page.
5579
+ #
5580
+ # When paginating, all other parameters provided to `ListImageImportJobs`
5581
+ # must match the call that provided the page token.
5582
+ # @param filter [::String]
5583
+ # Optional. The filter request (according to <a
5584
+ # href="https://google.aip.dev/160" target="_blank">AIP-160</a>).
5585
+ # @param order_by [::String]
5586
+ # Optional. The order by fields for the result (according to <a
5587
+ # href="https://google.aip.dev/132#ordering" target="_blank">AIP-132</a>).
5588
+ # Currently ordering is only possible by "name" field.
5589
+ #
5590
+ # @yield [response, operation] Access the result along with the RPC operation
5591
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::ImageImportJob>]
5592
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5593
+ #
5594
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::ImageImportJob>]
5595
+ #
5596
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5597
+ #
5598
+ # @example Basic example
5599
+ # require "google/cloud/vm_migration/v1"
5600
+ #
5601
+ # # Create a client object. The client can be reused for multiple calls.
5602
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
5603
+ #
5604
+ # # Create a request. To set request fields, pass in keyword arguments.
5605
+ # request = Google::Cloud::VMMigration::V1::ListImageImportJobsRequest.new
5606
+ #
5607
+ # # Call the list_image_import_jobs method.
5608
+ # result = client.list_image_import_jobs request
5609
+ #
5610
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
5611
+ # # over elements, and API calls will be issued to fetch pages as needed.
5612
+ # result.each do |item|
5613
+ # # Each element is of type ::Google::Cloud::VMMigration::V1::ImageImportJob.
5614
+ # p item
5615
+ # end
5616
+ #
5617
+ def list_image_import_jobs request, options = nil
5618
+ raise ::ArgumentError, "request must be provided" if request.nil?
5619
+
5620
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::ListImageImportJobsRequest
5621
+
5622
+ # Converts hash and nil to an options object
5623
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5624
+
5625
+ # Customize the options with defaults
5626
+ metadata = @config.rpcs.list_image_import_jobs.metadata.to_h
5627
+
5628
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5629
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5630
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5631
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
5632
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5633
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5634
+
5635
+ header_params = {}
5636
+ if request.parent
5637
+ header_params["parent"] = request.parent
5638
+ end
5639
+
5640
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5641
+ metadata[:"x-goog-request-params"] ||= request_params_header
5642
+
5643
+ options.apply_defaults timeout: @config.rpcs.list_image_import_jobs.timeout,
5644
+ metadata: metadata,
5645
+ retry_policy: @config.rpcs.list_image_import_jobs.retry_policy
5646
+
5647
+ options.apply_defaults timeout: @config.timeout,
5648
+ metadata: @config.metadata,
5649
+ retry_policy: @config.retry_policy
5650
+
5651
+ @vm_migration_stub.call_rpc :list_image_import_jobs, request, options: options do |response, operation|
5652
+ response = ::Gapic::PagedEnumerable.new @vm_migration_stub, :list_image_import_jobs, request, response, operation, options
5653
+ yield response, operation if block_given?
5654
+ throw :response, response
5655
+ end
5656
+ rescue ::GRPC::BadStatus => e
5657
+ raise ::Google::Cloud::Error.from_error(e)
5658
+ end
5659
+
5660
+ ##
5661
+ # Gets details of a single ImageImportJob.
5662
+ #
5663
+ # @overload get_image_import_job(request, options = nil)
5664
+ # Pass arguments to `get_image_import_job` via a request object, either of type
5665
+ # {::Google::Cloud::VMMigration::V1::GetImageImportJobRequest} or an equivalent Hash.
5666
+ #
5667
+ # @param request [::Google::Cloud::VMMigration::V1::GetImageImportJobRequest, ::Hash]
5668
+ # A request object representing the call parameters. Required. To specify no
5669
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5670
+ # @param options [::Gapic::CallOptions, ::Hash]
5671
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5672
+ #
5673
+ # @overload get_image_import_job(name: nil)
5674
+ # Pass arguments to `get_image_import_job` via keyword arguments. Note that at
5675
+ # least one keyword argument is required. To specify no parameters, or to keep all
5676
+ # the default parameter values, pass an empty Hash as a request object (see above).
5677
+ #
5678
+ # @param name [::String]
5679
+ # Required. The ImageImportJob name.
5680
+ #
5681
+ # @yield [response, operation] Access the result along with the RPC operation
5682
+ # @yieldparam response [::Google::Cloud::VMMigration::V1::ImageImportJob]
5683
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5684
+ #
5685
+ # @return [::Google::Cloud::VMMigration::V1::ImageImportJob]
5686
+ #
5687
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5688
+ #
5689
+ # @example Basic example
5690
+ # require "google/cloud/vm_migration/v1"
5691
+ #
5692
+ # # Create a client object. The client can be reused for multiple calls.
5693
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
5694
+ #
5695
+ # # Create a request. To set request fields, pass in keyword arguments.
5696
+ # request = Google::Cloud::VMMigration::V1::GetImageImportJobRequest.new
5697
+ #
5698
+ # # Call the get_image_import_job method.
5699
+ # result = client.get_image_import_job request
5700
+ #
5701
+ # # The returned object is of type Google::Cloud::VMMigration::V1::ImageImportJob.
5702
+ # p result
5703
+ #
5704
+ def get_image_import_job request, options = nil
5705
+ raise ::ArgumentError, "request must be provided" if request.nil?
5706
+
5707
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::GetImageImportJobRequest
5708
+
5709
+ # Converts hash and nil to an options object
5710
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5711
+
5712
+ # Customize the options with defaults
5713
+ metadata = @config.rpcs.get_image_import_job.metadata.to_h
5714
+
5715
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5716
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5717
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5718
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
5719
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5720
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5721
+
5722
+ header_params = {}
5723
+ if request.name
5724
+ header_params["name"] = request.name
5725
+ end
5726
+
5727
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5728
+ metadata[:"x-goog-request-params"] ||= request_params_header
5729
+
5730
+ options.apply_defaults timeout: @config.rpcs.get_image_import_job.timeout,
5731
+ metadata: metadata,
5732
+ retry_policy: @config.rpcs.get_image_import_job.retry_policy
5733
+
5734
+ options.apply_defaults timeout: @config.timeout,
5735
+ metadata: @config.metadata,
5736
+ retry_policy: @config.retry_policy
5737
+
5738
+ @vm_migration_stub.call_rpc :get_image_import_job, request, options: options do |response, operation|
5739
+ yield response, operation if block_given?
5740
+ end
5741
+ rescue ::GRPC::BadStatus => e
5742
+ raise ::Google::Cloud::Error.from_error(e)
5743
+ end
5744
+
5745
+ ##
5746
+ # Initiates the cancellation of a running clone job.
5747
+ #
5748
+ # @overload cancel_image_import_job(request, options = nil)
5749
+ # Pass arguments to `cancel_image_import_job` via a request object, either of type
5750
+ # {::Google::Cloud::VMMigration::V1::CancelImageImportJobRequest} or an equivalent Hash.
5751
+ #
5752
+ # @param request [::Google::Cloud::VMMigration::V1::CancelImageImportJobRequest, ::Hash]
5753
+ # A request object representing the call parameters. Required. To specify no
5754
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5755
+ # @param options [::Gapic::CallOptions, ::Hash]
5756
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5757
+ #
5758
+ # @overload cancel_image_import_job(name: nil)
5759
+ # Pass arguments to `cancel_image_import_job` via keyword arguments. Note that at
5760
+ # least one keyword argument is required. To specify no parameters, or to keep all
5761
+ # the default parameter values, pass an empty Hash as a request object (see above).
5762
+ #
5763
+ # @param name [::String]
5764
+ # Required. The image import job id.
5765
+ #
5766
+ # @yield [response, operation] Access the result along with the RPC operation
5767
+ # @yieldparam response [::Gapic::Operation]
5768
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5769
+ #
5770
+ # @return [::Gapic::Operation]
5771
+ #
5772
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5773
+ #
5774
+ # @example Basic example
5775
+ # require "google/cloud/vm_migration/v1"
5776
+ #
5777
+ # # Create a client object. The client can be reused for multiple calls.
5778
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
5779
+ #
5780
+ # # Create a request. To set request fields, pass in keyword arguments.
5781
+ # request = Google::Cloud::VMMigration::V1::CancelImageImportJobRequest.new
5782
+ #
5783
+ # # Call the cancel_image_import_job method.
5784
+ # result = client.cancel_image_import_job request
5785
+ #
5786
+ # # The returned object is of type Gapic::Operation. You can use it to
5787
+ # # check the status of an operation, cancel it, or wait for results.
5788
+ # # Here is how to wait for a response.
5789
+ # result.wait_until_done! timeout: 60
5790
+ # if result.response?
5791
+ # p result.response
5792
+ # else
5793
+ # puts "No response received."
5794
+ # end
5795
+ #
5796
+ def cancel_image_import_job request, options = nil
5797
+ raise ::ArgumentError, "request must be provided" if request.nil?
5798
+
5799
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::CancelImageImportJobRequest
5800
+
5801
+ # Converts hash and nil to an options object
5802
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5803
+
5804
+ # Customize the options with defaults
5805
+ metadata = @config.rpcs.cancel_image_import_job.metadata.to_h
5806
+
5807
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5808
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5809
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5810
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
5811
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5812
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5813
+
5814
+ header_params = {}
5815
+ if request.name
5816
+ header_params["name"] = request.name
5817
+ end
5818
+
5819
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5820
+ metadata[:"x-goog-request-params"] ||= request_params_header
5821
+
5822
+ options.apply_defaults timeout: @config.rpcs.cancel_image_import_job.timeout,
5823
+ metadata: metadata,
5824
+ retry_policy: @config.rpcs.cancel_image_import_job.retry_policy
5825
+
5826
+ options.apply_defaults timeout: @config.timeout,
5827
+ metadata: @config.metadata,
5828
+ retry_policy: @config.retry_policy
5829
+
5830
+ @vm_migration_stub.call_rpc :cancel_image_import_job, request, options: options do |response, operation|
5831
+ response = ::Gapic::Operation.new response, @operations_client, options: options
5832
+ yield response, operation if block_given?
5833
+ throw :response, response
5834
+ end
5835
+ rescue ::GRPC::BadStatus => e
5836
+ raise ::Google::Cloud::Error.from_error(e)
5837
+ end
5838
+
5839
+ ##
5840
+ # Creates a new disk migration job in a given Source.
5841
+ #
5842
+ # @overload create_disk_migration_job(request, options = nil)
5843
+ # Pass arguments to `create_disk_migration_job` via a request object, either of type
5844
+ # {::Google::Cloud::VMMigration::V1::CreateDiskMigrationJobRequest} or an equivalent Hash.
5845
+ #
5846
+ # @param request [::Google::Cloud::VMMigration::V1::CreateDiskMigrationJobRequest, ::Hash]
5847
+ # A request object representing the call parameters. Required. To specify no
5848
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5849
+ # @param options [::Gapic::CallOptions, ::Hash]
5850
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5851
+ #
5852
+ # @overload create_disk_migration_job(parent: nil, disk_migration_job_id: nil, disk_migration_job: nil, request_id: nil)
5853
+ # Pass arguments to `create_disk_migration_job` via keyword arguments. Note that at
5854
+ # least one keyword argument is required. To specify no parameters, or to keep all
5855
+ # the default parameter values, pass an empty Hash as a request object (see above).
5856
+ #
5857
+ # @param parent [::String]
5858
+ # Required. The DiskMigrationJob's parent.
5859
+ # @param disk_migration_job_id [::String]
5860
+ # Required. The DiskMigrationJob identifier.
5861
+ # The maximum length of this value is 63 characters.
5862
+ # Valid characters are lower case Latin letters, digits and hyphen.
5863
+ # It must start with a Latin letter and must not end with a hyphen.
5864
+ # @param disk_migration_job [::Google::Cloud::VMMigration::V1::DiskMigrationJob, ::Hash]
5865
+ # Required. The create request body.
5866
+ # @param request_id [::String]
5867
+ # Optional. A request ID to identify requests. Specify a unique request ID
5868
+ # so that if you must retry your request, the server will know to ignore
5869
+ # the request if it has already been completed. The server will guarantee
5870
+ # that for at least 60 minutes since the first request.
5871
+ #
5872
+ # For example, consider a situation where you make an initial request and
5873
+ # the request timed out. If you make the request again with the same request
5874
+ # ID, the server can check if original operation with the same request ID
5875
+ # was received, and if so, will ignore the second request. This prevents
5876
+ # clients from accidentally creating duplicate commitments.
5877
+ #
5878
+ # The request ID must be a valid UUID with the exception that zero UUID is
5879
+ # not supported (00000000-0000-0000-0000-000000000000).
5880
+ #
5881
+ # @yield [response, operation] Access the result along with the RPC operation
5882
+ # @yieldparam response [::Gapic::Operation]
5883
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5884
+ #
5885
+ # @return [::Gapic::Operation]
5886
+ #
5887
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5888
+ #
5889
+ # @example Basic example
5890
+ # require "google/cloud/vm_migration/v1"
5891
+ #
5892
+ # # Create a client object. The client can be reused for multiple calls.
5893
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
5894
+ #
5895
+ # # Create a request. To set request fields, pass in keyword arguments.
5896
+ # request = Google::Cloud::VMMigration::V1::CreateDiskMigrationJobRequest.new
5897
+ #
5898
+ # # Call the create_disk_migration_job method.
5899
+ # result = client.create_disk_migration_job request
5900
+ #
5901
+ # # The returned object is of type Gapic::Operation. You can use it to
5902
+ # # check the status of an operation, cancel it, or wait for results.
5903
+ # # Here is how to wait for a response.
5904
+ # result.wait_until_done! timeout: 60
5905
+ # if result.response?
5906
+ # p result.response
5907
+ # else
5908
+ # puts "No response received."
5909
+ # end
5910
+ #
5911
+ def create_disk_migration_job request, options = nil
5912
+ raise ::ArgumentError, "request must be provided" if request.nil?
5913
+
5914
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::CreateDiskMigrationJobRequest
5915
+
5916
+ # Converts hash and nil to an options object
5917
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5918
+
5919
+ # Customize the options with defaults
5920
+ metadata = @config.rpcs.create_disk_migration_job.metadata.to_h
5921
+
5922
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
5923
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5924
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5925
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
5926
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
5927
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5928
+
5929
+ header_params = {}
5930
+ if request.parent
5931
+ header_params["parent"] = request.parent
5932
+ end
5933
+
5934
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5935
+ metadata[:"x-goog-request-params"] ||= request_params_header
5936
+
5937
+ options.apply_defaults timeout: @config.rpcs.create_disk_migration_job.timeout,
5938
+ metadata: metadata,
5939
+ retry_policy: @config.rpcs.create_disk_migration_job.retry_policy
5940
+
5941
+ options.apply_defaults timeout: @config.timeout,
5942
+ metadata: @config.metadata,
5943
+ retry_policy: @config.retry_policy
5944
+
5945
+ @vm_migration_stub.call_rpc :create_disk_migration_job, request, options: options do |response, operation|
5946
+ response = ::Gapic::Operation.new response, @operations_client, options: options
5947
+ yield response, operation if block_given?
5948
+ throw :response, response
5949
+ end
5950
+ rescue ::GRPC::BadStatus => e
5951
+ raise ::Google::Cloud::Error.from_error(e)
5952
+ end
5953
+
5954
+ ##
5955
+ # Lists DiskMigrationJobs in a given Source.
5956
+ #
5957
+ # @overload list_disk_migration_jobs(request, options = nil)
5958
+ # Pass arguments to `list_disk_migration_jobs` via a request object, either of type
5959
+ # {::Google::Cloud::VMMigration::V1::ListDiskMigrationJobsRequest} or an equivalent Hash.
5960
+ #
5961
+ # @param request [::Google::Cloud::VMMigration::V1::ListDiskMigrationJobsRequest, ::Hash]
5962
+ # A request object representing the call parameters. Required. To specify no
5963
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5964
+ # @param options [::Gapic::CallOptions, ::Hash]
5965
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5966
+ #
5967
+ # @overload list_disk_migration_jobs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
5968
+ # Pass arguments to `list_disk_migration_jobs` via keyword arguments. Note that at
5969
+ # least one keyword argument is required. To specify no parameters, or to keep all
5970
+ # the default parameter values, pass an empty Hash as a request object (see above).
5971
+ #
5972
+ # @param parent [::String]
5973
+ # Required. The parent, which owns this collection of DiskMigrationJobs.
5974
+ # @param page_size [::Integer]
5975
+ # Optional. The maximum number of disk migration jobs to return. The service
5976
+ # may return fewer than this value. If unspecified, at most 500
5977
+ # disk migration jobs will be returned.
5978
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
5979
+ # @param page_token [::String]
5980
+ # Optional. A page token, received from a previous `ListDiskMigrationJobs`
5981
+ # call. Provide this to retrieve the subsequent page.
5982
+ #
5983
+ # When paginating, all parameters provided to `ListDiskMigrationJobs`
5984
+ # except `page_size` must match the call that provided the page token.
5985
+ # @param filter [::String]
5986
+ # Optional. The filter request (according to <a
5987
+ # href="https://google.aip.dev/160" target="_blank">AIP-160</a>).
5988
+ # @param order_by [::String]
5989
+ # Optional. Ordering of the result list.
5990
+ #
5991
+ # @yield [response, operation] Access the result along with the RPC operation
5992
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::DiskMigrationJob>]
5993
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5994
+ #
5995
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::VMMigration::V1::DiskMigrationJob>]
5996
+ #
5997
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5998
+ #
5999
+ # @example Basic example
6000
+ # require "google/cloud/vm_migration/v1"
6001
+ #
6002
+ # # Create a client object. The client can be reused for multiple calls.
6003
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
6004
+ #
6005
+ # # Create a request. To set request fields, pass in keyword arguments.
6006
+ # request = Google::Cloud::VMMigration::V1::ListDiskMigrationJobsRequest.new
6007
+ #
6008
+ # # Call the list_disk_migration_jobs method.
6009
+ # result = client.list_disk_migration_jobs request
6010
+ #
6011
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
6012
+ # # over elements, and API calls will be issued to fetch pages as needed.
6013
+ # result.each do |item|
6014
+ # # Each element is of type ::Google::Cloud::VMMigration::V1::DiskMigrationJob.
6015
+ # p item
6016
+ # end
6017
+ #
6018
+ def list_disk_migration_jobs request, options = nil
6019
+ raise ::ArgumentError, "request must be provided" if request.nil?
6020
+
6021
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::ListDiskMigrationJobsRequest
6022
+
6023
+ # Converts hash and nil to an options object
6024
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6025
+
6026
+ # Customize the options with defaults
6027
+ metadata = @config.rpcs.list_disk_migration_jobs.metadata.to_h
6028
+
6029
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
6030
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6031
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6032
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
6033
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
6034
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6035
+
6036
+ header_params = {}
6037
+ if request.parent
6038
+ header_params["parent"] = request.parent
6039
+ end
6040
+
6041
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6042
+ metadata[:"x-goog-request-params"] ||= request_params_header
6043
+
6044
+ options.apply_defaults timeout: @config.rpcs.list_disk_migration_jobs.timeout,
6045
+ metadata: metadata,
6046
+ retry_policy: @config.rpcs.list_disk_migration_jobs.retry_policy
6047
+
6048
+ options.apply_defaults timeout: @config.timeout,
6049
+ metadata: @config.metadata,
6050
+ retry_policy: @config.retry_policy
6051
+
6052
+ @vm_migration_stub.call_rpc :list_disk_migration_jobs, request, options: options do |response, operation|
6053
+ response = ::Gapic::PagedEnumerable.new @vm_migration_stub, :list_disk_migration_jobs, request, response, operation, options
6054
+ yield response, operation if block_given?
6055
+ throw :response, response
6056
+ end
6057
+ rescue ::GRPC::BadStatus => e
6058
+ raise ::Google::Cloud::Error.from_error(e)
6059
+ end
6060
+
6061
+ ##
6062
+ # Gets details of a single DiskMigrationJob.
6063
+ #
6064
+ # @overload get_disk_migration_job(request, options = nil)
6065
+ # Pass arguments to `get_disk_migration_job` via a request object, either of type
6066
+ # {::Google::Cloud::VMMigration::V1::GetDiskMigrationJobRequest} or an equivalent Hash.
6067
+ #
6068
+ # @param request [::Google::Cloud::VMMigration::V1::GetDiskMigrationJobRequest, ::Hash]
6069
+ # A request object representing the call parameters. Required. To specify no
6070
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
6071
+ # @param options [::Gapic::CallOptions, ::Hash]
6072
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
6073
+ #
6074
+ # @overload get_disk_migration_job(name: nil)
6075
+ # Pass arguments to `get_disk_migration_job` via keyword arguments. Note that at
6076
+ # least one keyword argument is required. To specify no parameters, or to keep all
6077
+ # the default parameter values, pass an empty Hash as a request object (see above).
6078
+ #
6079
+ # @param name [::String]
6080
+ # Required. The name of the DiskMigrationJob.
6081
+ #
6082
+ # @yield [response, operation] Access the result along with the RPC operation
6083
+ # @yieldparam response [::Google::Cloud::VMMigration::V1::DiskMigrationJob]
6084
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6085
+ #
6086
+ # @return [::Google::Cloud::VMMigration::V1::DiskMigrationJob]
6087
+ #
6088
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6089
+ #
6090
+ # @example Basic example
6091
+ # require "google/cloud/vm_migration/v1"
6092
+ #
6093
+ # # Create a client object. The client can be reused for multiple calls.
6094
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
6095
+ #
6096
+ # # Create a request. To set request fields, pass in keyword arguments.
6097
+ # request = Google::Cloud::VMMigration::V1::GetDiskMigrationJobRequest.new
6098
+ #
6099
+ # # Call the get_disk_migration_job method.
6100
+ # result = client.get_disk_migration_job request
6101
+ #
6102
+ # # The returned object is of type Google::Cloud::VMMigration::V1::DiskMigrationJob.
6103
+ # p result
6104
+ #
6105
+ def get_disk_migration_job request, options = nil
6106
+ raise ::ArgumentError, "request must be provided" if request.nil?
6107
+
6108
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::GetDiskMigrationJobRequest
6109
+
6110
+ # Converts hash and nil to an options object
6111
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6112
+
6113
+ # Customize the options with defaults
6114
+ metadata = @config.rpcs.get_disk_migration_job.metadata.to_h
6115
+
6116
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
6117
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6118
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6119
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
6120
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
6121
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6122
+
6123
+ header_params = {}
6124
+ if request.name
6125
+ header_params["name"] = request.name
6126
+ end
6127
+
6128
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6129
+ metadata[:"x-goog-request-params"] ||= request_params_header
6130
+
6131
+ options.apply_defaults timeout: @config.rpcs.get_disk_migration_job.timeout,
6132
+ metadata: metadata,
6133
+ retry_policy: @config.rpcs.get_disk_migration_job.retry_policy
6134
+
6135
+ options.apply_defaults timeout: @config.timeout,
6136
+ metadata: @config.metadata,
6137
+ retry_policy: @config.retry_policy
6138
+
6139
+ @vm_migration_stub.call_rpc :get_disk_migration_job, request, options: options do |response, operation|
6140
+ yield response, operation if block_given?
6141
+ end
6142
+ rescue ::GRPC::BadStatus => e
6143
+ raise ::Google::Cloud::Error.from_error(e)
6144
+ end
6145
+
6146
+ ##
6147
+ # Updates the parameters of a single DiskMigrationJob.
6148
+ #
6149
+ # @overload update_disk_migration_job(request, options = nil)
6150
+ # Pass arguments to `update_disk_migration_job` via a request object, either of type
6151
+ # {::Google::Cloud::VMMigration::V1::UpdateDiskMigrationJobRequest} or an equivalent Hash.
6152
+ #
6153
+ # @param request [::Google::Cloud::VMMigration::V1::UpdateDiskMigrationJobRequest, ::Hash]
6154
+ # A request object representing the call parameters. Required. To specify no
6155
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
6156
+ # @param options [::Gapic::CallOptions, ::Hash]
6157
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
6158
+ #
6159
+ # @overload update_disk_migration_job(update_mask: nil, disk_migration_job: nil, request_id: nil)
6160
+ # Pass arguments to `update_disk_migration_job` via keyword arguments. Note that at
6161
+ # least one keyword argument is required. To specify no parameters, or to keep all
6162
+ # the default parameter values, pass an empty Hash as a request object (see above).
6163
+ #
6164
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
6165
+ # Optional. Field mask is used to specify the fields to be overwritten in the
6166
+ # DiskMigrationJob resource by the update.
6167
+ # The fields specified in the update_mask are relative to the resource, not
6168
+ # the full request. A field will be overwritten if it is in the mask. If the
6169
+ # user does not provide a mask, then a mask equivalent to all fields that are
6170
+ # populated (have a non-empty value), will be implied.
6171
+ # @param disk_migration_job [::Google::Cloud::VMMigration::V1::DiskMigrationJob, ::Hash]
6172
+ # Required. The update request body.
6173
+ # @param request_id [::String]
6174
+ # Optional. A request ID to identify requests. Specify a unique request ID
6175
+ # so that if you must retry your request, the server will know to ignore
6176
+ # the request if it has already been completed. The server will guarantee
6177
+ # that for at least 60 minutes since the first request.
6178
+ #
6179
+ # For example, consider a situation where you make an initial request and
6180
+ # the request timed out. If you make the request again with the same request
6181
+ # ID, the server can check if original operation with the same request ID
6182
+ # was received, and if so, will ignore the second request. This prevents
6183
+ # clients from accidentally creating duplicate commitments.
6184
+ #
6185
+ # The request ID must be a valid UUID with the exception that zero UUID is
6186
+ # not supported (00000000-0000-0000-0000-000000000000).
6187
+ #
6188
+ # @yield [response, operation] Access the result along with the RPC operation
6189
+ # @yieldparam response [::Gapic::Operation]
6190
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6191
+ #
6192
+ # @return [::Gapic::Operation]
6193
+ #
6194
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6195
+ #
6196
+ # @example Basic example
6197
+ # require "google/cloud/vm_migration/v1"
6198
+ #
6199
+ # # Create a client object. The client can be reused for multiple calls.
6200
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
6201
+ #
6202
+ # # Create a request. To set request fields, pass in keyword arguments.
6203
+ # request = Google::Cloud::VMMigration::V1::UpdateDiskMigrationJobRequest.new
6204
+ #
6205
+ # # Call the update_disk_migration_job method.
6206
+ # result = client.update_disk_migration_job request
6207
+ #
6208
+ # # The returned object is of type Gapic::Operation. You can use it to
6209
+ # # check the status of an operation, cancel it, or wait for results.
6210
+ # # Here is how to wait for a response.
6211
+ # result.wait_until_done! timeout: 60
6212
+ # if result.response?
6213
+ # p result.response
6214
+ # else
6215
+ # puts "No response received."
6216
+ # end
6217
+ #
6218
+ def update_disk_migration_job request, options = nil
6219
+ raise ::ArgumentError, "request must be provided" if request.nil?
6220
+
6221
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::UpdateDiskMigrationJobRequest
6222
+
6223
+ # Converts hash and nil to an options object
6224
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6225
+
6226
+ # Customize the options with defaults
6227
+ metadata = @config.rpcs.update_disk_migration_job.metadata.to_h
6228
+
6229
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
6230
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6231
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6232
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
6233
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
6234
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6235
+
6236
+ header_params = {}
6237
+ if request.disk_migration_job&.name
6238
+ header_params["disk_migration_job.name"] = request.disk_migration_job.name
6239
+ end
6240
+
6241
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6242
+ metadata[:"x-goog-request-params"] ||= request_params_header
6243
+
6244
+ options.apply_defaults timeout: @config.rpcs.update_disk_migration_job.timeout,
6245
+ metadata: metadata,
6246
+ retry_policy: @config.rpcs.update_disk_migration_job.retry_policy
6247
+
6248
+ options.apply_defaults timeout: @config.timeout,
6249
+ metadata: @config.metadata,
6250
+ retry_policy: @config.retry_policy
6251
+
6252
+ @vm_migration_stub.call_rpc :update_disk_migration_job, request, options: options do |response, operation|
6253
+ response = ::Gapic::Operation.new response, @operations_client, options: options
6254
+ yield response, operation if block_given?
6255
+ throw :response, response
6256
+ end
6257
+ rescue ::GRPC::BadStatus => e
6258
+ raise ::Google::Cloud::Error.from_error(e)
6259
+ end
6260
+
6261
+ ##
6262
+ # Deletes a single DiskMigrationJob.
6263
+ #
6264
+ # @overload delete_disk_migration_job(request, options = nil)
6265
+ # Pass arguments to `delete_disk_migration_job` via a request object, either of type
6266
+ # {::Google::Cloud::VMMigration::V1::DeleteDiskMigrationJobRequest} or an equivalent Hash.
6267
+ #
6268
+ # @param request [::Google::Cloud::VMMigration::V1::DeleteDiskMigrationJobRequest, ::Hash]
6269
+ # A request object representing the call parameters. Required. To specify no
6270
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
6271
+ # @param options [::Gapic::CallOptions, ::Hash]
6272
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
6273
+ #
6274
+ # @overload delete_disk_migration_job(name: nil)
6275
+ # Pass arguments to `delete_disk_migration_job` via keyword arguments. Note that at
6276
+ # least one keyword argument is required. To specify no parameters, or to keep all
6277
+ # the default parameter values, pass an empty Hash as a request object (see above).
6278
+ #
6279
+ # @param name [::String]
6280
+ # Required. The name of the DiskMigrationJob.
6281
+ #
6282
+ # @yield [response, operation] Access the result along with the RPC operation
6283
+ # @yieldparam response [::Gapic::Operation]
6284
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6285
+ #
6286
+ # @return [::Gapic::Operation]
6287
+ #
6288
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6289
+ #
6290
+ # @example Basic example
6291
+ # require "google/cloud/vm_migration/v1"
6292
+ #
6293
+ # # Create a client object. The client can be reused for multiple calls.
6294
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
6295
+ #
6296
+ # # Create a request. To set request fields, pass in keyword arguments.
6297
+ # request = Google::Cloud::VMMigration::V1::DeleteDiskMigrationJobRequest.new
6298
+ #
6299
+ # # Call the delete_disk_migration_job method.
6300
+ # result = client.delete_disk_migration_job request
6301
+ #
6302
+ # # The returned object is of type Gapic::Operation. You can use it to
6303
+ # # check the status of an operation, cancel it, or wait for results.
6304
+ # # Here is how to wait for a response.
6305
+ # result.wait_until_done! timeout: 60
6306
+ # if result.response?
6307
+ # p result.response
6308
+ # else
6309
+ # puts "No response received."
6310
+ # end
6311
+ #
6312
+ def delete_disk_migration_job request, options = nil
6313
+ raise ::ArgumentError, "request must be provided" if request.nil?
6314
+
6315
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::DeleteDiskMigrationJobRequest
6316
+
6317
+ # Converts hash and nil to an options object
6318
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6319
+
6320
+ # Customize the options with defaults
6321
+ metadata = @config.rpcs.delete_disk_migration_job.metadata.to_h
6322
+
6323
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
6324
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6325
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6326
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
6327
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
6328
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6329
+
6330
+ header_params = {}
6331
+ if request.name
6332
+ header_params["name"] = request.name
6333
+ end
6334
+
6335
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6336
+ metadata[:"x-goog-request-params"] ||= request_params_header
6337
+
6338
+ options.apply_defaults timeout: @config.rpcs.delete_disk_migration_job.timeout,
6339
+ metadata: metadata,
6340
+ retry_policy: @config.rpcs.delete_disk_migration_job.retry_policy
6341
+
6342
+ options.apply_defaults timeout: @config.timeout,
6343
+ metadata: @config.metadata,
6344
+ retry_policy: @config.retry_policy
6345
+
6346
+ @vm_migration_stub.call_rpc :delete_disk_migration_job, request, options: options do |response, operation|
6347
+ response = ::Gapic::Operation.new response, @operations_client, options: options
6348
+ yield response, operation if block_given?
6349
+ throw :response, response
6350
+ end
6351
+ rescue ::GRPC::BadStatus => e
6352
+ raise ::Google::Cloud::Error.from_error(e)
6353
+ end
6354
+
6355
+ ##
6356
+ # Runs the disk migration job.
6357
+ #
6358
+ # @overload run_disk_migration_job(request, options = nil)
6359
+ # Pass arguments to `run_disk_migration_job` via a request object, either of type
6360
+ # {::Google::Cloud::VMMigration::V1::RunDiskMigrationJobRequest} or an equivalent Hash.
6361
+ #
6362
+ # @param request [::Google::Cloud::VMMigration::V1::RunDiskMigrationJobRequest, ::Hash]
6363
+ # A request object representing the call parameters. Required. To specify no
6364
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
6365
+ # @param options [::Gapic::CallOptions, ::Hash]
6366
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
6367
+ #
6368
+ # @overload run_disk_migration_job(name: nil)
6369
+ # Pass arguments to `run_disk_migration_job` via keyword arguments. Note that at
6370
+ # least one keyword argument is required. To specify no parameters, or to keep all
6371
+ # the default parameter values, pass an empty Hash as a request object (see above).
6372
+ #
6373
+ # @param name [::String]
6374
+ # Required. The name of the DiskMigrationJob.
6375
+ #
6376
+ # @yield [response, operation] Access the result along with the RPC operation
6377
+ # @yieldparam response [::Gapic::Operation]
6378
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6379
+ #
6380
+ # @return [::Gapic::Operation]
6381
+ #
6382
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6383
+ #
6384
+ # @example Basic example
6385
+ # require "google/cloud/vm_migration/v1"
6386
+ #
6387
+ # # Create a client object. The client can be reused for multiple calls.
6388
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
6389
+ #
6390
+ # # Create a request. To set request fields, pass in keyword arguments.
6391
+ # request = Google::Cloud::VMMigration::V1::RunDiskMigrationJobRequest.new
6392
+ #
6393
+ # # Call the run_disk_migration_job method.
6394
+ # result = client.run_disk_migration_job request
6395
+ #
6396
+ # # The returned object is of type Gapic::Operation. You can use it to
6397
+ # # check the status of an operation, cancel it, or wait for results.
6398
+ # # Here is how to wait for a response.
6399
+ # result.wait_until_done! timeout: 60
6400
+ # if result.response?
6401
+ # p result.response
6402
+ # else
6403
+ # puts "No response received."
6404
+ # end
6405
+ #
6406
+ def run_disk_migration_job request, options = nil
6407
+ raise ::ArgumentError, "request must be provided" if request.nil?
6408
+
6409
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::RunDiskMigrationJobRequest
6410
+
6411
+ # Converts hash and nil to an options object
6412
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6413
+
6414
+ # Customize the options with defaults
6415
+ metadata = @config.rpcs.run_disk_migration_job.metadata.to_h
6416
+
6417
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
6418
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6419
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6420
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
6421
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
6422
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6423
+
6424
+ header_params = {}
6425
+ if request.name
6426
+ header_params["name"] = request.name
6427
+ end
6428
+
6429
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6430
+ metadata[:"x-goog-request-params"] ||= request_params_header
6431
+
6432
+ options.apply_defaults timeout: @config.rpcs.run_disk_migration_job.timeout,
6433
+ metadata: metadata,
6434
+ retry_policy: @config.rpcs.run_disk_migration_job.retry_policy
6435
+
6436
+ options.apply_defaults timeout: @config.timeout,
6437
+ metadata: @config.metadata,
6438
+ retry_policy: @config.retry_policy
6439
+
6440
+ @vm_migration_stub.call_rpc :run_disk_migration_job, request, options: options do |response, operation|
6441
+ response = ::Gapic::Operation.new response, @operations_client, options: options
6442
+ yield response, operation if block_given?
6443
+ throw :response, response
6444
+ end
6445
+ rescue ::GRPC::BadStatus => e
6446
+ raise ::Google::Cloud::Error.from_error(e)
6447
+ end
6448
+
6449
+ ##
6450
+ # Cancels the disk migration job.
6451
+ #
6452
+ # @overload cancel_disk_migration_job(request, options = nil)
6453
+ # Pass arguments to `cancel_disk_migration_job` via a request object, either of type
6454
+ # {::Google::Cloud::VMMigration::V1::CancelDiskMigrationJobRequest} or an equivalent Hash.
6455
+ #
6456
+ # @param request [::Google::Cloud::VMMigration::V1::CancelDiskMigrationJobRequest, ::Hash]
6457
+ # A request object representing the call parameters. Required. To specify no
6458
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
6459
+ # @param options [::Gapic::CallOptions, ::Hash]
6460
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
6461
+ #
6462
+ # @overload cancel_disk_migration_job(name: nil)
6463
+ # Pass arguments to `cancel_disk_migration_job` via keyword arguments. Note that at
6464
+ # least one keyword argument is required. To specify no parameters, or to keep all
6465
+ # the default parameter values, pass an empty Hash as a request object (see above).
6466
+ #
6467
+ # @param name [::String]
6468
+ # Required. The name of the DiskMigrationJob.
6469
+ #
6470
+ # @yield [response, operation] Access the result along with the RPC operation
6471
+ # @yieldparam response [::Gapic::Operation]
6472
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
6473
+ #
6474
+ # @return [::Gapic::Operation]
6475
+ #
6476
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
6477
+ #
6478
+ # @example Basic example
6479
+ # require "google/cloud/vm_migration/v1"
6480
+ #
6481
+ # # Create a client object. The client can be reused for multiple calls.
6482
+ # client = Google::Cloud::VMMigration::V1::VMMigration::Client.new
6483
+ #
6484
+ # # Create a request. To set request fields, pass in keyword arguments.
6485
+ # request = Google::Cloud::VMMigration::V1::CancelDiskMigrationJobRequest.new
6486
+ #
6487
+ # # Call the cancel_disk_migration_job method.
6488
+ # result = client.cancel_disk_migration_job request
6489
+ #
6490
+ # # The returned object is of type Gapic::Operation. You can use it to
6491
+ # # check the status of an operation, cancel it, or wait for results.
6492
+ # # Here is how to wait for a response.
6493
+ # result.wait_until_done! timeout: 60
6494
+ # if result.response?
6495
+ # p result.response
6496
+ # else
6497
+ # puts "No response received."
6498
+ # end
6499
+ #
6500
+ def cancel_disk_migration_job request, options = nil
6501
+ raise ::ArgumentError, "request must be provided" if request.nil?
6502
+
6503
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VMMigration::V1::CancelDiskMigrationJobRequest
6504
+
6505
+ # Converts hash and nil to an options object
6506
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
6507
+
6508
+ # Customize the options with defaults
6509
+ metadata = @config.rpcs.cancel_disk_migration_job.metadata.to_h
6510
+
6511
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
6512
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
6513
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
6514
+ gapic_version: ::Google::Cloud::VMMigration::V1::VERSION
6515
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
6516
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
6517
+
6518
+ header_params = {}
6519
+ if request.name
6520
+ header_params["name"] = request.name
6521
+ end
6522
+
6523
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
6524
+ metadata[:"x-goog-request-params"] ||= request_params_header
6525
+
6526
+ options.apply_defaults timeout: @config.rpcs.cancel_disk_migration_job.timeout,
6527
+ metadata: metadata,
6528
+ retry_policy: @config.rpcs.cancel_disk_migration_job.retry_policy
6529
+
6530
+ options.apply_defaults timeout: @config.timeout,
6531
+ metadata: @config.metadata,
6532
+ retry_policy: @config.retry_policy
6533
+
6534
+ @vm_migration_stub.call_rpc :cancel_disk_migration_job, request, options: options do |response, operation|
6535
+ response = ::Gapic::Operation.new response, @operations_client, options: options
6536
+ yield response, operation if block_given?
6537
+ throw :response, response
6538
+ end
6539
+ rescue ::GRPC::BadStatus => e
6540
+ raise ::Google::Cloud::Error.from_error(e)
6541
+ end
6542
+
6543
+ ##
6544
+ # Configuration class for the VmMigration API.
6545
+ #
6546
+ # This class represents the configuration for VmMigration,
6547
+ # providing control over timeouts, retry behavior, logging, transport
6548
+ # parameters, and other low-level controls. Certain parameters can also be
6549
+ # applied individually to specific RPCs. See
6550
+ # {::Google::Cloud::VMMigration::V1::VMMigration::Client::Configuration::Rpcs}
6551
+ # for a list of RPCs that can be configured independently.
6552
+ #
6553
+ # Configuration can be applied globally to all clients, or to a single client
6554
+ # on construction.
6555
+ #
6556
+ # @example
6557
+ #
6558
+ # # Modify the global config, setting the timeout for
6559
+ # # list_sources to 20 seconds,
6560
+ # # and all remaining timeouts to 10 seconds.
6561
+ # ::Google::Cloud::VMMigration::V1::VMMigration::Client.configure do |config|
6562
+ # config.timeout = 10.0
6563
+ # config.rpcs.list_sources.timeout = 20.0
6564
+ # end
6565
+ #
6566
+ # # Apply the above configuration only to a new client.
6567
+ # client = ::Google::Cloud::VMMigration::V1::VMMigration::Client.new do |config|
6568
+ # config.timeout = 10.0
6569
+ # config.rpcs.list_sources.timeout = 20.0
6570
+ # end
6571
+ #
6572
+ # @!attribute [rw] endpoint
6573
+ # A custom service endpoint, as a hostname or hostname:port. The default is
6574
+ # nil, indicating to use the default endpoint in the current universe domain.
6575
+ # @return [::String,nil]
6576
+ # @!attribute [rw] credentials
6577
+ # Credentials to send with calls. You may provide any of the following types:
6578
+ # * (`String`) The path to a service account key file in JSON format
6579
+ # * (`Hash`) A service account key as a Hash
6580
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
6581
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
6582
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
6583
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
6584
+ # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
6585
+ # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
6586
+ # * (`nil`) indicating no credentials
6587
+ #
6588
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
6589
+ # external source for authentication to Google Cloud, you must validate it before
4992
6590
  # providing it to a Google API client library. Providing an unvalidated credential
4993
6591
  # configuration to Google APIs can compromise the security of your systems and data.
4994
6592
  # For more information, refer to [Validate credential configurations from external
@@ -5139,6 +6737,11 @@ module Google
5139
6737
  #
5140
6738
  attr_reader :fetch_inventory
5141
6739
  ##
6740
+ # RPC-specific configuration for `fetch_storage_inventory`
6741
+ # @return [::Gapic::Config::Method]
6742
+ #
6743
+ attr_reader :fetch_storage_inventory
6744
+ ##
5142
6745
  # RPC-specific configuration for `list_utilization_reports`
5143
6746
  # @return [::Gapic::Config::Method]
5144
6747
  #
@@ -5229,6 +6832,11 @@ module Google
5229
6832
  #
5230
6833
  attr_reader :finalize_migration
5231
6834
  ##
6835
+ # RPC-specific configuration for `extend_migration`
6836
+ # @return [::Gapic::Config::Method]
6837
+ #
6838
+ attr_reader :extend_migration
6839
+ ##
5232
6840
  # RPC-specific configuration for `create_clone_job`
5233
6841
  # @return [::Gapic::Config::Method]
5234
6842
  #
@@ -5338,6 +6946,76 @@ module Google
5338
6946
  # @return [::Gapic::Config::Method]
5339
6947
  #
5340
6948
  attr_reader :get_replication_cycle
6949
+ ##
6950
+ # RPC-specific configuration for `list_image_imports`
6951
+ # @return [::Gapic::Config::Method]
6952
+ #
6953
+ attr_reader :list_image_imports
6954
+ ##
6955
+ # RPC-specific configuration for `get_image_import`
6956
+ # @return [::Gapic::Config::Method]
6957
+ #
6958
+ attr_reader :get_image_import
6959
+ ##
6960
+ # RPC-specific configuration for `create_image_import`
6961
+ # @return [::Gapic::Config::Method]
6962
+ #
6963
+ attr_reader :create_image_import
6964
+ ##
6965
+ # RPC-specific configuration for `delete_image_import`
6966
+ # @return [::Gapic::Config::Method]
6967
+ #
6968
+ attr_reader :delete_image_import
6969
+ ##
6970
+ # RPC-specific configuration for `list_image_import_jobs`
6971
+ # @return [::Gapic::Config::Method]
6972
+ #
6973
+ attr_reader :list_image_import_jobs
6974
+ ##
6975
+ # RPC-specific configuration for `get_image_import_job`
6976
+ # @return [::Gapic::Config::Method]
6977
+ #
6978
+ attr_reader :get_image_import_job
6979
+ ##
6980
+ # RPC-specific configuration for `cancel_image_import_job`
6981
+ # @return [::Gapic::Config::Method]
6982
+ #
6983
+ attr_reader :cancel_image_import_job
6984
+ ##
6985
+ # RPC-specific configuration for `create_disk_migration_job`
6986
+ # @return [::Gapic::Config::Method]
6987
+ #
6988
+ attr_reader :create_disk_migration_job
6989
+ ##
6990
+ # RPC-specific configuration for `list_disk_migration_jobs`
6991
+ # @return [::Gapic::Config::Method]
6992
+ #
6993
+ attr_reader :list_disk_migration_jobs
6994
+ ##
6995
+ # RPC-specific configuration for `get_disk_migration_job`
6996
+ # @return [::Gapic::Config::Method]
6997
+ #
6998
+ attr_reader :get_disk_migration_job
6999
+ ##
7000
+ # RPC-specific configuration for `update_disk_migration_job`
7001
+ # @return [::Gapic::Config::Method]
7002
+ #
7003
+ attr_reader :update_disk_migration_job
7004
+ ##
7005
+ # RPC-specific configuration for `delete_disk_migration_job`
7006
+ # @return [::Gapic::Config::Method]
7007
+ #
7008
+ attr_reader :delete_disk_migration_job
7009
+ ##
7010
+ # RPC-specific configuration for `run_disk_migration_job`
7011
+ # @return [::Gapic::Config::Method]
7012
+ #
7013
+ attr_reader :run_disk_migration_job
7014
+ ##
7015
+ # RPC-specific configuration for `cancel_disk_migration_job`
7016
+ # @return [::Gapic::Config::Method]
7017
+ #
7018
+ attr_reader :cancel_disk_migration_job
5341
7019
 
5342
7020
  # @private
5343
7021
  def initialize parent_rpcs = nil
@@ -5353,6 +7031,8 @@ module Google
5353
7031
  @delete_source = ::Gapic::Config::Method.new delete_source_config
5354
7032
  fetch_inventory_config = parent_rpcs.fetch_inventory if parent_rpcs.respond_to? :fetch_inventory
5355
7033
  @fetch_inventory = ::Gapic::Config::Method.new fetch_inventory_config
7034
+ fetch_storage_inventory_config = parent_rpcs.fetch_storage_inventory if parent_rpcs.respond_to? :fetch_storage_inventory
7035
+ @fetch_storage_inventory = ::Gapic::Config::Method.new fetch_storage_inventory_config
5356
7036
  list_utilization_reports_config = parent_rpcs.list_utilization_reports if parent_rpcs.respond_to? :list_utilization_reports
5357
7037
  @list_utilization_reports = ::Gapic::Config::Method.new list_utilization_reports_config
5358
7038
  get_utilization_report_config = parent_rpcs.get_utilization_report if parent_rpcs.respond_to? :get_utilization_report
@@ -5389,6 +7069,8 @@ module Google
5389
7069
  @pause_migration = ::Gapic::Config::Method.new pause_migration_config
5390
7070
  finalize_migration_config = parent_rpcs.finalize_migration if parent_rpcs.respond_to? :finalize_migration
5391
7071
  @finalize_migration = ::Gapic::Config::Method.new finalize_migration_config
7072
+ extend_migration_config = parent_rpcs.extend_migration if parent_rpcs.respond_to? :extend_migration
7073
+ @extend_migration = ::Gapic::Config::Method.new extend_migration_config
5392
7074
  create_clone_job_config = parent_rpcs.create_clone_job if parent_rpcs.respond_to? :create_clone_job
5393
7075
  @create_clone_job = ::Gapic::Config::Method.new create_clone_job_config
5394
7076
  cancel_clone_job_config = parent_rpcs.cancel_clone_job if parent_rpcs.respond_to? :cancel_clone_job
@@ -5433,6 +7115,34 @@ module Google
5433
7115
  @list_replication_cycles = ::Gapic::Config::Method.new list_replication_cycles_config
5434
7116
  get_replication_cycle_config = parent_rpcs.get_replication_cycle if parent_rpcs.respond_to? :get_replication_cycle
5435
7117
  @get_replication_cycle = ::Gapic::Config::Method.new get_replication_cycle_config
7118
+ list_image_imports_config = parent_rpcs.list_image_imports if parent_rpcs.respond_to? :list_image_imports
7119
+ @list_image_imports = ::Gapic::Config::Method.new list_image_imports_config
7120
+ get_image_import_config = parent_rpcs.get_image_import if parent_rpcs.respond_to? :get_image_import
7121
+ @get_image_import = ::Gapic::Config::Method.new get_image_import_config
7122
+ create_image_import_config = parent_rpcs.create_image_import if parent_rpcs.respond_to? :create_image_import
7123
+ @create_image_import = ::Gapic::Config::Method.new create_image_import_config
7124
+ delete_image_import_config = parent_rpcs.delete_image_import if parent_rpcs.respond_to? :delete_image_import
7125
+ @delete_image_import = ::Gapic::Config::Method.new delete_image_import_config
7126
+ list_image_import_jobs_config = parent_rpcs.list_image_import_jobs if parent_rpcs.respond_to? :list_image_import_jobs
7127
+ @list_image_import_jobs = ::Gapic::Config::Method.new list_image_import_jobs_config
7128
+ get_image_import_job_config = parent_rpcs.get_image_import_job if parent_rpcs.respond_to? :get_image_import_job
7129
+ @get_image_import_job = ::Gapic::Config::Method.new get_image_import_job_config
7130
+ cancel_image_import_job_config = parent_rpcs.cancel_image_import_job if parent_rpcs.respond_to? :cancel_image_import_job
7131
+ @cancel_image_import_job = ::Gapic::Config::Method.new cancel_image_import_job_config
7132
+ create_disk_migration_job_config = parent_rpcs.create_disk_migration_job if parent_rpcs.respond_to? :create_disk_migration_job
7133
+ @create_disk_migration_job = ::Gapic::Config::Method.new create_disk_migration_job_config
7134
+ list_disk_migration_jobs_config = parent_rpcs.list_disk_migration_jobs if parent_rpcs.respond_to? :list_disk_migration_jobs
7135
+ @list_disk_migration_jobs = ::Gapic::Config::Method.new list_disk_migration_jobs_config
7136
+ get_disk_migration_job_config = parent_rpcs.get_disk_migration_job if parent_rpcs.respond_to? :get_disk_migration_job
7137
+ @get_disk_migration_job = ::Gapic::Config::Method.new get_disk_migration_job_config
7138
+ update_disk_migration_job_config = parent_rpcs.update_disk_migration_job if parent_rpcs.respond_to? :update_disk_migration_job
7139
+ @update_disk_migration_job = ::Gapic::Config::Method.new update_disk_migration_job_config
7140
+ delete_disk_migration_job_config = parent_rpcs.delete_disk_migration_job if parent_rpcs.respond_to? :delete_disk_migration_job
7141
+ @delete_disk_migration_job = ::Gapic::Config::Method.new delete_disk_migration_job_config
7142
+ run_disk_migration_job_config = parent_rpcs.run_disk_migration_job if parent_rpcs.respond_to? :run_disk_migration_job
7143
+ @run_disk_migration_job = ::Gapic::Config::Method.new run_disk_migration_job_config
7144
+ cancel_disk_migration_job_config = parent_rpcs.cancel_disk_migration_job if parent_rpcs.respond_to? :cancel_disk_migration_job
7145
+ @cancel_disk_migration_job = ::Gapic::Config::Method.new cancel_disk_migration_job_config
5436
7146
 
5437
7147
  yield self if block_given?
5438
7148
  end