google-cloud-deploy-v1 1.0.0 → 1.1.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.
- checksums.yaml +4 -4
- data/lib/google/cloud/deploy/v1/cloud_deploy/client.rb +674 -48
- data/lib/google/cloud/deploy/v1/cloud_deploy/paths.rb +19 -0
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb +638 -48
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/service_stub.rb +297 -0
- data/lib/google/cloud/deploy/v1/cloud_deploy_pb.rb +21 -1
- data/lib/google/cloud/deploy/v1/cloud_deploy_services_pb.rb +10 -0
- data/lib/google/cloud/deploy/v1/customtargettype_notification_payload_pb.rb +44 -0
- data/lib/google/cloud/deploy/v1/deploypolicy_evaluation_payload_pb.rb +46 -0
- data/lib/google/cloud/deploy/v1/deploypolicy_notification_payload_pb.rb +44 -0
- data/lib/google/cloud/deploy/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -10
- data/proto_docs/google/api/resource.rb +7 -2
- data/proto_docs/google/cloud/deploy/v1/cloud_deploy.rb +537 -46
- data/proto_docs/google/cloud/deploy/v1/customtargettype_notification_payload.rb +46 -0
- data/proto_docs/google/cloud/deploy/v1/deploypolicy_evaluation_payload.rb +106 -0
- data/proto_docs/google/cloud/deploy/v1/deploypolicy_notification_payload.rb +47 -0
- data/proto_docs/google/type/date.rb +1 -1
- data/proto_docs/google/type/dayofweek.rb +49 -0
- data/proto_docs/google/type/timeofday.rb +45 -0
- metadata +10 -2
@@ -135,6 +135,22 @@ module Google
|
|
135
135
|
|
136
136
|
default_config.rpcs.abandon_release.timeout = 60.0
|
137
137
|
|
138
|
+
default_config.rpcs.create_deploy_policy.timeout = 60.0
|
139
|
+
|
140
|
+
default_config.rpcs.update_deploy_policy.timeout = 60.0
|
141
|
+
|
142
|
+
default_config.rpcs.delete_deploy_policy.timeout = 60.0
|
143
|
+
|
144
|
+
default_config.rpcs.list_deploy_policies.timeout = 60.0
|
145
|
+
default_config.rpcs.list_deploy_policies.retry_policy = {
|
146
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
147
|
+
}
|
148
|
+
|
149
|
+
default_config.rpcs.get_deploy_policy.timeout = 60.0
|
150
|
+
default_config.rpcs.get_deploy_policy.retry_policy = {
|
151
|
+
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
152
|
+
}
|
153
|
+
|
138
154
|
default_config.rpcs.approve_rollout.timeout = 60.0
|
139
155
|
|
140
156
|
default_config.rpcs.advance_rollout.timeout = 60.0
|
@@ -551,9 +567,8 @@ module Google
|
|
551
567
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
552
568
|
#
|
553
569
|
# @param parent [::String]
|
554
|
-
# Required. The parent collection in which the `DeliveryPipeline`
|
555
|
-
# created.
|
556
|
-
# `projects/{project_id}/locations/{location_name}`.
|
570
|
+
# Required. The parent collection in which the `DeliveryPipeline` must be
|
571
|
+
# created. The format is `projects/{project_id}/locations/{location_name}`.
|
557
572
|
# @param delivery_pipeline_id [::String]
|
558
573
|
# Required. ID of the `DeliveryPipeline`.
|
559
574
|
# @param delivery_pipeline [::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash]
|
@@ -668,11 +683,11 @@ module Google
|
|
668
683
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
669
684
|
#
|
670
685
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
671
|
-
# Required. Field mask is used to specify the fields to be overwritten
|
672
|
-
# `DeliveryPipeline` resource
|
673
|
-
#
|
674
|
-
#
|
675
|
-
#
|
686
|
+
# Required. Field mask is used to specify the fields to be overwritten by the
|
687
|
+
# update in the `DeliveryPipeline` resource. The fields specified in the
|
688
|
+
# update_mask are relative to the resource, not the full request. A field
|
689
|
+
# will be overwritten if it's in the mask. If the user doesn't provide a mask
|
690
|
+
# then all fields are overwritten.
|
676
691
|
# @param delivery_pipeline [::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash]
|
677
692
|
# Required. The `DeliveryPipeline` to update.
|
678
693
|
# @param request_id [::String]
|
@@ -788,7 +803,7 @@ module Google
|
|
788
803
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
789
804
|
#
|
790
805
|
# @param name [::String]
|
791
|
-
# Required. The name of the `DeliveryPipeline` to delete.
|
806
|
+
# Required. The name of the `DeliveryPipeline` to delete. The format is
|
792
807
|
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
793
808
|
# @param request_id [::String]
|
794
809
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
@@ -1014,14 +1029,14 @@ module Google
|
|
1014
1029
|
# @param options [::Gapic::CallOptions, ::Hash]
|
1015
1030
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
1016
1031
|
#
|
1017
|
-
# @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)
|
1032
|
+
# @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, override_deploy_policy: nil)
|
1018
1033
|
# Pass arguments to `rollback_target` via keyword arguments. Note that at
|
1019
1034
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
1020
1035
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1021
1036
|
#
|
1022
1037
|
# @param name [::String]
|
1023
|
-
# Required. The `DeliveryPipeline` for which the rollback `Rollout`
|
1024
|
-
# created.
|
1038
|
+
# Required. The `DeliveryPipeline` for which the rollback `Rollout` must be
|
1039
|
+
# created. The format is
|
1025
1040
|
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
1026
1041
|
# @param target_id [::String]
|
1027
1042
|
# Required. ID of the `Target` that is being rolled back.
|
@@ -1039,6 +1054,9 @@ module Google
|
|
1039
1054
|
# @param validate_only [::Boolean]
|
1040
1055
|
# Optional. If set to true, the request is validated and the user is provided
|
1041
1056
|
# with a `RollbackTargetResponse`.
|
1057
|
+
# @param override_deploy_policy [::Array<::String>]
|
1058
|
+
# Optional. Deploy policies to override. Format is
|
1059
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deploy_policy}`.
|
1042
1060
|
#
|
1043
1061
|
# @yield [response, operation] Access the result along with the RPC operation
|
1044
1062
|
# @yieldparam response [::Google::Cloud::Deploy::V1::RollbackTargetResponse]
|
@@ -1211,8 +1229,8 @@ module Google
|
|
1211
1229
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1212
1230
|
#
|
1213
1231
|
# @param parent [::String]
|
1214
|
-
# Required. The parent collection in which the `Target`
|
1215
|
-
#
|
1232
|
+
# Required. The parent collection in which the `Target` must be created.
|
1233
|
+
# The format is
|
1216
1234
|
# `projects/{project_id}/locations/{location_name}`.
|
1217
1235
|
# @param target_id [::String]
|
1218
1236
|
# Required. ID of the `Target`.
|
@@ -1328,11 +1346,11 @@ module Google
|
|
1328
1346
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1329
1347
|
#
|
1330
1348
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1331
|
-
# Required. Field mask is used to specify the fields to be overwritten
|
1332
|
-
# Target resource
|
1333
|
-
#
|
1334
|
-
#
|
1335
|
-
#
|
1349
|
+
# Required. Field mask is used to specify the fields to be overwritten by the
|
1350
|
+
# update in the `Target` resource. The fields specified in the update_mask
|
1351
|
+
# are relative to the resource, not the full request. A field will be
|
1352
|
+
# overwritten if it's in the mask. If the user doesn't provide a mask then
|
1353
|
+
# all fields are overwritten.
|
1336
1354
|
# @param target [::Google::Cloud::Deploy::V1::Target, ::Hash]
|
1337
1355
|
# Required. The `Target` to update.
|
1338
1356
|
# @param request_id [::String]
|
@@ -1448,7 +1466,7 @@ module Google
|
|
1448
1466
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1449
1467
|
#
|
1450
1468
|
# @param name [::String]
|
1451
|
-
# Required. The name of the `Target` to delete.
|
1469
|
+
# Required. The name of the `Target` to delete. The format is
|
1452
1470
|
# `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
|
1453
1471
|
# @param request_id [::String]
|
1454
1472
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
@@ -1763,9 +1781,8 @@ module Google
|
|
1763
1781
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1764
1782
|
#
|
1765
1783
|
# @param parent [::String]
|
1766
|
-
# Required. The parent collection in which the `CustomTargetType`
|
1767
|
-
# created.
|
1768
|
-
# `projects/{project_id}/locations/{location_name}`.
|
1784
|
+
# Required. The parent collection in which the `CustomTargetType` must be
|
1785
|
+
# created. The format is `projects/{project_id}/locations/{location_name}`.
|
1769
1786
|
# @param custom_target_type_id [::String]
|
1770
1787
|
# Required. ID of the `CustomTargetType`.
|
1771
1788
|
# @param custom_target_type [::Google::Cloud::Deploy::V1::CustomTargetType, ::Hash]
|
@@ -1880,11 +1897,11 @@ module Google
|
|
1880
1897
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1881
1898
|
#
|
1882
1899
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
1883
|
-
# Required. Field mask is used to specify the fields to be overwritten
|
1884
|
-
# `CustomTargetType` resource
|
1885
|
-
#
|
1886
|
-
#
|
1887
|
-
#
|
1900
|
+
# Required. Field mask is used to specify the fields to be overwritten by the
|
1901
|
+
# update in the `CustomTargetType` resource. The fields specified in the
|
1902
|
+
# update_mask are relative to the resource, not the full request. A field
|
1903
|
+
# will be overwritten if it's in the mask. If the user doesn't provide a mask
|
1904
|
+
# then all fields are overwritten.
|
1888
1905
|
# @param custom_target_type [::Google::Cloud::Deploy::V1::CustomTargetType, ::Hash]
|
1889
1906
|
# Required. The `CustomTargetType` to update.
|
1890
1907
|
# @param request_id [::String]
|
@@ -2309,14 +2326,14 @@ module Google
|
|
2309
2326
|
# @param options [::Gapic::CallOptions, ::Hash]
|
2310
2327
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2311
2328
|
#
|
2312
|
-
# @overload create_release(parent: nil, release_id: nil, release: nil, request_id: nil, validate_only: nil)
|
2329
|
+
# @overload create_release(parent: nil, release_id: nil, release: nil, request_id: nil, validate_only: nil, override_deploy_policy: nil)
|
2313
2330
|
# Pass arguments to `create_release` via keyword arguments. Note that at
|
2314
2331
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
2315
2332
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2316
2333
|
#
|
2317
2334
|
# @param parent [::String]
|
2318
|
-
# Required. The parent collection in which the `Release`
|
2319
|
-
#
|
2335
|
+
# Required. The parent collection in which the `Release` is created.
|
2336
|
+
# The format is
|
2320
2337
|
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
2321
2338
|
# @param release_id [::String]
|
2322
2339
|
# Required. ID of the `Release`.
|
@@ -2339,6 +2356,9 @@ module Google
|
|
2339
2356
|
# @param validate_only [::Boolean]
|
2340
2357
|
# Optional. If set to true, the request is validated and the user is provided
|
2341
2358
|
# with an expected result, but no actual change is made.
|
2359
|
+
# @param override_deploy_policy [::Array<::String>]
|
2360
|
+
# Optional. Deploy policies to override. Format is
|
2361
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
|
2342
2362
|
#
|
2343
2363
|
# @yield [response, operation] Access the result along with the RPC operation
|
2344
2364
|
# @yieldparam response [::Gapic::Operation]
|
@@ -2500,6 +2520,556 @@ module Google
|
|
2500
2520
|
raise ::Google::Cloud::Error.from_error(e)
|
2501
2521
|
end
|
2502
2522
|
|
2523
|
+
##
|
2524
|
+
# Creates a new DeployPolicy in a given project and location.
|
2525
|
+
#
|
2526
|
+
# @overload create_deploy_policy(request, options = nil)
|
2527
|
+
# Pass arguments to `create_deploy_policy` via a request object, either of type
|
2528
|
+
# {::Google::Cloud::Deploy::V1::CreateDeployPolicyRequest} or an equivalent Hash.
|
2529
|
+
#
|
2530
|
+
# @param request [::Google::Cloud::Deploy::V1::CreateDeployPolicyRequest, ::Hash]
|
2531
|
+
# A request object representing the call parameters. Required. To specify no
|
2532
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2533
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2534
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2535
|
+
#
|
2536
|
+
# @overload create_deploy_policy(parent: nil, deploy_policy_id: nil, deploy_policy: nil, request_id: nil, validate_only: nil)
|
2537
|
+
# Pass arguments to `create_deploy_policy` via keyword arguments. Note that at
|
2538
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2539
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2540
|
+
#
|
2541
|
+
# @param parent [::String]
|
2542
|
+
# Required. The parent collection in which the `DeployPolicy` must be
|
2543
|
+
# created. The format is `projects/{project_id}/locations/{location_name}`.
|
2544
|
+
# @param deploy_policy_id [::String]
|
2545
|
+
# Required. ID of the `DeployPolicy`.
|
2546
|
+
# @param deploy_policy [::Google::Cloud::Deploy::V1::DeployPolicy, ::Hash]
|
2547
|
+
# Required. The `DeployPolicy` to create.
|
2548
|
+
# @param request_id [::String]
|
2549
|
+
# Optional. A request ID to identify requests. Specify a unique request ID
|
2550
|
+
# so that if you must retry your request, the server knows to ignore the
|
2551
|
+
# request if it has already been completed. The server guarantees that for
|
2552
|
+
# at least 60 minutes after the first request.
|
2553
|
+
#
|
2554
|
+
# For example, consider a situation where you make an initial request and the
|
2555
|
+
# request times out. If you make the request again with the same request ID,
|
2556
|
+
# the server can check if original operation with the same request ID was
|
2557
|
+
# received, and if so, will ignore the second request. This prevents clients
|
2558
|
+
# from accidentally creating duplicate commitments.
|
2559
|
+
#
|
2560
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
2561
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
2562
|
+
# @param validate_only [::Boolean]
|
2563
|
+
# Optional. If set to true, the request is validated and the user is provided
|
2564
|
+
# with an expected result, but no actual change is made.
|
2565
|
+
#
|
2566
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
2567
|
+
# @yieldparam response [::Gapic::Operation]
|
2568
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
2569
|
+
#
|
2570
|
+
# @return [::Gapic::Operation]
|
2571
|
+
#
|
2572
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2573
|
+
#
|
2574
|
+
# @example Basic example
|
2575
|
+
# require "google/cloud/deploy/v1"
|
2576
|
+
#
|
2577
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2578
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
|
2579
|
+
#
|
2580
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2581
|
+
# request = Google::Cloud::Deploy::V1::CreateDeployPolicyRequest.new
|
2582
|
+
#
|
2583
|
+
# # Call the create_deploy_policy method.
|
2584
|
+
# result = client.create_deploy_policy request
|
2585
|
+
#
|
2586
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
2587
|
+
# # check the status of an operation, cancel it, or wait for results.
|
2588
|
+
# # Here is how to wait for a response.
|
2589
|
+
# result.wait_until_done! timeout: 60
|
2590
|
+
# if result.response?
|
2591
|
+
# p result.response
|
2592
|
+
# else
|
2593
|
+
# puts "No response received."
|
2594
|
+
# end
|
2595
|
+
#
|
2596
|
+
def create_deploy_policy request, options = nil
|
2597
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2598
|
+
|
2599
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateDeployPolicyRequest
|
2600
|
+
|
2601
|
+
# Converts hash and nil to an options object
|
2602
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2603
|
+
|
2604
|
+
# Customize the options with defaults
|
2605
|
+
metadata = @config.rpcs.create_deploy_policy.metadata.to_h
|
2606
|
+
|
2607
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
2608
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2609
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2610
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION
|
2611
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
2612
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2613
|
+
|
2614
|
+
header_params = {}
|
2615
|
+
if request.parent
|
2616
|
+
header_params["parent"] = request.parent
|
2617
|
+
end
|
2618
|
+
|
2619
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2620
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
2621
|
+
|
2622
|
+
options.apply_defaults timeout: @config.rpcs.create_deploy_policy.timeout,
|
2623
|
+
metadata: metadata,
|
2624
|
+
retry_policy: @config.rpcs.create_deploy_policy.retry_policy
|
2625
|
+
|
2626
|
+
options.apply_defaults timeout: @config.timeout,
|
2627
|
+
metadata: @config.metadata,
|
2628
|
+
retry_policy: @config.retry_policy
|
2629
|
+
|
2630
|
+
@cloud_deploy_stub.call_rpc :create_deploy_policy, request, options: options do |response, operation|
|
2631
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
2632
|
+
yield response, operation if block_given?
|
2633
|
+
return response
|
2634
|
+
end
|
2635
|
+
rescue ::GRPC::BadStatus => e
|
2636
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2637
|
+
end
|
2638
|
+
|
2639
|
+
##
|
2640
|
+
# Updates the parameters of a single DeployPolicy.
|
2641
|
+
#
|
2642
|
+
# @overload update_deploy_policy(request, options = nil)
|
2643
|
+
# Pass arguments to `update_deploy_policy` via a request object, either of type
|
2644
|
+
# {::Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest} or an equivalent Hash.
|
2645
|
+
#
|
2646
|
+
# @param request [::Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest, ::Hash]
|
2647
|
+
# A request object representing the call parameters. Required. To specify no
|
2648
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2649
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2650
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2651
|
+
#
|
2652
|
+
# @overload update_deploy_policy(update_mask: nil, deploy_policy: nil, request_id: nil, allow_missing: nil, validate_only: nil)
|
2653
|
+
# Pass arguments to `update_deploy_policy` via keyword arguments. Note that at
|
2654
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2655
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2656
|
+
#
|
2657
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
2658
|
+
# Required. Field mask is used to specify the fields to be overwritten by the
|
2659
|
+
# update in the `DeployPolicy` resource. The fields specified in the
|
2660
|
+
# update_mask are relative to the resource, not the full request. A field
|
2661
|
+
# will be overwritten if it's in the mask. If the user doesn't provide a mask
|
2662
|
+
# then all fields are overwritten.
|
2663
|
+
# @param deploy_policy [::Google::Cloud::Deploy::V1::DeployPolicy, ::Hash]
|
2664
|
+
# Required. The `DeployPolicy` to update.
|
2665
|
+
# @param request_id [::String]
|
2666
|
+
# Optional. A request ID to identify requests. Specify a unique request ID
|
2667
|
+
# so that if you must retry your request, the server knows to ignore the
|
2668
|
+
# request if it has already been completed. The server guarantees that for
|
2669
|
+
# at least 60 minutes after the first request.
|
2670
|
+
#
|
2671
|
+
# For example, consider a situation where you make an initial request and the
|
2672
|
+
# request times out. If you make the request again with the same request ID,
|
2673
|
+
# the server can check if original operation with the same request ID was
|
2674
|
+
# received, and if so, will ignore the second request. This prevents clients
|
2675
|
+
# from accidentally creating duplicate commitments.
|
2676
|
+
#
|
2677
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
2678
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
2679
|
+
# @param allow_missing [::Boolean]
|
2680
|
+
# Optional. If set to true, updating a `DeployPolicy` that does not exist
|
2681
|
+
# will result in the creation of a new `DeployPolicy`.
|
2682
|
+
# @param validate_only [::Boolean]
|
2683
|
+
# Optional. If set to true, the request is validated and the user is provided
|
2684
|
+
# with an expected result, but no actual change is made.
|
2685
|
+
#
|
2686
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
2687
|
+
# @yieldparam response [::Gapic::Operation]
|
2688
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
2689
|
+
#
|
2690
|
+
# @return [::Gapic::Operation]
|
2691
|
+
#
|
2692
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2693
|
+
#
|
2694
|
+
# @example Basic example
|
2695
|
+
# require "google/cloud/deploy/v1"
|
2696
|
+
#
|
2697
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2698
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
|
2699
|
+
#
|
2700
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2701
|
+
# request = Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest.new
|
2702
|
+
#
|
2703
|
+
# # Call the update_deploy_policy method.
|
2704
|
+
# result = client.update_deploy_policy request
|
2705
|
+
#
|
2706
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
2707
|
+
# # check the status of an operation, cancel it, or wait for results.
|
2708
|
+
# # Here is how to wait for a response.
|
2709
|
+
# result.wait_until_done! timeout: 60
|
2710
|
+
# if result.response?
|
2711
|
+
# p result.response
|
2712
|
+
# else
|
2713
|
+
# puts "No response received."
|
2714
|
+
# end
|
2715
|
+
#
|
2716
|
+
def update_deploy_policy request, options = nil
|
2717
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2718
|
+
|
2719
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest
|
2720
|
+
|
2721
|
+
# Converts hash and nil to an options object
|
2722
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2723
|
+
|
2724
|
+
# Customize the options with defaults
|
2725
|
+
metadata = @config.rpcs.update_deploy_policy.metadata.to_h
|
2726
|
+
|
2727
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
2728
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2729
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2730
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION
|
2731
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
2732
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2733
|
+
|
2734
|
+
header_params = {}
|
2735
|
+
if request.deploy_policy&.name
|
2736
|
+
header_params["deploy_policy.name"] = request.deploy_policy.name
|
2737
|
+
end
|
2738
|
+
|
2739
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2740
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
2741
|
+
|
2742
|
+
options.apply_defaults timeout: @config.rpcs.update_deploy_policy.timeout,
|
2743
|
+
metadata: metadata,
|
2744
|
+
retry_policy: @config.rpcs.update_deploy_policy.retry_policy
|
2745
|
+
|
2746
|
+
options.apply_defaults timeout: @config.timeout,
|
2747
|
+
metadata: @config.metadata,
|
2748
|
+
retry_policy: @config.retry_policy
|
2749
|
+
|
2750
|
+
@cloud_deploy_stub.call_rpc :update_deploy_policy, request, options: options do |response, operation|
|
2751
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
2752
|
+
yield response, operation if block_given?
|
2753
|
+
return response
|
2754
|
+
end
|
2755
|
+
rescue ::GRPC::BadStatus => e
|
2756
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2757
|
+
end
|
2758
|
+
|
2759
|
+
##
|
2760
|
+
# Deletes a single DeployPolicy.
|
2761
|
+
#
|
2762
|
+
# @overload delete_deploy_policy(request, options = nil)
|
2763
|
+
# Pass arguments to `delete_deploy_policy` via a request object, either of type
|
2764
|
+
# {::Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest} or an equivalent Hash.
|
2765
|
+
#
|
2766
|
+
# @param request [::Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest, ::Hash]
|
2767
|
+
# A request object representing the call parameters. Required. To specify no
|
2768
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2769
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2770
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2771
|
+
#
|
2772
|
+
# @overload delete_deploy_policy(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil)
|
2773
|
+
# Pass arguments to `delete_deploy_policy` via keyword arguments. Note that at
|
2774
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2775
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2776
|
+
#
|
2777
|
+
# @param name [::String]
|
2778
|
+
# Required. The name of the `DeployPolicy` to delete. The format is
|
2779
|
+
# `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.
|
2780
|
+
# @param request_id [::String]
|
2781
|
+
# Optional. A request ID to identify requests. Specify a unique request ID
|
2782
|
+
# so that if you must retry your request, the server knows to ignore the
|
2783
|
+
# request if it has already been completed. The server guarantees that for
|
2784
|
+
# at least 60 minutes after the first request.
|
2785
|
+
#
|
2786
|
+
# For example, consider a situation where you make an initial request and the
|
2787
|
+
# request times out. If you make the request again with the same request ID,
|
2788
|
+
# the server can check if original operation with the same request ID was
|
2789
|
+
# received, and if so, will ignore the second request. This prevents clients
|
2790
|
+
# from accidentally creating duplicate commitments.
|
2791
|
+
#
|
2792
|
+
# The request ID must be a valid UUID with the exception that zero UUID is
|
2793
|
+
# not supported (00000000-0000-0000-0000-000000000000).
|
2794
|
+
# @param allow_missing [::Boolean]
|
2795
|
+
# Optional. If set to true, then deleting an already deleted or non-existing
|
2796
|
+
# `DeployPolicy` will succeed.
|
2797
|
+
# @param validate_only [::Boolean]
|
2798
|
+
# Optional. If set, validate the request and preview the review, but do not
|
2799
|
+
# actually post it.
|
2800
|
+
# @param etag [::String]
|
2801
|
+
# Optional. This checksum is computed by the server based on the value of
|
2802
|
+
# other fields, and may be sent on update and delete requests to ensure the
|
2803
|
+
# client has an up-to-date value before proceeding.
|
2804
|
+
#
|
2805
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
2806
|
+
# @yieldparam response [::Gapic::Operation]
|
2807
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
2808
|
+
#
|
2809
|
+
# @return [::Gapic::Operation]
|
2810
|
+
#
|
2811
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2812
|
+
#
|
2813
|
+
# @example Basic example
|
2814
|
+
# require "google/cloud/deploy/v1"
|
2815
|
+
#
|
2816
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2817
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
|
2818
|
+
#
|
2819
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2820
|
+
# request = Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest.new
|
2821
|
+
#
|
2822
|
+
# # Call the delete_deploy_policy method.
|
2823
|
+
# result = client.delete_deploy_policy request
|
2824
|
+
#
|
2825
|
+
# # The returned object is of type Gapic::Operation. You can use it to
|
2826
|
+
# # check the status of an operation, cancel it, or wait for results.
|
2827
|
+
# # Here is how to wait for a response.
|
2828
|
+
# result.wait_until_done! timeout: 60
|
2829
|
+
# if result.response?
|
2830
|
+
# p result.response
|
2831
|
+
# else
|
2832
|
+
# puts "No response received."
|
2833
|
+
# end
|
2834
|
+
#
|
2835
|
+
def delete_deploy_policy request, options = nil
|
2836
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2837
|
+
|
2838
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest
|
2839
|
+
|
2840
|
+
# Converts hash and nil to an options object
|
2841
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2842
|
+
|
2843
|
+
# Customize the options with defaults
|
2844
|
+
metadata = @config.rpcs.delete_deploy_policy.metadata.to_h
|
2845
|
+
|
2846
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
2847
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2848
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2849
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION
|
2850
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
2851
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2852
|
+
|
2853
|
+
header_params = {}
|
2854
|
+
if request.name
|
2855
|
+
header_params["name"] = request.name
|
2856
|
+
end
|
2857
|
+
|
2858
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2859
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
2860
|
+
|
2861
|
+
options.apply_defaults timeout: @config.rpcs.delete_deploy_policy.timeout,
|
2862
|
+
metadata: metadata,
|
2863
|
+
retry_policy: @config.rpcs.delete_deploy_policy.retry_policy
|
2864
|
+
|
2865
|
+
options.apply_defaults timeout: @config.timeout,
|
2866
|
+
metadata: @config.metadata,
|
2867
|
+
retry_policy: @config.retry_policy
|
2868
|
+
|
2869
|
+
@cloud_deploy_stub.call_rpc :delete_deploy_policy, request, options: options do |response, operation|
|
2870
|
+
response = ::Gapic::Operation.new response, @operations_client, options: options
|
2871
|
+
yield response, operation if block_given?
|
2872
|
+
return response
|
2873
|
+
end
|
2874
|
+
rescue ::GRPC::BadStatus => e
|
2875
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2876
|
+
end
|
2877
|
+
|
2878
|
+
##
|
2879
|
+
# Lists DeployPolicies in a given project and location.
|
2880
|
+
#
|
2881
|
+
# @overload list_deploy_policies(request, options = nil)
|
2882
|
+
# Pass arguments to `list_deploy_policies` via a request object, either of type
|
2883
|
+
# {::Google::Cloud::Deploy::V1::ListDeployPoliciesRequest} or an equivalent Hash.
|
2884
|
+
#
|
2885
|
+
# @param request [::Google::Cloud::Deploy::V1::ListDeployPoliciesRequest, ::Hash]
|
2886
|
+
# A request object representing the call parameters. Required. To specify no
|
2887
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2888
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2889
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2890
|
+
#
|
2891
|
+
# @overload list_deploy_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
|
2892
|
+
# Pass arguments to `list_deploy_policies` via keyword arguments. Note that at
|
2893
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2894
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2895
|
+
#
|
2896
|
+
# @param parent [::String]
|
2897
|
+
# Required. The parent, which owns this collection of deploy policies. Format
|
2898
|
+
# must be `projects/{project_id}/locations/{location_name}`.
|
2899
|
+
# @param page_size [::Integer]
|
2900
|
+
# The maximum number of deploy policies to return. The service may return
|
2901
|
+
# fewer than this value. If unspecified, at most 50 deploy policies will
|
2902
|
+
# be returned. The maximum value is 1000; values above 1000 will be set
|
2903
|
+
# to 1000.
|
2904
|
+
# @param page_token [::String]
|
2905
|
+
# A page token, received from a previous `ListDeployPolicies` call.
|
2906
|
+
# Provide this to retrieve the subsequent page.
|
2907
|
+
#
|
2908
|
+
# When paginating, all other provided parameters match
|
2909
|
+
# the call that provided the page token.
|
2910
|
+
# @param filter [::String]
|
2911
|
+
# Filter deploy policies to be returned. See https://google.aip.dev/160 for
|
2912
|
+
# more details. All fields can be used in the filter.
|
2913
|
+
# @param order_by [::String]
|
2914
|
+
# Field to sort by. See https://google.aip.dev/132#ordering for more details.
|
2915
|
+
#
|
2916
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
2917
|
+
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeployPolicy>]
|
2918
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
2919
|
+
#
|
2920
|
+
# @return [::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeployPolicy>]
|
2921
|
+
#
|
2922
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
2923
|
+
#
|
2924
|
+
# @example Basic example
|
2925
|
+
# require "google/cloud/deploy/v1"
|
2926
|
+
#
|
2927
|
+
# # Create a client object. The client can be reused for multiple calls.
|
2928
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
|
2929
|
+
#
|
2930
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
2931
|
+
# request = Google::Cloud::Deploy::V1::ListDeployPoliciesRequest.new
|
2932
|
+
#
|
2933
|
+
# # Call the list_deploy_policies method.
|
2934
|
+
# result = client.list_deploy_policies request
|
2935
|
+
#
|
2936
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
2937
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
2938
|
+
# result.each do |item|
|
2939
|
+
# # Each element is of type ::Google::Cloud::Deploy::V1::DeployPolicy.
|
2940
|
+
# p item
|
2941
|
+
# end
|
2942
|
+
#
|
2943
|
+
def list_deploy_policies request, options = nil
|
2944
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2945
|
+
|
2946
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListDeployPoliciesRequest
|
2947
|
+
|
2948
|
+
# Converts hash and nil to an options object
|
2949
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2950
|
+
|
2951
|
+
# Customize the options with defaults
|
2952
|
+
metadata = @config.rpcs.list_deploy_policies.metadata.to_h
|
2953
|
+
|
2954
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
2955
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2956
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2957
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION
|
2958
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
2959
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2960
|
+
|
2961
|
+
header_params = {}
|
2962
|
+
if request.parent
|
2963
|
+
header_params["parent"] = request.parent
|
2964
|
+
end
|
2965
|
+
|
2966
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
2967
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
2968
|
+
|
2969
|
+
options.apply_defaults timeout: @config.rpcs.list_deploy_policies.timeout,
|
2970
|
+
metadata: metadata,
|
2971
|
+
retry_policy: @config.rpcs.list_deploy_policies.retry_policy
|
2972
|
+
|
2973
|
+
options.apply_defaults timeout: @config.timeout,
|
2974
|
+
metadata: @config.metadata,
|
2975
|
+
retry_policy: @config.retry_policy
|
2976
|
+
|
2977
|
+
@cloud_deploy_stub.call_rpc :list_deploy_policies, request, options: options do |response, operation|
|
2978
|
+
response = ::Gapic::PagedEnumerable.new @cloud_deploy_stub, :list_deploy_policies, request, response, operation, options
|
2979
|
+
yield response, operation if block_given?
|
2980
|
+
return response
|
2981
|
+
end
|
2982
|
+
rescue ::GRPC::BadStatus => e
|
2983
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2984
|
+
end
|
2985
|
+
|
2986
|
+
##
|
2987
|
+
# Gets details of a single DeployPolicy.
|
2988
|
+
#
|
2989
|
+
# @overload get_deploy_policy(request, options = nil)
|
2990
|
+
# Pass arguments to `get_deploy_policy` via a request object, either of type
|
2991
|
+
# {::Google::Cloud::Deploy::V1::GetDeployPolicyRequest} or an equivalent Hash.
|
2992
|
+
#
|
2993
|
+
# @param request [::Google::Cloud::Deploy::V1::GetDeployPolicyRequest, ::Hash]
|
2994
|
+
# A request object representing the call parameters. Required. To specify no
|
2995
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2996
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2997
|
+
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2998
|
+
#
|
2999
|
+
# @overload get_deploy_policy(name: nil)
|
3000
|
+
# Pass arguments to `get_deploy_policy` via keyword arguments. Note that at
|
3001
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
3002
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
3003
|
+
#
|
3004
|
+
# @param name [::String]
|
3005
|
+
# Required. Name of the `DeployPolicy`. Format must be
|
3006
|
+
# `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.
|
3007
|
+
#
|
3008
|
+
# @yield [response, operation] Access the result along with the RPC operation
|
3009
|
+
# @yieldparam response [::Google::Cloud::Deploy::V1::DeployPolicy]
|
3010
|
+
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
3011
|
+
#
|
3012
|
+
# @return [::Google::Cloud::Deploy::V1::DeployPolicy]
|
3013
|
+
#
|
3014
|
+
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
3015
|
+
#
|
3016
|
+
# @example Basic example
|
3017
|
+
# require "google/cloud/deploy/v1"
|
3018
|
+
#
|
3019
|
+
# # Create a client object. The client can be reused for multiple calls.
|
3020
|
+
# client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
|
3021
|
+
#
|
3022
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
3023
|
+
# request = Google::Cloud::Deploy::V1::GetDeployPolicyRequest.new
|
3024
|
+
#
|
3025
|
+
# # Call the get_deploy_policy method.
|
3026
|
+
# result = client.get_deploy_policy request
|
3027
|
+
#
|
3028
|
+
# # The returned object is of type Google::Cloud::Deploy::V1::DeployPolicy.
|
3029
|
+
# p result
|
3030
|
+
#
|
3031
|
+
def get_deploy_policy request, options = nil
|
3032
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
3033
|
+
|
3034
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetDeployPolicyRequest
|
3035
|
+
|
3036
|
+
# Converts hash and nil to an options object
|
3037
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
3038
|
+
|
3039
|
+
# Customize the options with defaults
|
3040
|
+
metadata = @config.rpcs.get_deploy_policy.metadata.to_h
|
3041
|
+
|
3042
|
+
# Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
|
3043
|
+
metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
3044
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
3045
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION
|
3046
|
+
metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
|
3047
|
+
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
3048
|
+
|
3049
|
+
header_params = {}
|
3050
|
+
if request.name
|
3051
|
+
header_params["name"] = request.name
|
3052
|
+
end
|
3053
|
+
|
3054
|
+
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
3055
|
+
metadata[:"x-goog-request-params"] ||= request_params_header
|
3056
|
+
|
3057
|
+
options.apply_defaults timeout: @config.rpcs.get_deploy_policy.timeout,
|
3058
|
+
metadata: metadata,
|
3059
|
+
retry_policy: @config.rpcs.get_deploy_policy.retry_policy
|
3060
|
+
|
3061
|
+
options.apply_defaults timeout: @config.timeout,
|
3062
|
+
metadata: @config.metadata,
|
3063
|
+
retry_policy: @config.retry_policy
|
3064
|
+
|
3065
|
+
@cloud_deploy_stub.call_rpc :get_deploy_policy, request, options: options do |response, operation|
|
3066
|
+
yield response, operation if block_given?
|
3067
|
+
return response
|
3068
|
+
end
|
3069
|
+
rescue ::GRPC::BadStatus => e
|
3070
|
+
raise ::Google::Cloud::Error.from_error(e)
|
3071
|
+
end
|
3072
|
+
|
2503
3073
|
##
|
2504
3074
|
# Approves a Rollout.
|
2505
3075
|
#
|
@@ -2513,7 +3083,7 @@ module Google
|
|
2513
3083
|
# @param options [::Gapic::CallOptions, ::Hash]
|
2514
3084
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2515
3085
|
#
|
2516
|
-
# @overload approve_rollout(name: nil, approved: nil)
|
3086
|
+
# @overload approve_rollout(name: nil, approved: nil, override_deploy_policy: nil)
|
2517
3087
|
# Pass arguments to `approve_rollout` via keyword arguments. Note that at
|
2518
3088
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
2519
3089
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -2523,6 +3093,9 @@ module Google
|
|
2523
3093
|
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
|
2524
3094
|
# @param approved [::Boolean]
|
2525
3095
|
# Required. True = approve; false = reject
|
3096
|
+
# @param override_deploy_policy [::Array<::String>]
|
3097
|
+
# Optional. Deploy policies to override. Format is
|
3098
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
|
2526
3099
|
#
|
2527
3100
|
# @yield [response, operation] Access the result along with the RPC operation
|
2528
3101
|
# @yieldparam response [::Google::Cloud::Deploy::V1::ApproveRolloutResponse]
|
@@ -2602,7 +3175,7 @@ module Google
|
|
2602
3175
|
# @param options [::Gapic::CallOptions, ::Hash]
|
2603
3176
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2604
3177
|
#
|
2605
|
-
# @overload advance_rollout(name: nil, phase_id: nil)
|
3178
|
+
# @overload advance_rollout(name: nil, phase_id: nil, override_deploy_policy: nil)
|
2606
3179
|
# Pass arguments to `advance_rollout` via keyword arguments. Note that at
|
2607
3180
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
2608
3181
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -2612,6 +3185,9 @@ module Google
|
|
2612
3185
|
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
|
2613
3186
|
# @param phase_id [::String]
|
2614
3187
|
# Required. The phase ID to advance the `Rollout` to.
|
3188
|
+
# @param override_deploy_policy [::Array<::String>]
|
3189
|
+
# Optional. Deploy policies to override. Format is
|
3190
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
|
2615
3191
|
#
|
2616
3192
|
# @yield [response, operation] Access the result along with the RPC operation
|
2617
3193
|
# @yieldparam response [::Google::Cloud::Deploy::V1::AdvanceRolloutResponse]
|
@@ -2691,7 +3267,7 @@ module Google
|
|
2691
3267
|
# @param options [::Gapic::CallOptions, ::Hash]
|
2692
3268
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2693
3269
|
#
|
2694
|
-
# @overload cancel_rollout(name: nil)
|
3270
|
+
# @overload cancel_rollout(name: nil, override_deploy_policy: nil)
|
2695
3271
|
# Pass arguments to `cancel_rollout` via keyword arguments. Note that at
|
2696
3272
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
2697
3273
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -2699,6 +3275,9 @@ module Google
|
|
2699
3275
|
# @param name [::String]
|
2700
3276
|
# Required. Name of the Rollout. Format is
|
2701
3277
|
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
|
3278
|
+
# @param override_deploy_policy [::Array<::String>]
|
3279
|
+
# Optional. Deploy policies to override. Format is
|
3280
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
|
2702
3281
|
#
|
2703
3282
|
# @yield [response, operation] Access the result along with the RPC operation
|
2704
3283
|
# @yieldparam response [::Google::Cloud::Deploy::V1::CancelRolloutResponse]
|
@@ -2973,14 +3552,14 @@ module Google
|
|
2973
3552
|
# @param options [::Gapic::CallOptions, ::Hash]
|
2974
3553
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
2975
3554
|
#
|
2976
|
-
# @overload create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil, starting_phase_id: nil)
|
3555
|
+
# @overload create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil, override_deploy_policy: nil, starting_phase_id: nil)
|
2977
3556
|
# Pass arguments to `create_rollout` via keyword arguments. Note that at
|
2978
3557
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
2979
3558
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
2980
3559
|
#
|
2981
3560
|
# @param parent [::String]
|
2982
|
-
# Required. The parent collection in which the `Rollout`
|
2983
|
-
#
|
3561
|
+
# Required. The parent collection in which the `Rollout` must be created.
|
3562
|
+
# The format is
|
2984
3563
|
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
|
2985
3564
|
# @param rollout_id [::String]
|
2986
3565
|
# Required. ID of the `Rollout`.
|
@@ -3003,6 +3582,9 @@ module Google
|
|
3003
3582
|
# @param validate_only [::Boolean]
|
3004
3583
|
# Optional. If set to true, the request is validated and the user is provided
|
3005
3584
|
# with an expected result, but no actual change is made.
|
3585
|
+
# @param override_deploy_policy [::Array<::String>]
|
3586
|
+
# Optional. Deploy policies to override. Format is
|
3587
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
|
3006
3588
|
# @param starting_phase_id [::String]
|
3007
3589
|
# Optional. The starting phase ID for the `Rollout`. If empty the `Rollout`
|
3008
3590
|
# will start at the first phase.
|
@@ -3093,7 +3675,7 @@ module Google
|
|
3093
3675
|
# @param options [::Gapic::CallOptions, ::Hash]
|
3094
3676
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3095
3677
|
#
|
3096
|
-
# @overload ignore_job(rollout: nil, phase_id: nil, job_id: nil)
|
3678
|
+
# @overload ignore_job(rollout: nil, phase_id: nil, job_id: nil, override_deploy_policy: nil)
|
3097
3679
|
# Pass arguments to `ignore_job` via keyword arguments. Note that at
|
3098
3680
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
3099
3681
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -3105,6 +3687,9 @@ module Google
|
|
3105
3687
|
# Required. The phase ID the Job to ignore belongs to.
|
3106
3688
|
# @param job_id [::String]
|
3107
3689
|
# Required. The job ID for the Job to ignore.
|
3690
|
+
# @param override_deploy_policy [::Array<::String>]
|
3691
|
+
# Optional. Deploy policies to override. Format is
|
3692
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
|
3108
3693
|
#
|
3109
3694
|
# @yield [response, operation] Access the result along with the RPC operation
|
3110
3695
|
# @yieldparam response [::Google::Cloud::Deploy::V1::IgnoreJobResponse]
|
@@ -3184,7 +3769,7 @@ module Google
|
|
3184
3769
|
# @param options [::Gapic::CallOptions, ::Hash]
|
3185
3770
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3186
3771
|
#
|
3187
|
-
# @overload retry_job(rollout: nil, phase_id: nil, job_id: nil)
|
3772
|
+
# @overload retry_job(rollout: nil, phase_id: nil, job_id: nil, override_deploy_policy: nil)
|
3188
3773
|
# Pass arguments to `retry_job` via keyword arguments. Note that at
|
3189
3774
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
3190
3775
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -3196,6 +3781,9 @@ module Google
|
|
3196
3781
|
# Required. The phase ID the Job to retry belongs to.
|
3197
3782
|
# @param job_id [::String]
|
3198
3783
|
# Required. The job ID for the Job to retry.
|
3784
|
+
# @param override_deploy_policy [::Array<::String>]
|
3785
|
+
# Optional. Deploy policies to override. Format is
|
3786
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
|
3199
3787
|
#
|
3200
3788
|
# @yield [response, operation] Access the result along with the RPC operation
|
3201
3789
|
# @yieldparam response [::Google::Cloud::Deploy::V1::RetryJobResponse]
|
@@ -3470,7 +4058,7 @@ module Google
|
|
3470
4058
|
# @param options [::Gapic::CallOptions, ::Hash]
|
3471
4059
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
3472
4060
|
#
|
3473
|
-
# @overload terminate_job_run(name: nil)
|
4061
|
+
# @overload terminate_job_run(name: nil, override_deploy_policy: nil)
|
3474
4062
|
# Pass arguments to `terminate_job_run` via keyword arguments. Note that at
|
3475
4063
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
3476
4064
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -3478,6 +4066,9 @@ module Google
|
|
3478
4066
|
# @param name [::String]
|
3479
4067
|
# Required. Name of the `JobRun`. Format must be
|
3480
4068
|
# `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}`.
|
4069
|
+
# @param override_deploy_policy [::Array<::String>]
|
4070
|
+
# Optional. Deploy policies to override. Format is
|
4071
|
+
# `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
|
3481
4072
|
#
|
3482
4073
|
# @yield [response, operation] Access the result along with the RPC operation
|
3483
4074
|
# @yieldparam response [::Google::Cloud::Deploy::V1::TerminateJobRunResponse]
|
@@ -3649,8 +4240,8 @@ module Google
|
|
3649
4240
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
3650
4241
|
#
|
3651
4242
|
# @param parent [::String]
|
3652
|
-
# Required. The parent collection in which the `Automation`
|
3653
|
-
#
|
4243
|
+
# Required. The parent collection in which the `Automation` must be created.
|
4244
|
+
# The format is
|
3654
4245
|
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
|
3655
4246
|
# @param automation_id [::String]
|
3656
4247
|
# Required. ID of the `Automation`.
|
@@ -3766,11 +4357,11 @@ module Google
|
|
3766
4357
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
3767
4358
|
#
|
3768
4359
|
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
3769
|
-
# Required. Field mask is used to specify the fields to be overwritten
|
3770
|
-
# `Automation` resource
|
3771
|
-
#
|
3772
|
-
#
|
3773
|
-
#
|
4360
|
+
# Required. Field mask is used to specify the fields to be overwritten by the
|
4361
|
+
# update in the `Automation` resource. The fields specified in the
|
4362
|
+
# update_mask are relative to the resource, not the full request. A field
|
4363
|
+
# will be overwritten if it's in the mask. If the user doesn't provide a mask
|
4364
|
+
# then all fields are overwritten.
|
3774
4365
|
# @param automation [::Google::Cloud::Deploy::V1::Automation, ::Hash]
|
3775
4366
|
# Required. The `Automation` to update.
|
3776
4367
|
# @param request_id [::String]
|
@@ -3886,7 +4477,7 @@ module Google
|
|
3886
4477
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
3887
4478
|
#
|
3888
4479
|
# @param name [::String]
|
3889
|
-
# Required. The name of the `Automation` to delete.
|
4480
|
+
# Required. The name of the `Automation` to delete. The format is
|
3890
4481
|
# `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.
|
3891
4482
|
# @param request_id [::String]
|
3892
4483
|
# Optional. A request ID to identify requests. Specify a unique request ID
|
@@ -4723,6 +5314,31 @@ module Google
|
|
4723
5314
|
#
|
4724
5315
|
attr_reader :abandon_release
|
4725
5316
|
##
|
5317
|
+
# RPC-specific configuration for `create_deploy_policy`
|
5318
|
+
# @return [::Gapic::Config::Method]
|
5319
|
+
#
|
5320
|
+
attr_reader :create_deploy_policy
|
5321
|
+
##
|
5322
|
+
# RPC-specific configuration for `update_deploy_policy`
|
5323
|
+
# @return [::Gapic::Config::Method]
|
5324
|
+
#
|
5325
|
+
attr_reader :update_deploy_policy
|
5326
|
+
##
|
5327
|
+
# RPC-specific configuration for `delete_deploy_policy`
|
5328
|
+
# @return [::Gapic::Config::Method]
|
5329
|
+
#
|
5330
|
+
attr_reader :delete_deploy_policy
|
5331
|
+
##
|
5332
|
+
# RPC-specific configuration for `list_deploy_policies`
|
5333
|
+
# @return [::Gapic::Config::Method]
|
5334
|
+
#
|
5335
|
+
attr_reader :list_deploy_policies
|
5336
|
+
##
|
5337
|
+
# RPC-specific configuration for `get_deploy_policy`
|
5338
|
+
# @return [::Gapic::Config::Method]
|
5339
|
+
#
|
5340
|
+
attr_reader :get_deploy_policy
|
5341
|
+
##
|
4726
5342
|
# RPC-specific configuration for `approve_rollout`
|
4727
5343
|
# @return [::Gapic::Config::Method]
|
4728
5344
|
#
|
@@ -4865,6 +5481,16 @@ module Google
|
|
4865
5481
|
@create_release = ::Gapic::Config::Method.new create_release_config
|
4866
5482
|
abandon_release_config = parent_rpcs.abandon_release if parent_rpcs.respond_to? :abandon_release
|
4867
5483
|
@abandon_release = ::Gapic::Config::Method.new abandon_release_config
|
5484
|
+
create_deploy_policy_config = parent_rpcs.create_deploy_policy if parent_rpcs.respond_to? :create_deploy_policy
|
5485
|
+
@create_deploy_policy = ::Gapic::Config::Method.new create_deploy_policy_config
|
5486
|
+
update_deploy_policy_config = parent_rpcs.update_deploy_policy if parent_rpcs.respond_to? :update_deploy_policy
|
5487
|
+
@update_deploy_policy = ::Gapic::Config::Method.new update_deploy_policy_config
|
5488
|
+
delete_deploy_policy_config = parent_rpcs.delete_deploy_policy if parent_rpcs.respond_to? :delete_deploy_policy
|
5489
|
+
@delete_deploy_policy = ::Gapic::Config::Method.new delete_deploy_policy_config
|
5490
|
+
list_deploy_policies_config = parent_rpcs.list_deploy_policies if parent_rpcs.respond_to? :list_deploy_policies
|
5491
|
+
@list_deploy_policies = ::Gapic::Config::Method.new list_deploy_policies_config
|
5492
|
+
get_deploy_policy_config = parent_rpcs.get_deploy_policy if parent_rpcs.respond_to? :get_deploy_policy
|
5493
|
+
@get_deploy_policy = ::Gapic::Config::Method.new get_deploy_policy_config
|
4868
5494
|
approve_rollout_config = parent_rpcs.approve_rollout if parent_rpcs.respond_to? :approve_rollout
|
4869
5495
|
@approve_rollout = ::Gapic::Config::Method.new approve_rollout_config
|
4870
5496
|
advance_rollout_config = parent_rpcs.advance_rollout if parent_rpcs.respond_to? :advance_rollout
|