google-cloud-deploy-v1 0.13.0 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/deploy/v1/automation_payload_pb.rb +44 -0
- data/lib/google/cloud/deploy/v1/automationrun_payload_pb.rb +44 -0
- data/lib/google/cloud/deploy/v1/cloud_deploy/client.rb +1155 -136
- data/lib/google/cloud/deploy/v1/cloud_deploy/paths.rb +61 -0
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb +1088 -134
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/service_stub.rb +535 -0
- data/lib/google/cloud/deploy/v1/cloud_deploy_pb.rb +38 -1
- data/lib/google/cloud/deploy/v1/cloud_deploy_services_pb.rb +21 -0
- data/lib/google/cloud/deploy/v1/release_render_payload_pb.rb +3 -1
- data/lib/google/cloud/deploy/v1/rollout_update_payload_pb.rb +45 -0
- data/lib/google/cloud/deploy/v1/version.rb +1 -1
- data/proto_docs/google/cloud/deploy/v1/automation_payload.rb +46 -0
- data/proto_docs/google/cloud/deploy/v1/automationrun_payload.rb +55 -0
- data/proto_docs/google/cloud/deploy/v1/cloud_deploy.rb +940 -70
- data/proto_docs/google/cloud/deploy/v1/release_render_payload.rb +4 -1
- data/proto_docs/google/cloud/deploy/v1/rollout_update_payload.rb +99 -0
- metadata +8 -2
|
@@ -154,6 +154,34 @@ module Google
|
|
|
154
154
|
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
|
155
155
|
}
|
|
156
156
|
|
|
157
|
+
default_config.rpcs.create_automation.timeout = 60.0
|
|
158
|
+
|
|
159
|
+
default_config.rpcs.update_automation.timeout = 60.0
|
|
160
|
+
|
|
161
|
+
default_config.rpcs.delete_automation.timeout = 60.0
|
|
162
|
+
|
|
163
|
+
default_config.rpcs.get_automation.timeout = 60.0
|
|
164
|
+
default_config.rpcs.get_automation.retry_policy = {
|
|
165
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
|
166
|
+
}
|
|
167
|
+
|
|
168
|
+
default_config.rpcs.list_automations.timeout = 60.0
|
|
169
|
+
default_config.rpcs.list_automations.retry_policy = {
|
|
170
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
default_config.rpcs.get_automation_run.timeout = 60.0
|
|
174
|
+
default_config.rpcs.get_automation_run.retry_policy = {
|
|
175
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
default_config.rpcs.list_automation_runs.timeout = 60.0
|
|
179
|
+
default_config.rpcs.list_automation_runs.retry_policy = {
|
|
180
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
default_config.rpcs.cancel_automation_run.timeout = 60.0
|
|
184
|
+
|
|
157
185
|
default_config
|
|
158
186
|
end
|
|
159
187
|
yield @configure if block_given?
|
|
@@ -284,7 +312,7 @@ module Google
|
|
|
284
312
|
#
|
|
285
313
|
# @param parent [::String]
|
|
286
314
|
# Required. The parent, which owns this collection of pipelines. Format must
|
|
287
|
-
# be projects
|
|
315
|
+
# be `projects/{project_id}/locations/{location_name}`.
|
|
288
316
|
# @param page_size [::Integer]
|
|
289
317
|
# The maximum number of pipelines to return. The service may return
|
|
290
318
|
# fewer than this value. If unspecified, at most 50 pipelines will
|
|
@@ -383,7 +411,7 @@ module Google
|
|
|
383
411
|
#
|
|
384
412
|
# @param name [::String]
|
|
385
413
|
# Required. Name of the `DeliveryPipeline`. Format must be
|
|
386
|
-
# projects
|
|
414
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
|
387
415
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
388
416
|
# @yieldparam result [::Google::Cloud::Deploy::V1::DeliveryPipeline]
|
|
389
417
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -462,7 +490,8 @@ module Google
|
|
|
462
490
|
#
|
|
463
491
|
# @param parent [::String]
|
|
464
492
|
# Required. The parent collection in which the `DeliveryPipeline` should be
|
|
465
|
-
# created. Format should be
|
|
493
|
+
# created. Format should be
|
|
494
|
+
# `projects/{project_id}/locations/{location_name}`.
|
|
466
495
|
# @param delivery_pipeline_id [::String]
|
|
467
496
|
# Required. ID of the `DeliveryPipeline`.
|
|
468
497
|
# @param delivery_pipeline [::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash]
|
|
@@ -682,7 +711,7 @@ module Google
|
|
|
682
711
|
#
|
|
683
712
|
# @param name [::String]
|
|
684
713
|
# Required. The name of the `DeliveryPipeline` to delete. Format should be
|
|
685
|
-
# projects
|
|
714
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
|
686
715
|
# @param request_id [::String]
|
|
687
716
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
688
717
|
# so that if you must retry your request, the server will know to ignore
|
|
@@ -797,7 +826,7 @@ module Google
|
|
|
797
826
|
#
|
|
798
827
|
# @param parent [::String]
|
|
799
828
|
# Required. The parent, which owns this collection of targets. Format must be
|
|
800
|
-
# projects
|
|
829
|
+
# `projects/{project_id}/locations/{location_name}`.
|
|
801
830
|
# @param page_size [::Integer]
|
|
802
831
|
# Optional. The maximum number of `Target` objects to return. The service may
|
|
803
832
|
# return fewer than this value. If unspecified, at most 50 `Target` objects
|
|
@@ -877,6 +906,102 @@ module Google
|
|
|
877
906
|
raise ::Google::Cloud::Error.from_error(e)
|
|
878
907
|
end
|
|
879
908
|
|
|
909
|
+
##
|
|
910
|
+
# Creates a `Rollout` to roll back the specified target.
|
|
911
|
+
#
|
|
912
|
+
# @overload rollback_target(request, options = nil)
|
|
913
|
+
# Pass arguments to `rollback_target` via a request object, either of type
|
|
914
|
+
# {::Google::Cloud::Deploy::V1::RollbackTargetRequest} or an equivalent Hash.
|
|
915
|
+
#
|
|
916
|
+
# @param request [::Google::Cloud::Deploy::V1::RollbackTargetRequest, ::Hash]
|
|
917
|
+
# A request object representing the call parameters. Required. To specify no
|
|
918
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
919
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
920
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
921
|
+
#
|
|
922
|
+
# @overload rollback_target(name: nil, target_id: nil, rollout_id: nil, release_id: nil, rollout_to_roll_back: nil, rollback_config: nil, validate_only: nil)
|
|
923
|
+
# Pass arguments to `rollback_target` via keyword arguments. Note that at
|
|
924
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
925
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
926
|
+
#
|
|
927
|
+
# @param name [::String]
|
|
928
|
+
# Required. The `DeliveryPipeline` for which the rollback `Rollout` should be
|
|
929
|
+
# created. Format should be
|
|
930
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
|
931
|
+
# @param target_id [::String]
|
|
932
|
+
# Required. ID of the `Target` that is being rolled back.
|
|
933
|
+
# @param rollout_id [::String]
|
|
934
|
+
# Required. ID of the rollback `Rollout` to create.
|
|
935
|
+
# @param release_id [::String]
|
|
936
|
+
# Optional. ID of the `Release` to roll back to. If this isn't specified, the
|
|
937
|
+
# previous successful `Rollout` to the specified target will be used to
|
|
938
|
+
# determine the `Release`.
|
|
939
|
+
# @param rollout_to_roll_back [::String]
|
|
940
|
+
# Optional. If provided, this must be the latest `Rollout` that is on the
|
|
941
|
+
# `Target`.
|
|
942
|
+
# @param rollback_config [::Google::Cloud::Deploy::V1::RollbackTargetConfig, ::Hash]
|
|
943
|
+
# Optional. Configs for the rollback `Rollout`.
|
|
944
|
+
# @param validate_only [::Boolean]
|
|
945
|
+
# Optional. If set to true, the request is validated and the user is provided
|
|
946
|
+
# with a `RollbackTargetResponse`.
|
|
947
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
948
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::RollbackTargetResponse]
|
|
949
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
950
|
+
#
|
|
951
|
+
# @return [::Google::Cloud::Deploy::V1::RollbackTargetResponse]
|
|
952
|
+
#
|
|
953
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
954
|
+
#
|
|
955
|
+
# @example Basic example
|
|
956
|
+
# require "google/cloud/deploy/v1"
|
|
957
|
+
#
|
|
958
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
959
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
960
|
+
#
|
|
961
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
962
|
+
# request = Google::Cloud::Deploy::V1::RollbackTargetRequest.new
|
|
963
|
+
#
|
|
964
|
+
# # Call the rollback_target method.
|
|
965
|
+
# result = client.rollback_target request
|
|
966
|
+
#
|
|
967
|
+
# # The returned object is of type Google::Cloud::Deploy::V1::RollbackTargetResponse.
|
|
968
|
+
# p result
|
|
969
|
+
#
|
|
970
|
+
def rollback_target request, options = nil
|
|
971
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
972
|
+
|
|
973
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::RollbackTargetRequest
|
|
974
|
+
|
|
975
|
+
# Converts hash and nil to an options object
|
|
976
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
977
|
+
|
|
978
|
+
# Customize the options with defaults
|
|
979
|
+
call_metadata = @config.rpcs.rollback_target.metadata.to_h
|
|
980
|
+
|
|
981
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
982
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
983
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
984
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
985
|
+
transports_version_send: [:rest]
|
|
986
|
+
|
|
987
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
988
|
+
|
|
989
|
+
options.apply_defaults timeout: @config.rpcs.rollback_target.timeout,
|
|
990
|
+
metadata: call_metadata,
|
|
991
|
+
retry_policy: @config.rpcs.rollback_target.retry_policy
|
|
992
|
+
|
|
993
|
+
options.apply_defaults timeout: @config.timeout,
|
|
994
|
+
metadata: @config.metadata,
|
|
995
|
+
retry_policy: @config.retry_policy
|
|
996
|
+
|
|
997
|
+
@cloud_deploy_stub.rollback_target request, options do |result, operation|
|
|
998
|
+
yield result, operation if block_given?
|
|
999
|
+
return result
|
|
1000
|
+
end
|
|
1001
|
+
rescue ::Gapic::Rest::Error => e
|
|
1002
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
1003
|
+
end
|
|
1004
|
+
|
|
880
1005
|
##
|
|
881
1006
|
# Gets details of a single Target.
|
|
882
1007
|
#
|
|
@@ -897,7 +1022,7 @@ module Google
|
|
|
897
1022
|
#
|
|
898
1023
|
# @param name [::String]
|
|
899
1024
|
# Required. Name of the `Target`. Format must be
|
|
900
|
-
# projects
|
|
1025
|
+
# `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
|
|
901
1026
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
902
1027
|
# @yieldparam result [::Google::Cloud::Deploy::V1::Target]
|
|
903
1028
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -977,7 +1102,7 @@ module Google
|
|
|
977
1102
|
# @param parent [::String]
|
|
978
1103
|
# Required. The parent collection in which the `Target` should be created.
|
|
979
1104
|
# Format should be
|
|
980
|
-
# projects
|
|
1105
|
+
# `projects/{project_id}/locations/{location_name}`.
|
|
981
1106
|
# @param target_id [::String]
|
|
982
1107
|
# Required. ID of the `Target`.
|
|
983
1108
|
# @param target [::Google::Cloud::Deploy::V1::Target, ::Hash]
|
|
@@ -1197,7 +1322,7 @@ module Google
|
|
|
1197
1322
|
#
|
|
1198
1323
|
# @param name [::String]
|
|
1199
1324
|
# Required. The name of the `Target` to delete. Format should be
|
|
1200
|
-
# projects
|
|
1325
|
+
# `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
|
|
1201
1326
|
# @param request_id [::String]
|
|
1202
1327
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
1203
1328
|
# so that if you must retry your request, the server will know to ignore
|
|
@@ -1408,7 +1533,7 @@ module Google
|
|
|
1408
1533
|
#
|
|
1409
1534
|
# @param name [::String]
|
|
1410
1535
|
# Required. Name of the `Release`. Format must be
|
|
1411
|
-
# projects
|
|
1536
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
|
|
1412
1537
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
1413
1538
|
# @yieldparam result [::Google::Cloud::Deploy::V1::Release]
|
|
1414
1539
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -1488,7 +1613,7 @@ module Google
|
|
|
1488
1613
|
# @param parent [::String]
|
|
1489
1614
|
# Required. The parent collection in which the `Release` should be created.
|
|
1490
1615
|
# Format should be
|
|
1491
|
-
# projects
|
|
1616
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
|
1492
1617
|
# @param release_id [::String]
|
|
1493
1618
|
# Required. ID of the `Release`.
|
|
1494
1619
|
# @param release [::Google::Cloud::Deploy::V1::Release, ::Hash]
|
|
@@ -1596,8 +1721,7 @@ module Google
|
|
|
1596
1721
|
#
|
|
1597
1722
|
# @param name [::String]
|
|
1598
1723
|
# Required. Name of the Release. Format is
|
|
1599
|
-
# projects
|
|
1600
|
-
# releases/\\{release}.
|
|
1724
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}`.
|
|
1601
1725
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
1602
1726
|
# @yieldparam result [::Google::Cloud::Deploy::V1::AbandonReleaseResponse]
|
|
1603
1727
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -1676,8 +1800,7 @@ module Google
|
|
|
1676
1800
|
#
|
|
1677
1801
|
# @param name [::String]
|
|
1678
1802
|
# Required. Name of the Rollout. Format is
|
|
1679
|
-
# projects
|
|
1680
|
-
# releases/\\{release}/rollouts/\\{rollout}.
|
|
1803
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
|
|
1681
1804
|
# @param approved [::Boolean]
|
|
1682
1805
|
# Required. True = approve; false = reject
|
|
1683
1806
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
@@ -1758,8 +1881,7 @@ module Google
|
|
|
1758
1881
|
#
|
|
1759
1882
|
# @param name [::String]
|
|
1760
1883
|
# Required. Name of the Rollout. Format is
|
|
1761
|
-
# projects
|
|
1762
|
-
# releases/\\{release}/rollouts/\\{rollout}.
|
|
1884
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
|
|
1763
1885
|
# @param phase_id [::String]
|
|
1764
1886
|
# Required. The phase ID to advance the `Rollout` to.
|
|
1765
1887
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
@@ -1840,8 +1962,7 @@ module Google
|
|
|
1840
1962
|
#
|
|
1841
1963
|
# @param name [::String]
|
|
1842
1964
|
# Required. Name of the Rollout. Format is
|
|
1843
|
-
# projects
|
|
1844
|
-
# releases/\\{release}/rollouts/\\{rollout}.
|
|
1965
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
|
|
1845
1966
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
1846
1967
|
# @yieldparam result [::Google::Cloud::Deploy::V1::CancelRolloutResponse]
|
|
1847
1968
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -2019,7 +2140,7 @@ module Google
|
|
|
2019
2140
|
#
|
|
2020
2141
|
# @param name [::String]
|
|
2021
2142
|
# Required. Name of the `Rollout`. Format must be
|
|
2022
|
-
# projects
|
|
2143
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}`.
|
|
2023
2144
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
2024
2145
|
# @yieldparam result [::Google::Cloud::Deploy::V1::Rollout]
|
|
2025
2146
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -2099,7 +2220,7 @@ module Google
|
|
|
2099
2220
|
# @param parent [::String]
|
|
2100
2221
|
# Required. The parent collection in which the `Rollout` should be created.
|
|
2101
2222
|
# Format should be
|
|
2102
|
-
# projects
|
|
2223
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
|
|
2103
2224
|
# @param rollout_id [::String]
|
|
2104
2225
|
# Required. ID of the `Rollout`.
|
|
2105
2226
|
# @param rollout [::Google::Cloud::Deploy::V1::Rollout, ::Hash]
|
|
@@ -2210,8 +2331,7 @@ module Google
|
|
|
2210
2331
|
#
|
|
2211
2332
|
# @param rollout [::String]
|
|
2212
2333
|
# Required. Name of the Rollout. Format is
|
|
2213
|
-
# projects
|
|
2214
|
-
# releases/\\{release}/rollouts/\\{rollout}.
|
|
2334
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
|
|
2215
2335
|
# @param phase_id [::String]
|
|
2216
2336
|
# Required. The phase ID the Job to ignore belongs to.
|
|
2217
2337
|
# @param job_id [::String]
|
|
@@ -2294,8 +2414,7 @@ module Google
|
|
|
2294
2414
|
#
|
|
2295
2415
|
# @param rollout [::String]
|
|
2296
2416
|
# Required. Name of the Rollout. Format is
|
|
2297
|
-
# projects
|
|
2298
|
-
# releases/\\{release}/rollouts/\\{rollout}.
|
|
2417
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
|
|
2299
2418
|
# @param phase_id [::String]
|
|
2300
2419
|
# Required. The phase ID the Job to retry belongs to.
|
|
2301
2420
|
# @param job_id [::String]
|
|
@@ -2477,7 +2596,7 @@ module Google
|
|
|
2477
2596
|
#
|
|
2478
2597
|
# @param name [::String]
|
|
2479
2598
|
# Required. Name of the `JobRun`. Format must be
|
|
2480
|
-
# projects
|
|
2599
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}`.
|
|
2481
2600
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
2482
2601
|
# @yieldparam result [::Google::Cloud::Deploy::V1::JobRun]
|
|
2483
2602
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -2556,8 +2675,7 @@ module Google
|
|
|
2556
2675
|
#
|
|
2557
2676
|
# @param name [::String]
|
|
2558
2677
|
# Required. Name of the `JobRun`. Format must be
|
|
2559
|
-
# projects
|
|
2560
|
-
# releases/\\{release}/rollouts/\\{rollout}/jobRuns/\\{jobRun}.
|
|
2678
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}`.
|
|
2561
2679
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
2562
2680
|
# @yieldparam result [::Google::Cloud::Deploy::V1::TerminateJobRunResponse]
|
|
2563
2681
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
@@ -2695,128 +2813,901 @@ module Google
|
|
|
2695
2813
|
end
|
|
2696
2814
|
|
|
2697
2815
|
##
|
|
2698
|
-
#
|
|
2816
|
+
# Creates a new Automation in a given project and location.
|
|
2699
2817
|
#
|
|
2700
|
-
#
|
|
2701
|
-
#
|
|
2702
|
-
#
|
|
2703
|
-
# applied individually to specific RPCs. See
|
|
2704
|
-
# {::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client::Configuration::Rpcs}
|
|
2705
|
-
# for a list of RPCs that can be configured independently.
|
|
2818
|
+
# @overload create_automation(request, options = nil)
|
|
2819
|
+
# Pass arguments to `create_automation` via a request object, either of type
|
|
2820
|
+
# {::Google::Cloud::Deploy::V1::CreateAutomationRequest} or an equivalent Hash.
|
|
2706
2821
|
#
|
|
2707
|
-
#
|
|
2708
|
-
#
|
|
2822
|
+
# @param request [::Google::Cloud::Deploy::V1::CreateAutomationRequest, ::Hash]
|
|
2823
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2824
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2825
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2826
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
2709
2827
|
#
|
|
2710
|
-
# @
|
|
2828
|
+
# @overload create_automation(parent: nil, automation_id: nil, automation: nil, request_id: nil, validate_only: nil)
|
|
2829
|
+
# Pass arguments to `create_automation` via keyword arguments. Note that at
|
|
2830
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2831
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2711
2832
|
#
|
|
2712
|
-
#
|
|
2713
|
-
#
|
|
2714
|
-
#
|
|
2715
|
-
#
|
|
2716
|
-
#
|
|
2717
|
-
#
|
|
2718
|
-
#
|
|
2833
|
+
# @param parent [::String]
|
|
2834
|
+
# Required. The parent collection in which the `Automation` should be
|
|
2835
|
+
# created. Format should be
|
|
2836
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
|
2837
|
+
# @param automation_id [::String]
|
|
2838
|
+
# Required. ID of the `Automation`.
|
|
2839
|
+
# @param automation [::Google::Cloud::Deploy::V1::Automation, ::Hash]
|
|
2840
|
+
# Required. The `Automation` to create.
|
|
2841
|
+
# @param request_id [::String]
|
|
2842
|
+
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
2843
|
+
# so that if you must retry your request, the server will know to ignore
|
|
2844
|
+
# the request if it has already been completed. The server will guarantee
|
|
2845
|
+
# that for at least 60 minutes since the first request.
|
|
2719
2846
|
#
|
|
2720
|
-
#
|
|
2721
|
-
#
|
|
2722
|
-
#
|
|
2723
|
-
#
|
|
2724
|
-
#
|
|
2847
|
+
# For example, consider a situation where you make an initial request and the
|
|
2848
|
+
# request times out. If you make the request again with the same request ID,
|
|
2849
|
+
# the server can check if original operation with the same request ID was
|
|
2850
|
+
# received, and if so, will ignore the second request. This prevents clients
|
|
2851
|
+
# from accidentally creating duplicate commitments.
|
|
2725
2852
|
#
|
|
2726
|
-
#
|
|
2727
|
-
#
|
|
2728
|
-
#
|
|
2729
|
-
#
|
|
2730
|
-
#
|
|
2731
|
-
#
|
|
2732
|
-
#
|
|
2733
|
-
#
|
|
2734
|
-
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
2735
|
-
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
2736
|
-
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
2737
|
-
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
|
2738
|
-
# * (`nil`) indicating no credentials
|
|
2739
|
-
# @return [::Object]
|
|
2740
|
-
# @!attribute [rw] scope
|
|
2741
|
-
# The OAuth scopes
|
|
2742
|
-
# @return [::Array<::String>]
|
|
2743
|
-
# @!attribute [rw] lib_name
|
|
2744
|
-
# The library name as recorded in instrumentation and logging
|
|
2745
|
-
# @return [::String]
|
|
2746
|
-
# @!attribute [rw] lib_version
|
|
2747
|
-
# The library version as recorded in instrumentation and logging
|
|
2748
|
-
# @return [::String]
|
|
2749
|
-
# @!attribute [rw] timeout
|
|
2750
|
-
# The call timeout in seconds.
|
|
2751
|
-
# @return [::Numeric]
|
|
2752
|
-
# @!attribute [rw] metadata
|
|
2753
|
-
# Additional headers to be sent with the call.
|
|
2754
|
-
# @return [::Hash{::Symbol=>::String}]
|
|
2755
|
-
# @!attribute [rw] retry_policy
|
|
2756
|
-
# The retry policy. The value is a hash with the following keys:
|
|
2757
|
-
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
2758
|
-
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
2759
|
-
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
2760
|
-
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
2761
|
-
# trigger a retry.
|
|
2762
|
-
# @return [::Hash]
|
|
2763
|
-
# @!attribute [rw] quota_project
|
|
2764
|
-
# A separate project against which to charge quota.
|
|
2765
|
-
# @return [::String]
|
|
2853
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
2854
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
2855
|
+
# @param validate_only [::Boolean]
|
|
2856
|
+
# Optional. If set to true, the request is validated and the user is provided
|
|
2857
|
+
# with an expected result, but no actual change is made.
|
|
2858
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
2859
|
+
# @yieldparam result [::Gapic::Operation]
|
|
2860
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
2766
2861
|
#
|
|
2767
|
-
|
|
2768
|
-
|
|
2862
|
+
# @return [::Gapic::Operation]
|
|
2863
|
+
#
|
|
2864
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
2865
|
+
#
|
|
2866
|
+
# @example Basic example
|
|
2867
|
+
# require "google/cloud/deploy/v1"
|
|
2868
|
+
#
|
|
2869
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2870
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
2871
|
+
#
|
|
2872
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2873
|
+
# request = Google::Cloud::Deploy::V1::CreateAutomationRequest.new
|
|
2874
|
+
#
|
|
2875
|
+
# # Call the create_automation method.
|
|
2876
|
+
# result = client.create_automation request
|
|
2877
|
+
#
|
|
2878
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
2879
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
2880
|
+
# # Here is how to wait for a response.
|
|
2881
|
+
# result.wait_until_done! timeout: 60
|
|
2882
|
+
# if result.response?
|
|
2883
|
+
# p result.response
|
|
2884
|
+
# else
|
|
2885
|
+
# puts "No response received."
|
|
2886
|
+
# end
|
|
2887
|
+
#
|
|
2888
|
+
def create_automation request, options = nil
|
|
2889
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
2769
2890
|
|
|
2770
|
-
|
|
2891
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateAutomationRequest
|
|
2771
2892
|
|
|
2772
|
-
|
|
2773
|
-
|
|
2774
|
-
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
2775
|
-
allowed.any? { |klass| klass === value }
|
|
2776
|
-
end
|
|
2777
|
-
config_attr :scope, nil, ::String, ::Array, nil
|
|
2778
|
-
config_attr :lib_name, nil, ::String, nil
|
|
2779
|
-
config_attr :lib_version, nil, ::String, nil
|
|
2780
|
-
config_attr :timeout, nil, ::Numeric, nil
|
|
2781
|
-
config_attr :metadata, nil, ::Hash, nil
|
|
2782
|
-
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
2783
|
-
config_attr :quota_project, nil, ::String, nil
|
|
2893
|
+
# Converts hash and nil to an options object
|
|
2894
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
2784
2895
|
|
|
2785
|
-
#
|
|
2786
|
-
|
|
2787
|
-
# are only used when this service is used as mixin, and only
|
|
2788
|
-
# by the host service.
|
|
2789
|
-
# @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
|
|
2790
|
-
config_attr :bindings_override, {}, ::Hash, nil
|
|
2896
|
+
# Customize the options with defaults
|
|
2897
|
+
call_metadata = @config.rpcs.create_automation.metadata.to_h
|
|
2791
2898
|
|
|
2792
|
-
#
|
|
2793
|
-
|
|
2794
|
-
@
|
|
2899
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
2900
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
2901
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
2902
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
2903
|
+
transports_version_send: [:rest]
|
|
2795
2904
|
|
|
2796
|
-
|
|
2797
|
-
end
|
|
2905
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
2798
2906
|
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
|
|
2803
|
-
|
|
2804
|
-
|
|
2805
|
-
|
|
2806
|
-
|
|
2807
|
-
|
|
2808
|
-
|
|
2907
|
+
options.apply_defaults timeout: @config.rpcs.create_automation.timeout,
|
|
2908
|
+
metadata: call_metadata,
|
|
2909
|
+
retry_policy: @config.rpcs.create_automation.retry_policy
|
|
2910
|
+
|
|
2911
|
+
options.apply_defaults timeout: @config.timeout,
|
|
2912
|
+
metadata: @config.metadata,
|
|
2913
|
+
retry_policy: @config.retry_policy
|
|
2914
|
+
|
|
2915
|
+
@cloud_deploy_stub.create_automation request, options do |result, operation|
|
|
2916
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
|
2917
|
+
yield result, operation if block_given?
|
|
2918
|
+
return result
|
|
2809
2919
|
end
|
|
2920
|
+
rescue ::Gapic::Rest::Error => e
|
|
2921
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
2922
|
+
end
|
|
2810
2923
|
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
|
|
2814
|
-
|
|
2815
|
-
|
|
2816
|
-
|
|
2817
|
-
|
|
2818
|
-
|
|
2819
|
-
|
|
2924
|
+
##
|
|
2925
|
+
# Updates the parameters of a single Automation resource.
|
|
2926
|
+
#
|
|
2927
|
+
# @overload update_automation(request, options = nil)
|
|
2928
|
+
# Pass arguments to `update_automation` via a request object, either of type
|
|
2929
|
+
# {::Google::Cloud::Deploy::V1::UpdateAutomationRequest} or an equivalent Hash.
|
|
2930
|
+
#
|
|
2931
|
+
# @param request [::Google::Cloud::Deploy::V1::UpdateAutomationRequest, ::Hash]
|
|
2932
|
+
# A request object representing the call parameters. Required. To specify no
|
|
2933
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
2934
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
2935
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
2936
|
+
#
|
|
2937
|
+
# @overload update_automation(update_mask: nil, automation: nil, request_id: nil, allow_missing: nil, validate_only: nil)
|
|
2938
|
+
# Pass arguments to `update_automation` via keyword arguments. Note that at
|
|
2939
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
2940
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
2941
|
+
#
|
|
2942
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
|
2943
|
+
# Required. Field mask is used to specify the fields to be overwritten in the
|
|
2944
|
+
# `Automation` resource by the update.
|
|
2945
|
+
# The fields specified in the update_mask are relative to the resource, not
|
|
2946
|
+
# the full request. A field will be overwritten if it is in the mask. If the
|
|
2947
|
+
# user does not provide a mask then all fields will be overwritten.
|
|
2948
|
+
# @param automation [::Google::Cloud::Deploy::V1::Automation, ::Hash]
|
|
2949
|
+
# Required. The `Automation` to update.
|
|
2950
|
+
# @param request_id [::String]
|
|
2951
|
+
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
2952
|
+
# so that if you must retry your request, the server will know to ignore
|
|
2953
|
+
# the request if it has already been completed. The server will guarantee
|
|
2954
|
+
# that for at least 60 minutes since the first request.
|
|
2955
|
+
#
|
|
2956
|
+
# For example, consider a situation where you make an initial request and the
|
|
2957
|
+
# request times out. If you make the request again with the same request ID,
|
|
2958
|
+
# the server can check if original operation with the same request ID was
|
|
2959
|
+
# received, and if so, will ignore the second request. This prevents clients
|
|
2960
|
+
# from accidentally creating duplicate commitments.
|
|
2961
|
+
#
|
|
2962
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
2963
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
2964
|
+
# @param allow_missing [::Boolean]
|
|
2965
|
+
# Optional. If set to true, updating a `Automation` that does not exist will
|
|
2966
|
+
# result in the creation of a new `Automation`.
|
|
2967
|
+
# @param validate_only [::Boolean]
|
|
2968
|
+
# Optional. If set to true, the request is validated and the user is provided
|
|
2969
|
+
# with an expected result, but no actual change is made.
|
|
2970
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
2971
|
+
# @yieldparam result [::Gapic::Operation]
|
|
2972
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
2973
|
+
#
|
|
2974
|
+
# @return [::Gapic::Operation]
|
|
2975
|
+
#
|
|
2976
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
2977
|
+
#
|
|
2978
|
+
# @example Basic example
|
|
2979
|
+
# require "google/cloud/deploy/v1"
|
|
2980
|
+
#
|
|
2981
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
2982
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
2983
|
+
#
|
|
2984
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
2985
|
+
# request = Google::Cloud::Deploy::V1::UpdateAutomationRequest.new
|
|
2986
|
+
#
|
|
2987
|
+
# # Call the update_automation method.
|
|
2988
|
+
# result = client.update_automation request
|
|
2989
|
+
#
|
|
2990
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
2991
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
2992
|
+
# # Here is how to wait for a response.
|
|
2993
|
+
# result.wait_until_done! timeout: 60
|
|
2994
|
+
# if result.response?
|
|
2995
|
+
# p result.response
|
|
2996
|
+
# else
|
|
2997
|
+
# puts "No response received."
|
|
2998
|
+
# end
|
|
2999
|
+
#
|
|
3000
|
+
def update_automation request, options = nil
|
|
3001
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3002
|
+
|
|
3003
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::UpdateAutomationRequest
|
|
3004
|
+
|
|
3005
|
+
# Converts hash and nil to an options object
|
|
3006
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3007
|
+
|
|
3008
|
+
# Customize the options with defaults
|
|
3009
|
+
call_metadata = @config.rpcs.update_automation.metadata.to_h
|
|
3010
|
+
|
|
3011
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3012
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3013
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3014
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
3015
|
+
transports_version_send: [:rest]
|
|
3016
|
+
|
|
3017
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3018
|
+
|
|
3019
|
+
options.apply_defaults timeout: @config.rpcs.update_automation.timeout,
|
|
3020
|
+
metadata: call_metadata,
|
|
3021
|
+
retry_policy: @config.rpcs.update_automation.retry_policy
|
|
3022
|
+
|
|
3023
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3024
|
+
metadata: @config.metadata,
|
|
3025
|
+
retry_policy: @config.retry_policy
|
|
3026
|
+
|
|
3027
|
+
@cloud_deploy_stub.update_automation request, options do |result, operation|
|
|
3028
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
|
3029
|
+
yield result, operation if block_given?
|
|
3030
|
+
return result
|
|
3031
|
+
end
|
|
3032
|
+
rescue ::Gapic::Rest::Error => e
|
|
3033
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3034
|
+
end
|
|
3035
|
+
|
|
3036
|
+
##
|
|
3037
|
+
# Deletes a single Automation resource.
|
|
3038
|
+
#
|
|
3039
|
+
# @overload delete_automation(request, options = nil)
|
|
3040
|
+
# Pass arguments to `delete_automation` via a request object, either of type
|
|
3041
|
+
# {::Google::Cloud::Deploy::V1::DeleteAutomationRequest} or an equivalent Hash.
|
|
3042
|
+
#
|
|
3043
|
+
# @param request [::Google::Cloud::Deploy::V1::DeleteAutomationRequest, ::Hash]
|
|
3044
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3045
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3046
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3047
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
3048
|
+
#
|
|
3049
|
+
# @overload delete_automation(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil)
|
|
3050
|
+
# Pass arguments to `delete_automation` via keyword arguments. Note that at
|
|
3051
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3052
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3053
|
+
#
|
|
3054
|
+
# @param name [::String]
|
|
3055
|
+
# Required. The name of the `Automation` to delete. Format should be
|
|
3056
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.
|
|
3057
|
+
# @param request_id [::String]
|
|
3058
|
+
# Optional. A request ID to identify requests. Specify a unique request ID
|
|
3059
|
+
# so that if you must retry your request, the server will know to ignore
|
|
3060
|
+
# the request if it has already been completed. The server will guarantee
|
|
3061
|
+
# that for at least 60 minutes after the first request.
|
|
3062
|
+
#
|
|
3063
|
+
# For example, consider a situation where you make an initial request and the
|
|
3064
|
+
# request times out. If you make the request again with the same request ID,
|
|
3065
|
+
# the server can check if original operation with the same request ID was
|
|
3066
|
+
# received, and if so, will ignore the second request. This prevents clients
|
|
3067
|
+
# from accidentally creating duplicate commitments.
|
|
3068
|
+
#
|
|
3069
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
|
3070
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
|
3071
|
+
# @param allow_missing [::Boolean]
|
|
3072
|
+
# Optional. If set to true, then deleting an already deleted or non-existing
|
|
3073
|
+
# `Automation` will succeed.
|
|
3074
|
+
# @param validate_only [::Boolean]
|
|
3075
|
+
# Optional. If set, validate the request and verify whether the resource
|
|
3076
|
+
# exists, but do not actually post it.
|
|
3077
|
+
# @param etag [::String]
|
|
3078
|
+
# Optional. The weak etag of the request.
|
|
3079
|
+
# This checksum is computed by the server based on the value of other
|
|
3080
|
+
# fields, and may be sent on update and delete requests to ensure the
|
|
3081
|
+
# client has an up-to-date value before proceeding.
|
|
3082
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
3083
|
+
# @yieldparam result [::Gapic::Operation]
|
|
3084
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
3085
|
+
#
|
|
3086
|
+
# @return [::Gapic::Operation]
|
|
3087
|
+
#
|
|
3088
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
3089
|
+
#
|
|
3090
|
+
# @example Basic example
|
|
3091
|
+
# require "google/cloud/deploy/v1"
|
|
3092
|
+
#
|
|
3093
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3094
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
3095
|
+
#
|
|
3096
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3097
|
+
# request = Google::Cloud::Deploy::V1::DeleteAutomationRequest.new
|
|
3098
|
+
#
|
|
3099
|
+
# # Call the delete_automation method.
|
|
3100
|
+
# result = client.delete_automation request
|
|
3101
|
+
#
|
|
3102
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
|
3103
|
+
# # check the status of an operation, cancel it, or wait for results.
|
|
3104
|
+
# # Here is how to wait for a response.
|
|
3105
|
+
# result.wait_until_done! timeout: 60
|
|
3106
|
+
# if result.response?
|
|
3107
|
+
# p result.response
|
|
3108
|
+
# else
|
|
3109
|
+
# puts "No response received."
|
|
3110
|
+
# end
|
|
3111
|
+
#
|
|
3112
|
+
def delete_automation request, options = nil
|
|
3113
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3114
|
+
|
|
3115
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::DeleteAutomationRequest
|
|
3116
|
+
|
|
3117
|
+
# Converts hash and nil to an options object
|
|
3118
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3119
|
+
|
|
3120
|
+
# Customize the options with defaults
|
|
3121
|
+
call_metadata = @config.rpcs.delete_automation.metadata.to_h
|
|
3122
|
+
|
|
3123
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3124
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3125
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3126
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
3127
|
+
transports_version_send: [:rest]
|
|
3128
|
+
|
|
3129
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3130
|
+
|
|
3131
|
+
options.apply_defaults timeout: @config.rpcs.delete_automation.timeout,
|
|
3132
|
+
metadata: call_metadata,
|
|
3133
|
+
retry_policy: @config.rpcs.delete_automation.retry_policy
|
|
3134
|
+
|
|
3135
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3136
|
+
metadata: @config.metadata,
|
|
3137
|
+
retry_policy: @config.retry_policy
|
|
3138
|
+
|
|
3139
|
+
@cloud_deploy_stub.delete_automation request, options do |result, operation|
|
|
3140
|
+
result = ::Gapic::Operation.new result, @operations_client, options: options
|
|
3141
|
+
yield result, operation if block_given?
|
|
3142
|
+
return result
|
|
3143
|
+
end
|
|
3144
|
+
rescue ::Gapic::Rest::Error => e
|
|
3145
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3146
|
+
end
|
|
3147
|
+
|
|
3148
|
+
##
|
|
3149
|
+
# Gets details of a single Automation.
|
|
3150
|
+
#
|
|
3151
|
+
# @overload get_automation(request, options = nil)
|
|
3152
|
+
# Pass arguments to `get_automation` via a request object, either of type
|
|
3153
|
+
# {::Google::Cloud::Deploy::V1::GetAutomationRequest} or an equivalent Hash.
|
|
3154
|
+
#
|
|
3155
|
+
# @param request [::Google::Cloud::Deploy::V1::GetAutomationRequest, ::Hash]
|
|
3156
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3157
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3158
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3159
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
3160
|
+
#
|
|
3161
|
+
# @overload get_automation(name: nil)
|
|
3162
|
+
# Pass arguments to `get_automation` via keyword arguments. Note that at
|
|
3163
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3164
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3165
|
+
#
|
|
3166
|
+
# @param name [::String]
|
|
3167
|
+
# Required. Name of the `Automation`. Format must be
|
|
3168
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.
|
|
3169
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
3170
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::Automation]
|
|
3171
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
3172
|
+
#
|
|
3173
|
+
# @return [::Google::Cloud::Deploy::V1::Automation]
|
|
3174
|
+
#
|
|
3175
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
3176
|
+
#
|
|
3177
|
+
# @example Basic example
|
|
3178
|
+
# require "google/cloud/deploy/v1"
|
|
3179
|
+
#
|
|
3180
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3181
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
3182
|
+
#
|
|
3183
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3184
|
+
# request = Google::Cloud::Deploy::V1::GetAutomationRequest.new
|
|
3185
|
+
#
|
|
3186
|
+
# # Call the get_automation method.
|
|
3187
|
+
# result = client.get_automation request
|
|
3188
|
+
#
|
|
3189
|
+
# # The returned object is of type Google::Cloud::Deploy::V1::Automation.
|
|
3190
|
+
# p result
|
|
3191
|
+
#
|
|
3192
|
+
def get_automation request, options = nil
|
|
3193
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3194
|
+
|
|
3195
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetAutomationRequest
|
|
3196
|
+
|
|
3197
|
+
# Converts hash and nil to an options object
|
|
3198
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3199
|
+
|
|
3200
|
+
# Customize the options with defaults
|
|
3201
|
+
call_metadata = @config.rpcs.get_automation.metadata.to_h
|
|
3202
|
+
|
|
3203
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3204
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3205
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3206
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
3207
|
+
transports_version_send: [:rest]
|
|
3208
|
+
|
|
3209
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3210
|
+
|
|
3211
|
+
options.apply_defaults timeout: @config.rpcs.get_automation.timeout,
|
|
3212
|
+
metadata: call_metadata,
|
|
3213
|
+
retry_policy: @config.rpcs.get_automation.retry_policy
|
|
3214
|
+
|
|
3215
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3216
|
+
metadata: @config.metadata,
|
|
3217
|
+
retry_policy: @config.retry_policy
|
|
3218
|
+
|
|
3219
|
+
@cloud_deploy_stub.get_automation request, options do |result, operation|
|
|
3220
|
+
yield result, operation if block_given?
|
|
3221
|
+
return result
|
|
3222
|
+
end
|
|
3223
|
+
rescue ::Gapic::Rest::Error => e
|
|
3224
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3225
|
+
end
|
|
3226
|
+
|
|
3227
|
+
##
|
|
3228
|
+
# Lists Automations in a given project and location.
|
|
3229
|
+
#
|
|
3230
|
+
# @overload list_automations(request, options = nil)
|
|
3231
|
+
# Pass arguments to `list_automations` via a request object, either of type
|
|
3232
|
+
# {::Google::Cloud::Deploy::V1::ListAutomationsRequest} or an equivalent Hash.
|
|
3233
|
+
#
|
|
3234
|
+
# @param request [::Google::Cloud::Deploy::V1::ListAutomationsRequest, ::Hash]
|
|
3235
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3236
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3237
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3238
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
3239
|
+
#
|
|
3240
|
+
# @overload list_automations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
|
|
3241
|
+
# Pass arguments to `list_automations` via keyword arguments. Note that at
|
|
3242
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3243
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3244
|
+
#
|
|
3245
|
+
# @param parent [::String]
|
|
3246
|
+
# Required. The parent, which owns this collection of automations. Format
|
|
3247
|
+
# must be
|
|
3248
|
+
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
|
3249
|
+
# @param page_size [::Integer]
|
|
3250
|
+
# The maximum number of automations to return. The service may return
|
|
3251
|
+
# fewer than this value. If unspecified, at most 50 automations will
|
|
3252
|
+
# be returned. The maximum value is 1000; values above 1000 will be set
|
|
3253
|
+
# to 1000.
|
|
3254
|
+
# @param page_token [::String]
|
|
3255
|
+
# A page token, received from a previous `ListAutomations` call.
|
|
3256
|
+
# Provide this to retrieve the subsequent page.
|
|
3257
|
+
#
|
|
3258
|
+
# When paginating, all other provided parameters match
|
|
3259
|
+
# the call that provided the page token.
|
|
3260
|
+
# @param filter [::String]
|
|
3261
|
+
# Filter automations to be returned. All fields can be used in the
|
|
3262
|
+
# filter.
|
|
3263
|
+
# @param order_by [::String]
|
|
3264
|
+
# Field to sort by.
|
|
3265
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
3266
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::ListAutomationsResponse]
|
|
3267
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
3268
|
+
#
|
|
3269
|
+
# @return [::Google::Cloud::Deploy::V1::ListAutomationsResponse]
|
|
3270
|
+
#
|
|
3271
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
3272
|
+
#
|
|
3273
|
+
# @example Basic example
|
|
3274
|
+
# require "google/cloud/deploy/v1"
|
|
3275
|
+
#
|
|
3276
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3277
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
3278
|
+
#
|
|
3279
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3280
|
+
# request = Google::Cloud::Deploy::V1::ListAutomationsRequest.new
|
|
3281
|
+
#
|
|
3282
|
+
# # Call the list_automations method.
|
|
3283
|
+
# result = client.list_automations request
|
|
3284
|
+
#
|
|
3285
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
3286
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
3287
|
+
# result.each do |item|
|
|
3288
|
+
# # Each element is of type ::Google::Cloud::Deploy::V1::Automation.
|
|
3289
|
+
# p item
|
|
3290
|
+
# end
|
|
3291
|
+
#
|
|
3292
|
+
def list_automations request, options = nil
|
|
3293
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3294
|
+
|
|
3295
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListAutomationsRequest
|
|
3296
|
+
|
|
3297
|
+
# Converts hash and nil to an options object
|
|
3298
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3299
|
+
|
|
3300
|
+
# Customize the options with defaults
|
|
3301
|
+
call_metadata = @config.rpcs.list_automations.metadata.to_h
|
|
3302
|
+
|
|
3303
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3304
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3305
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3306
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
3307
|
+
transports_version_send: [:rest]
|
|
3308
|
+
|
|
3309
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3310
|
+
|
|
3311
|
+
options.apply_defaults timeout: @config.rpcs.list_automations.timeout,
|
|
3312
|
+
metadata: call_metadata,
|
|
3313
|
+
retry_policy: @config.rpcs.list_automations.retry_policy
|
|
3314
|
+
|
|
3315
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3316
|
+
metadata: @config.metadata,
|
|
3317
|
+
retry_policy: @config.retry_policy
|
|
3318
|
+
|
|
3319
|
+
@cloud_deploy_stub.list_automations request, options do |result, operation|
|
|
3320
|
+
yield result, operation if block_given?
|
|
3321
|
+
return result
|
|
3322
|
+
end
|
|
3323
|
+
rescue ::Gapic::Rest::Error => e
|
|
3324
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3325
|
+
end
|
|
3326
|
+
|
|
3327
|
+
##
|
|
3328
|
+
# Gets details of a single AutomationRun.
|
|
3329
|
+
#
|
|
3330
|
+
# @overload get_automation_run(request, options = nil)
|
|
3331
|
+
# Pass arguments to `get_automation_run` via a request object, either of type
|
|
3332
|
+
# {::Google::Cloud::Deploy::V1::GetAutomationRunRequest} or an equivalent Hash.
|
|
3333
|
+
#
|
|
3334
|
+
# @param request [::Google::Cloud::Deploy::V1::GetAutomationRunRequest, ::Hash]
|
|
3335
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3336
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3337
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3338
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
3339
|
+
#
|
|
3340
|
+
# @overload get_automation_run(name: nil)
|
|
3341
|
+
# Pass arguments to `get_automation_run` via keyword arguments. Note that at
|
|
3342
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3343
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3344
|
+
#
|
|
3345
|
+
# @param name [::String]
|
|
3346
|
+
# Required. Name of the `AutomationRun`. Format must be
|
|
3347
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.
|
|
3348
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
3349
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::AutomationRun]
|
|
3350
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
3351
|
+
#
|
|
3352
|
+
# @return [::Google::Cloud::Deploy::V1::AutomationRun]
|
|
3353
|
+
#
|
|
3354
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
3355
|
+
#
|
|
3356
|
+
# @example Basic example
|
|
3357
|
+
# require "google/cloud/deploy/v1"
|
|
3358
|
+
#
|
|
3359
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3360
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
3361
|
+
#
|
|
3362
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3363
|
+
# request = Google::Cloud::Deploy::V1::GetAutomationRunRequest.new
|
|
3364
|
+
#
|
|
3365
|
+
# # Call the get_automation_run method.
|
|
3366
|
+
# result = client.get_automation_run request
|
|
3367
|
+
#
|
|
3368
|
+
# # The returned object is of type Google::Cloud::Deploy::V1::AutomationRun.
|
|
3369
|
+
# p result
|
|
3370
|
+
#
|
|
3371
|
+
def get_automation_run request, options = nil
|
|
3372
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3373
|
+
|
|
3374
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetAutomationRunRequest
|
|
3375
|
+
|
|
3376
|
+
# Converts hash and nil to an options object
|
|
3377
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3378
|
+
|
|
3379
|
+
# Customize the options with defaults
|
|
3380
|
+
call_metadata = @config.rpcs.get_automation_run.metadata.to_h
|
|
3381
|
+
|
|
3382
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3383
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3384
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3385
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
3386
|
+
transports_version_send: [:rest]
|
|
3387
|
+
|
|
3388
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3389
|
+
|
|
3390
|
+
options.apply_defaults timeout: @config.rpcs.get_automation_run.timeout,
|
|
3391
|
+
metadata: call_metadata,
|
|
3392
|
+
retry_policy: @config.rpcs.get_automation_run.retry_policy
|
|
3393
|
+
|
|
3394
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3395
|
+
metadata: @config.metadata,
|
|
3396
|
+
retry_policy: @config.retry_policy
|
|
3397
|
+
|
|
3398
|
+
@cloud_deploy_stub.get_automation_run request, options do |result, operation|
|
|
3399
|
+
yield result, operation if block_given?
|
|
3400
|
+
return result
|
|
3401
|
+
end
|
|
3402
|
+
rescue ::Gapic::Rest::Error => e
|
|
3403
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3404
|
+
end
|
|
3405
|
+
|
|
3406
|
+
##
|
|
3407
|
+
# Lists AutomationRuns in a given project and location.
|
|
3408
|
+
#
|
|
3409
|
+
# @overload list_automation_runs(request, options = nil)
|
|
3410
|
+
# Pass arguments to `list_automation_runs` via a request object, either of type
|
|
3411
|
+
# {::Google::Cloud::Deploy::V1::ListAutomationRunsRequest} or an equivalent Hash.
|
|
3412
|
+
#
|
|
3413
|
+
# @param request [::Google::Cloud::Deploy::V1::ListAutomationRunsRequest, ::Hash]
|
|
3414
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3415
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3416
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3417
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
3418
|
+
#
|
|
3419
|
+
# @overload list_automation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
|
|
3420
|
+
# Pass arguments to `list_automation_runs` via keyword arguments. Note that at
|
|
3421
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3422
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3423
|
+
#
|
|
3424
|
+
# @param parent [::String]
|
|
3425
|
+
# Required. The parent, which owns this collection of automationRuns. Format
|
|
3426
|
+
# must be
|
|
3427
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}`.
|
|
3428
|
+
# @param page_size [::Integer]
|
|
3429
|
+
# The maximum number of automationRuns to return. The service may return
|
|
3430
|
+
# fewer than this value. If unspecified, at most 50 automationRuns will
|
|
3431
|
+
# be returned. The maximum value is 1000; values above 1000 will be set
|
|
3432
|
+
# to 1000.
|
|
3433
|
+
# @param page_token [::String]
|
|
3434
|
+
# A page token, received from a previous `ListAutomationRuns` call.
|
|
3435
|
+
# Provide this to retrieve the subsequent page.
|
|
3436
|
+
#
|
|
3437
|
+
# When paginating, all other provided parameters match
|
|
3438
|
+
# the call that provided the page token.
|
|
3439
|
+
# @param filter [::String]
|
|
3440
|
+
# Filter automationRuns to be returned. All fields can be used in the
|
|
3441
|
+
# filter.
|
|
3442
|
+
# @param order_by [::String]
|
|
3443
|
+
# Field to sort by.
|
|
3444
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
3445
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::ListAutomationRunsResponse]
|
|
3446
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
3447
|
+
#
|
|
3448
|
+
# @return [::Google::Cloud::Deploy::V1::ListAutomationRunsResponse]
|
|
3449
|
+
#
|
|
3450
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
3451
|
+
#
|
|
3452
|
+
# @example Basic example
|
|
3453
|
+
# require "google/cloud/deploy/v1"
|
|
3454
|
+
#
|
|
3455
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3456
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
3457
|
+
#
|
|
3458
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3459
|
+
# request = Google::Cloud::Deploy::V1::ListAutomationRunsRequest.new
|
|
3460
|
+
#
|
|
3461
|
+
# # Call the list_automation_runs method.
|
|
3462
|
+
# result = client.list_automation_runs request
|
|
3463
|
+
#
|
|
3464
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
|
3465
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
|
3466
|
+
# result.each do |item|
|
|
3467
|
+
# # Each element is of type ::Google::Cloud::Deploy::V1::AutomationRun.
|
|
3468
|
+
# p item
|
|
3469
|
+
# end
|
|
3470
|
+
#
|
|
3471
|
+
def list_automation_runs request, options = nil
|
|
3472
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3473
|
+
|
|
3474
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListAutomationRunsRequest
|
|
3475
|
+
|
|
3476
|
+
# Converts hash and nil to an options object
|
|
3477
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3478
|
+
|
|
3479
|
+
# Customize the options with defaults
|
|
3480
|
+
call_metadata = @config.rpcs.list_automation_runs.metadata.to_h
|
|
3481
|
+
|
|
3482
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3483
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3484
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3485
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
3486
|
+
transports_version_send: [:rest]
|
|
3487
|
+
|
|
3488
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3489
|
+
|
|
3490
|
+
options.apply_defaults timeout: @config.rpcs.list_automation_runs.timeout,
|
|
3491
|
+
metadata: call_metadata,
|
|
3492
|
+
retry_policy: @config.rpcs.list_automation_runs.retry_policy
|
|
3493
|
+
|
|
3494
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3495
|
+
metadata: @config.metadata,
|
|
3496
|
+
retry_policy: @config.retry_policy
|
|
3497
|
+
|
|
3498
|
+
@cloud_deploy_stub.list_automation_runs request, options do |result, operation|
|
|
3499
|
+
yield result, operation if block_given?
|
|
3500
|
+
return result
|
|
3501
|
+
end
|
|
3502
|
+
rescue ::Gapic::Rest::Error => e
|
|
3503
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3504
|
+
end
|
|
3505
|
+
|
|
3506
|
+
##
|
|
3507
|
+
# Cancels an AutomationRun. The `state` of the `AutomationRun` after
|
|
3508
|
+
# cancelling is `CANCELLED`. `CancelAutomationRun` can be called on
|
|
3509
|
+
# AutomationRun in the state `IN_PROGRESS` and `PENDING`; AutomationRun
|
|
3510
|
+
# in a different state returns an `FAILED_PRECONDITION` error.
|
|
3511
|
+
#
|
|
3512
|
+
# @overload cancel_automation_run(request, options = nil)
|
|
3513
|
+
# Pass arguments to `cancel_automation_run` via a request object, either of type
|
|
3514
|
+
# {::Google::Cloud::Deploy::V1::CancelAutomationRunRequest} or an equivalent Hash.
|
|
3515
|
+
#
|
|
3516
|
+
# @param request [::Google::Cloud::Deploy::V1::CancelAutomationRunRequest, ::Hash]
|
|
3517
|
+
# A request object representing the call parameters. Required. To specify no
|
|
3518
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
|
3519
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
|
3520
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
|
3521
|
+
#
|
|
3522
|
+
# @overload cancel_automation_run(name: nil)
|
|
3523
|
+
# Pass arguments to `cancel_automation_run` via keyword arguments. Note that at
|
|
3524
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
3525
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
3526
|
+
#
|
|
3527
|
+
# @param name [::String]
|
|
3528
|
+
# Required. Name of the `AutomationRun`. Format is
|
|
3529
|
+
# `projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}`.
|
|
3530
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
|
3531
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::CancelAutomationRunResponse]
|
|
3532
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
|
3533
|
+
#
|
|
3534
|
+
# @return [::Google::Cloud::Deploy::V1::CancelAutomationRunResponse]
|
|
3535
|
+
#
|
|
3536
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
|
3537
|
+
#
|
|
3538
|
+
# @example Basic example
|
|
3539
|
+
# require "google/cloud/deploy/v1"
|
|
3540
|
+
#
|
|
3541
|
+
# # Create a client object. The client can be reused for multiple calls.
|
|
3542
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
|
|
3543
|
+
#
|
|
3544
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
|
3545
|
+
# request = Google::Cloud::Deploy::V1::CancelAutomationRunRequest.new
|
|
3546
|
+
#
|
|
3547
|
+
# # Call the cancel_automation_run method.
|
|
3548
|
+
# result = client.cancel_automation_run request
|
|
3549
|
+
#
|
|
3550
|
+
# # The returned object is of type Google::Cloud::Deploy::V1::CancelAutomationRunResponse.
|
|
3551
|
+
# p result
|
|
3552
|
+
#
|
|
3553
|
+
def cancel_automation_run request, options = nil
|
|
3554
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
|
3555
|
+
|
|
3556
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CancelAutomationRunRequest
|
|
3557
|
+
|
|
3558
|
+
# Converts hash and nil to an options object
|
|
3559
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
|
3560
|
+
|
|
3561
|
+
# Customize the options with defaults
|
|
3562
|
+
call_metadata = @config.rpcs.cancel_automation_run.metadata.to_h
|
|
3563
|
+
|
|
3564
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
|
3565
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
|
3566
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
|
3567
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
|
3568
|
+
transports_version_send: [:rest]
|
|
3569
|
+
|
|
3570
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
|
3571
|
+
|
|
3572
|
+
options.apply_defaults timeout: @config.rpcs.cancel_automation_run.timeout,
|
|
3573
|
+
metadata: call_metadata,
|
|
3574
|
+
retry_policy: @config.rpcs.cancel_automation_run.retry_policy
|
|
3575
|
+
|
|
3576
|
+
options.apply_defaults timeout: @config.timeout,
|
|
3577
|
+
metadata: @config.metadata,
|
|
3578
|
+
retry_policy: @config.retry_policy
|
|
3579
|
+
|
|
3580
|
+
@cloud_deploy_stub.cancel_automation_run request, options do |result, operation|
|
|
3581
|
+
yield result, operation if block_given?
|
|
3582
|
+
return result
|
|
3583
|
+
end
|
|
3584
|
+
rescue ::Gapic::Rest::Error => e
|
|
3585
|
+
raise ::Google::Cloud::Error.from_error(e)
|
|
3586
|
+
end
|
|
3587
|
+
|
|
3588
|
+
##
|
|
3589
|
+
# Configuration class for the CloudDeploy REST API.
|
|
3590
|
+
#
|
|
3591
|
+
# This class represents the configuration for CloudDeploy REST,
|
|
3592
|
+
# providing control over timeouts, retry behavior, logging, transport
|
|
3593
|
+
# parameters, and other low-level controls. Certain parameters can also be
|
|
3594
|
+
# applied individually to specific RPCs. See
|
|
3595
|
+
# {::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client::Configuration::Rpcs}
|
|
3596
|
+
# for a list of RPCs that can be configured independently.
|
|
3597
|
+
#
|
|
3598
|
+
# Configuration can be applied globally to all clients, or to a single client
|
|
3599
|
+
# on construction.
|
|
3600
|
+
#
|
|
3601
|
+
# @example
|
|
3602
|
+
#
|
|
3603
|
+
# # Modify the global config, setting the timeout for
|
|
3604
|
+
# # list_delivery_pipelines to 20 seconds,
|
|
3605
|
+
# # and all remaining timeouts to 10 seconds.
|
|
3606
|
+
# ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.configure do |config|
|
|
3607
|
+
# config.timeout = 10.0
|
|
3608
|
+
# config.rpcs.list_delivery_pipelines.timeout = 20.0
|
|
3609
|
+
# end
|
|
3610
|
+
#
|
|
3611
|
+
# # Apply the above configuration only to a new client.
|
|
3612
|
+
# client = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new do |config|
|
|
3613
|
+
# config.timeout = 10.0
|
|
3614
|
+
# config.rpcs.list_delivery_pipelines.timeout = 20.0
|
|
3615
|
+
# end
|
|
3616
|
+
#
|
|
3617
|
+
# @!attribute [rw] endpoint
|
|
3618
|
+
# The hostname or hostname:port of the service endpoint.
|
|
3619
|
+
# Defaults to `"clouddeploy.googleapis.com"`.
|
|
3620
|
+
# @return [::String]
|
|
3621
|
+
# @!attribute [rw] credentials
|
|
3622
|
+
# Credentials to send with calls. You may provide any of the following types:
|
|
3623
|
+
# * (`String`) The path to a service account key file in JSON format
|
|
3624
|
+
# * (`Hash`) A service account key as a Hash
|
|
3625
|
+
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
|
3626
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
|
3627
|
+
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
|
3628
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
|
3629
|
+
# * (`nil`) indicating no credentials
|
|
3630
|
+
# @return [::Object]
|
|
3631
|
+
# @!attribute [rw] scope
|
|
3632
|
+
# The OAuth scopes
|
|
3633
|
+
# @return [::Array<::String>]
|
|
3634
|
+
# @!attribute [rw] lib_name
|
|
3635
|
+
# The library name as recorded in instrumentation and logging
|
|
3636
|
+
# @return [::String]
|
|
3637
|
+
# @!attribute [rw] lib_version
|
|
3638
|
+
# The library version as recorded in instrumentation and logging
|
|
3639
|
+
# @return [::String]
|
|
3640
|
+
# @!attribute [rw] timeout
|
|
3641
|
+
# The call timeout in seconds.
|
|
3642
|
+
# @return [::Numeric]
|
|
3643
|
+
# @!attribute [rw] metadata
|
|
3644
|
+
# Additional headers to be sent with the call.
|
|
3645
|
+
# @return [::Hash{::Symbol=>::String}]
|
|
3646
|
+
# @!attribute [rw] retry_policy
|
|
3647
|
+
# The retry policy. The value is a hash with the following keys:
|
|
3648
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
3649
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
3650
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
3651
|
+
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
|
|
3652
|
+
# trigger a retry.
|
|
3653
|
+
# @return [::Hash]
|
|
3654
|
+
# @!attribute [rw] quota_project
|
|
3655
|
+
# A separate project against which to charge quota.
|
|
3656
|
+
# @return [::String]
|
|
3657
|
+
#
|
|
3658
|
+
class Configuration
|
|
3659
|
+
extend ::Gapic::Config
|
|
3660
|
+
|
|
3661
|
+
DEFAULT_ENDPOINT = "clouddeploy.googleapis.com"
|
|
3662
|
+
|
|
3663
|
+
config_attr :endpoint, DEFAULT_ENDPOINT, ::String
|
|
3664
|
+
config_attr :credentials, nil do |value|
|
|
3665
|
+
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
3666
|
+
allowed.any? { |klass| klass === value }
|
|
3667
|
+
end
|
|
3668
|
+
config_attr :scope, nil, ::String, ::Array, nil
|
|
3669
|
+
config_attr :lib_name, nil, ::String, nil
|
|
3670
|
+
config_attr :lib_version, nil, ::String, nil
|
|
3671
|
+
config_attr :timeout, nil, ::Numeric, nil
|
|
3672
|
+
config_attr :metadata, nil, ::Hash, nil
|
|
3673
|
+
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
3674
|
+
config_attr :quota_project, nil, ::String, nil
|
|
3675
|
+
|
|
3676
|
+
# @private
|
|
3677
|
+
# Overrides for http bindings for the RPCs of this service
|
|
3678
|
+
# are only used when this service is used as mixin, and only
|
|
3679
|
+
# by the host service.
|
|
3680
|
+
# @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
|
|
3681
|
+
config_attr :bindings_override, {}, ::Hash, nil
|
|
3682
|
+
|
|
3683
|
+
# @private
|
|
3684
|
+
def initialize parent_config = nil
|
|
3685
|
+
@parent_config = parent_config unless parent_config.nil?
|
|
3686
|
+
|
|
3687
|
+
yield self if block_given?
|
|
3688
|
+
end
|
|
3689
|
+
|
|
3690
|
+
##
|
|
3691
|
+
# Configurations for individual RPCs
|
|
3692
|
+
# @return [Rpcs]
|
|
3693
|
+
#
|
|
3694
|
+
def rpcs
|
|
3695
|
+
@rpcs ||= begin
|
|
3696
|
+
parent_rpcs = nil
|
|
3697
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
3698
|
+
Rpcs.new parent_rpcs
|
|
3699
|
+
end
|
|
3700
|
+
end
|
|
3701
|
+
|
|
3702
|
+
##
|
|
3703
|
+
# Configuration RPC class for the CloudDeploy API.
|
|
3704
|
+
#
|
|
3705
|
+
# Includes fields providing the configuration for each RPC in this service.
|
|
3706
|
+
# Each configuration object is of type `Gapic::Config::Method` and includes
|
|
3707
|
+
# the following configuration fields:
|
|
3708
|
+
#
|
|
3709
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
|
3710
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
|
|
2820
3711
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
|
2821
3712
|
# include the following keys:
|
|
2822
3713
|
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
@@ -2857,6 +3748,11 @@ module Google
|
|
|
2857
3748
|
#
|
|
2858
3749
|
attr_reader :list_targets
|
|
2859
3750
|
##
|
|
3751
|
+
# RPC-specific configuration for `rollback_target`
|
|
3752
|
+
# @return [::Gapic::Config::Method]
|
|
3753
|
+
#
|
|
3754
|
+
attr_reader :rollback_target
|
|
3755
|
+
##
|
|
2860
3756
|
# RPC-specific configuration for `get_target`
|
|
2861
3757
|
# @return [::Gapic::Config::Method]
|
|
2862
3758
|
#
|
|
@@ -2956,6 +3852,46 @@ module Google
|
|
|
2956
3852
|
# @return [::Gapic::Config::Method]
|
|
2957
3853
|
#
|
|
2958
3854
|
attr_reader :get_config
|
|
3855
|
+
##
|
|
3856
|
+
# RPC-specific configuration for `create_automation`
|
|
3857
|
+
# @return [::Gapic::Config::Method]
|
|
3858
|
+
#
|
|
3859
|
+
attr_reader :create_automation
|
|
3860
|
+
##
|
|
3861
|
+
# RPC-specific configuration for `update_automation`
|
|
3862
|
+
# @return [::Gapic::Config::Method]
|
|
3863
|
+
#
|
|
3864
|
+
attr_reader :update_automation
|
|
3865
|
+
##
|
|
3866
|
+
# RPC-specific configuration for `delete_automation`
|
|
3867
|
+
# @return [::Gapic::Config::Method]
|
|
3868
|
+
#
|
|
3869
|
+
attr_reader :delete_automation
|
|
3870
|
+
##
|
|
3871
|
+
# RPC-specific configuration for `get_automation`
|
|
3872
|
+
# @return [::Gapic::Config::Method]
|
|
3873
|
+
#
|
|
3874
|
+
attr_reader :get_automation
|
|
3875
|
+
##
|
|
3876
|
+
# RPC-specific configuration for `list_automations`
|
|
3877
|
+
# @return [::Gapic::Config::Method]
|
|
3878
|
+
#
|
|
3879
|
+
attr_reader :list_automations
|
|
3880
|
+
##
|
|
3881
|
+
# RPC-specific configuration for `get_automation_run`
|
|
3882
|
+
# @return [::Gapic::Config::Method]
|
|
3883
|
+
#
|
|
3884
|
+
attr_reader :get_automation_run
|
|
3885
|
+
##
|
|
3886
|
+
# RPC-specific configuration for `list_automation_runs`
|
|
3887
|
+
# @return [::Gapic::Config::Method]
|
|
3888
|
+
#
|
|
3889
|
+
attr_reader :list_automation_runs
|
|
3890
|
+
##
|
|
3891
|
+
# RPC-specific configuration for `cancel_automation_run`
|
|
3892
|
+
# @return [::Gapic::Config::Method]
|
|
3893
|
+
#
|
|
3894
|
+
attr_reader :cancel_automation_run
|
|
2959
3895
|
|
|
2960
3896
|
# @private
|
|
2961
3897
|
def initialize parent_rpcs = nil
|
|
@@ -2971,6 +3907,8 @@ module Google
|
|
|
2971
3907
|
@delete_delivery_pipeline = ::Gapic::Config::Method.new delete_delivery_pipeline_config
|
|
2972
3908
|
list_targets_config = parent_rpcs.list_targets if parent_rpcs.respond_to? :list_targets
|
|
2973
3909
|
@list_targets = ::Gapic::Config::Method.new list_targets_config
|
|
3910
|
+
rollback_target_config = parent_rpcs.rollback_target if parent_rpcs.respond_to? :rollback_target
|
|
3911
|
+
@rollback_target = ::Gapic::Config::Method.new rollback_target_config
|
|
2974
3912
|
get_target_config = parent_rpcs.get_target if parent_rpcs.respond_to? :get_target
|
|
2975
3913
|
@get_target = ::Gapic::Config::Method.new get_target_config
|
|
2976
3914
|
create_target_config = parent_rpcs.create_target if parent_rpcs.respond_to? :create_target
|
|
@@ -3011,6 +3949,22 @@ module Google
|
|
|
3011
3949
|
@terminate_job_run = ::Gapic::Config::Method.new terminate_job_run_config
|
|
3012
3950
|
get_config_config = parent_rpcs.get_config if parent_rpcs.respond_to? :get_config
|
|
3013
3951
|
@get_config = ::Gapic::Config::Method.new get_config_config
|
|
3952
|
+
create_automation_config = parent_rpcs.create_automation if parent_rpcs.respond_to? :create_automation
|
|
3953
|
+
@create_automation = ::Gapic::Config::Method.new create_automation_config
|
|
3954
|
+
update_automation_config = parent_rpcs.update_automation if parent_rpcs.respond_to? :update_automation
|
|
3955
|
+
@update_automation = ::Gapic::Config::Method.new update_automation_config
|
|
3956
|
+
delete_automation_config = parent_rpcs.delete_automation if parent_rpcs.respond_to? :delete_automation
|
|
3957
|
+
@delete_automation = ::Gapic::Config::Method.new delete_automation_config
|
|
3958
|
+
get_automation_config = parent_rpcs.get_automation if parent_rpcs.respond_to? :get_automation
|
|
3959
|
+
@get_automation = ::Gapic::Config::Method.new get_automation_config
|
|
3960
|
+
list_automations_config = parent_rpcs.list_automations if parent_rpcs.respond_to? :list_automations
|
|
3961
|
+
@list_automations = ::Gapic::Config::Method.new list_automations_config
|
|
3962
|
+
get_automation_run_config = parent_rpcs.get_automation_run if parent_rpcs.respond_to? :get_automation_run
|
|
3963
|
+
@get_automation_run = ::Gapic::Config::Method.new get_automation_run_config
|
|
3964
|
+
list_automation_runs_config = parent_rpcs.list_automation_runs if parent_rpcs.respond_to? :list_automation_runs
|
|
3965
|
+
@list_automation_runs = ::Gapic::Config::Method.new list_automation_runs_config
|
|
3966
|
+
cancel_automation_run_config = parent_rpcs.cancel_automation_run if parent_rpcs.respond_to? :cancel_automation_run
|
|
3967
|
+
@cancel_automation_run = ::Gapic::Config::Method.new cancel_automation_run_config
|
|
3014
3968
|
|
|
3015
3969
|
yield self if block_given?
|
|
3016
3970
|
end
|