google-cloud-deploy-v1 1.2.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -137,6 +137,22 @@ module Google
137
137
 
138
138
  default_config.rpcs.abandon_release.timeout = 60.0
139
139
 
140
+ default_config.rpcs.create_deploy_policy.timeout = 60.0
141
+
142
+ default_config.rpcs.update_deploy_policy.timeout = 60.0
143
+
144
+ default_config.rpcs.delete_deploy_policy.timeout = 60.0
145
+
146
+ default_config.rpcs.list_deploy_policies.timeout = 60.0
147
+ default_config.rpcs.list_deploy_policies.retry_policy = {
148
+ initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
149
+ }
150
+
151
+ default_config.rpcs.get_deploy_policy.timeout = 60.0
152
+ default_config.rpcs.get_deploy_policy.retry_policy = {
153
+ initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
154
+ }
155
+
140
156
  default_config.rpcs.approve_rollout.timeout = 60.0
141
157
 
142
158
  default_config.rpcs.advance_rollout.timeout = 60.0
@@ -964,7 +980,7 @@ module Google
964
980
  # @param options [::Gapic::CallOptions, ::Hash]
965
981
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
966
982
  #
967
- # @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)
983
+ # @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)
968
984
  # Pass arguments to `rollback_target` via keyword arguments. Note that at
969
985
  # least one keyword argument is required. To specify no parameters, or to keep all
970
986
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -989,6 +1005,9 @@ module Google
989
1005
  # @param validate_only [::Boolean]
990
1006
  # Optional. If set to true, the request is validated and the user is provided
991
1007
  # with a `RollbackTargetResponse`.
1008
+ # @param override_deploy_policy [::Array<::String>]
1009
+ # Optional. Deploy policies to override. Format is
1010
+ # `projects/{project}/locations/{location}/deployPolicies/{deploy_policy}`.
992
1011
  # @yield [result, operation] Access the result along with the TransportOperation object
993
1012
  # @yieldparam result [::Google::Cloud::Deploy::V1::RollbackTargetResponse]
994
1013
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2172,7 +2191,7 @@ module Google
2172
2191
  # @param options [::Gapic::CallOptions, ::Hash]
2173
2192
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2174
2193
  #
2175
- # @overload create_release(parent: nil, release_id: nil, release: nil, request_id: nil, validate_only: nil)
2194
+ # @overload create_release(parent: nil, release_id: nil, release: nil, request_id: nil, validate_only: nil, override_deploy_policy: nil)
2176
2195
  # Pass arguments to `create_release` via keyword arguments. Note that at
2177
2196
  # least one keyword argument is required. To specify no parameters, or to keep all
2178
2197
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2202,6 +2221,9 @@ module Google
2202
2221
  # @param validate_only [::Boolean]
2203
2222
  # Optional. If set to true, the request is validated and the user is provided
2204
2223
  # with an expected result, but no actual change is made.
2224
+ # @param override_deploy_policy [::Array<::String>]
2225
+ # Optional. Deploy policies to override. Format is
2226
+ # `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
2205
2227
  # @yield [result, operation] Access the result along with the TransportOperation object
2206
2228
  # @yieldparam result [::Gapic::Operation]
2207
2229
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2349,6 +2371,520 @@ module Google
2349
2371
  raise ::Google::Cloud::Error.from_error(e)
2350
2372
  end
2351
2373
 
2374
+ ##
2375
+ # Creates a new DeployPolicy in a given project and location.
2376
+ #
2377
+ # @overload create_deploy_policy(request, options = nil)
2378
+ # Pass arguments to `create_deploy_policy` via a request object, either of type
2379
+ # {::Google::Cloud::Deploy::V1::CreateDeployPolicyRequest} or an equivalent Hash.
2380
+ #
2381
+ # @param request [::Google::Cloud::Deploy::V1::CreateDeployPolicyRequest, ::Hash]
2382
+ # A request object representing the call parameters. Required. To specify no
2383
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2384
+ # @param options [::Gapic::CallOptions, ::Hash]
2385
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2386
+ #
2387
+ # @overload create_deploy_policy(parent: nil, deploy_policy_id: nil, deploy_policy: nil, request_id: nil, validate_only: nil)
2388
+ # Pass arguments to `create_deploy_policy` via keyword arguments. Note that at
2389
+ # least one keyword argument is required. To specify no parameters, or to keep all
2390
+ # the default parameter values, pass an empty Hash as a request object (see above).
2391
+ #
2392
+ # @param parent [::String]
2393
+ # Required. The parent collection in which the `DeployPolicy` must be
2394
+ # created. The format is `projects/{project_id}/locations/{location_name}`.
2395
+ # @param deploy_policy_id [::String]
2396
+ # Required. ID of the `DeployPolicy`.
2397
+ # @param deploy_policy [::Google::Cloud::Deploy::V1::DeployPolicy, ::Hash]
2398
+ # Required. The `DeployPolicy` to create.
2399
+ # @param request_id [::String]
2400
+ # Optional. A request ID to identify requests. Specify a unique request ID
2401
+ # so that if you must retry your request, the server knows to ignore the
2402
+ # request if it has already been completed. The server guarantees that for
2403
+ # at least 60 minutes after the first request.
2404
+ #
2405
+ # For example, consider a situation where you make an initial request and the
2406
+ # request times out. If you make the request again with the same request ID,
2407
+ # the server can check if original operation with the same request ID was
2408
+ # received, and if so, will ignore the second request. This prevents clients
2409
+ # from accidentally creating duplicate commitments.
2410
+ #
2411
+ # The request ID must be a valid UUID with the exception that zero UUID is
2412
+ # not supported (00000000-0000-0000-0000-000000000000).
2413
+ # @param validate_only [::Boolean]
2414
+ # Optional. If set to true, the request is validated and the user is provided
2415
+ # with an expected result, but no actual change is made.
2416
+ # @yield [result, operation] Access the result along with the TransportOperation object
2417
+ # @yieldparam result [::Gapic::Operation]
2418
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2419
+ #
2420
+ # @return [::Gapic::Operation]
2421
+ #
2422
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2423
+ #
2424
+ # @example Basic example
2425
+ # require "google/cloud/deploy/v1"
2426
+ #
2427
+ # # Create a client object. The client can be reused for multiple calls.
2428
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
2429
+ #
2430
+ # # Create a request. To set request fields, pass in keyword arguments.
2431
+ # request = Google::Cloud::Deploy::V1::CreateDeployPolicyRequest.new
2432
+ #
2433
+ # # Call the create_deploy_policy method.
2434
+ # result = client.create_deploy_policy request
2435
+ #
2436
+ # # The returned object is of type Gapic::Operation. You can use it to
2437
+ # # check the status of an operation, cancel it, or wait for results.
2438
+ # # Here is how to wait for a response.
2439
+ # result.wait_until_done! timeout: 60
2440
+ # if result.response?
2441
+ # p result.response
2442
+ # else
2443
+ # puts "No response received."
2444
+ # end
2445
+ #
2446
+ def create_deploy_policy request, options = nil
2447
+ raise ::ArgumentError, "request must be provided" if request.nil?
2448
+
2449
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateDeployPolicyRequest
2450
+
2451
+ # Converts hash and nil to an options object
2452
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2453
+
2454
+ # Customize the options with defaults
2455
+ call_metadata = @config.rpcs.create_deploy_policy.metadata.to_h
2456
+
2457
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2458
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2459
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2460
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
2461
+ transports_version_send: [:rest]
2462
+
2463
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2464
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2465
+
2466
+ options.apply_defaults timeout: @config.rpcs.create_deploy_policy.timeout,
2467
+ metadata: call_metadata,
2468
+ retry_policy: @config.rpcs.create_deploy_policy.retry_policy
2469
+
2470
+ options.apply_defaults timeout: @config.timeout,
2471
+ metadata: @config.metadata,
2472
+ retry_policy: @config.retry_policy
2473
+
2474
+ @cloud_deploy_stub.create_deploy_policy request, options do |result, operation|
2475
+ result = ::Gapic::Operation.new result, @operations_client, options: options
2476
+ yield result, operation if block_given?
2477
+ return result
2478
+ end
2479
+ rescue ::Gapic::Rest::Error => e
2480
+ raise ::Google::Cloud::Error.from_error(e)
2481
+ end
2482
+
2483
+ ##
2484
+ # Updates the parameters of a single DeployPolicy.
2485
+ #
2486
+ # @overload update_deploy_policy(request, options = nil)
2487
+ # Pass arguments to `update_deploy_policy` via a request object, either of type
2488
+ # {::Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest} or an equivalent Hash.
2489
+ #
2490
+ # @param request [::Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest, ::Hash]
2491
+ # A request object representing the call parameters. Required. To specify no
2492
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2493
+ # @param options [::Gapic::CallOptions, ::Hash]
2494
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2495
+ #
2496
+ # @overload update_deploy_policy(update_mask: nil, deploy_policy: nil, request_id: nil, allow_missing: nil, validate_only: nil)
2497
+ # Pass arguments to `update_deploy_policy` via keyword arguments. Note that at
2498
+ # least one keyword argument is required. To specify no parameters, or to keep all
2499
+ # the default parameter values, pass an empty Hash as a request object (see above).
2500
+ #
2501
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
2502
+ # Required. Field mask is used to specify the fields to be overwritten by the
2503
+ # update in the `DeployPolicy` resource. The fields specified in the
2504
+ # update_mask are relative to the resource, not the full request. A field
2505
+ # will be overwritten if it's in the mask. If the user doesn't provide a mask
2506
+ # then all fields are overwritten.
2507
+ # @param deploy_policy [::Google::Cloud::Deploy::V1::DeployPolicy, ::Hash]
2508
+ # Required. The `DeployPolicy` to update.
2509
+ # @param request_id [::String]
2510
+ # Optional. A request ID to identify requests. Specify a unique request ID
2511
+ # so that if you must retry your request, the server knows to ignore the
2512
+ # request if it has already been completed. The server guarantees that for
2513
+ # at least 60 minutes after the first request.
2514
+ #
2515
+ # For example, consider a situation where you make an initial request and the
2516
+ # request times out. If you make the request again with the same request ID,
2517
+ # the server can check if original operation with the same request ID was
2518
+ # received, and if so, will ignore the second request. This prevents clients
2519
+ # from accidentally creating duplicate commitments.
2520
+ #
2521
+ # The request ID must be a valid UUID with the exception that zero UUID is
2522
+ # not supported (00000000-0000-0000-0000-000000000000).
2523
+ # @param allow_missing [::Boolean]
2524
+ # Optional. If set to true, updating a `DeployPolicy` that does not exist
2525
+ # will result in the creation of a new `DeployPolicy`.
2526
+ # @param validate_only [::Boolean]
2527
+ # Optional. If set to true, the request is validated and the user is provided
2528
+ # with an expected result, but no actual change is made.
2529
+ # @yield [result, operation] Access the result along with the TransportOperation object
2530
+ # @yieldparam result [::Gapic::Operation]
2531
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2532
+ #
2533
+ # @return [::Gapic::Operation]
2534
+ #
2535
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2536
+ #
2537
+ # @example Basic example
2538
+ # require "google/cloud/deploy/v1"
2539
+ #
2540
+ # # Create a client object. The client can be reused for multiple calls.
2541
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
2542
+ #
2543
+ # # Create a request. To set request fields, pass in keyword arguments.
2544
+ # request = Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest.new
2545
+ #
2546
+ # # Call the update_deploy_policy method.
2547
+ # result = client.update_deploy_policy request
2548
+ #
2549
+ # # The returned object is of type Gapic::Operation. You can use it to
2550
+ # # check the status of an operation, cancel it, or wait for results.
2551
+ # # Here is how to wait for a response.
2552
+ # result.wait_until_done! timeout: 60
2553
+ # if result.response?
2554
+ # p result.response
2555
+ # else
2556
+ # puts "No response received."
2557
+ # end
2558
+ #
2559
+ def update_deploy_policy request, options = nil
2560
+ raise ::ArgumentError, "request must be provided" if request.nil?
2561
+
2562
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest
2563
+
2564
+ # Converts hash and nil to an options object
2565
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2566
+
2567
+ # Customize the options with defaults
2568
+ call_metadata = @config.rpcs.update_deploy_policy.metadata.to_h
2569
+
2570
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2571
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2572
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2573
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
2574
+ transports_version_send: [:rest]
2575
+
2576
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2577
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2578
+
2579
+ options.apply_defaults timeout: @config.rpcs.update_deploy_policy.timeout,
2580
+ metadata: call_metadata,
2581
+ retry_policy: @config.rpcs.update_deploy_policy.retry_policy
2582
+
2583
+ options.apply_defaults timeout: @config.timeout,
2584
+ metadata: @config.metadata,
2585
+ retry_policy: @config.retry_policy
2586
+
2587
+ @cloud_deploy_stub.update_deploy_policy request, options do |result, operation|
2588
+ result = ::Gapic::Operation.new result, @operations_client, options: options
2589
+ yield result, operation if block_given?
2590
+ return result
2591
+ end
2592
+ rescue ::Gapic::Rest::Error => e
2593
+ raise ::Google::Cloud::Error.from_error(e)
2594
+ end
2595
+
2596
+ ##
2597
+ # Deletes a single DeployPolicy.
2598
+ #
2599
+ # @overload delete_deploy_policy(request, options = nil)
2600
+ # Pass arguments to `delete_deploy_policy` via a request object, either of type
2601
+ # {::Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest} or an equivalent Hash.
2602
+ #
2603
+ # @param request [::Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest, ::Hash]
2604
+ # A request object representing the call parameters. Required. To specify no
2605
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2606
+ # @param options [::Gapic::CallOptions, ::Hash]
2607
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2608
+ #
2609
+ # @overload delete_deploy_policy(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil)
2610
+ # Pass arguments to `delete_deploy_policy` via keyword arguments. Note that at
2611
+ # least one keyword argument is required. To specify no parameters, or to keep all
2612
+ # the default parameter values, pass an empty Hash as a request object (see above).
2613
+ #
2614
+ # @param name [::String]
2615
+ # Required. The name of the `DeployPolicy` to delete. The format is
2616
+ # `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.
2617
+ # @param request_id [::String]
2618
+ # Optional. A request ID to identify requests. Specify a unique request ID
2619
+ # so that if you must retry your request, the server knows to ignore the
2620
+ # request if it has already been completed. The server guarantees that for
2621
+ # at least 60 minutes after the first request.
2622
+ #
2623
+ # For example, consider a situation where you make an initial request and the
2624
+ # request times out. If you make the request again with the same request ID,
2625
+ # the server can check if original operation with the same request ID was
2626
+ # received, and if so, will ignore the second request. This prevents clients
2627
+ # from accidentally creating duplicate commitments.
2628
+ #
2629
+ # The request ID must be a valid UUID with the exception that zero UUID is
2630
+ # not supported (00000000-0000-0000-0000-000000000000).
2631
+ # @param allow_missing [::Boolean]
2632
+ # Optional. If set to true, then deleting an already deleted or non-existing
2633
+ # `DeployPolicy` will succeed.
2634
+ # @param validate_only [::Boolean]
2635
+ # Optional. If set, validate the request and preview the review, but do not
2636
+ # actually post it.
2637
+ # @param etag [::String]
2638
+ # Optional. This checksum is computed by the server based on the value of
2639
+ # other fields, and may be sent on update and delete requests to ensure the
2640
+ # client has an up-to-date value before proceeding.
2641
+ # @yield [result, operation] Access the result along with the TransportOperation object
2642
+ # @yieldparam result [::Gapic::Operation]
2643
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2644
+ #
2645
+ # @return [::Gapic::Operation]
2646
+ #
2647
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2648
+ #
2649
+ # @example Basic example
2650
+ # require "google/cloud/deploy/v1"
2651
+ #
2652
+ # # Create a client object. The client can be reused for multiple calls.
2653
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
2654
+ #
2655
+ # # Create a request. To set request fields, pass in keyword arguments.
2656
+ # request = Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest.new
2657
+ #
2658
+ # # Call the delete_deploy_policy method.
2659
+ # result = client.delete_deploy_policy request
2660
+ #
2661
+ # # The returned object is of type Gapic::Operation. You can use it to
2662
+ # # check the status of an operation, cancel it, or wait for results.
2663
+ # # Here is how to wait for a response.
2664
+ # result.wait_until_done! timeout: 60
2665
+ # if result.response?
2666
+ # p result.response
2667
+ # else
2668
+ # puts "No response received."
2669
+ # end
2670
+ #
2671
+ def delete_deploy_policy request, options = nil
2672
+ raise ::ArgumentError, "request must be provided" if request.nil?
2673
+
2674
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest
2675
+
2676
+ # Converts hash and nil to an options object
2677
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2678
+
2679
+ # Customize the options with defaults
2680
+ call_metadata = @config.rpcs.delete_deploy_policy.metadata.to_h
2681
+
2682
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2683
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2684
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2685
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
2686
+ transports_version_send: [:rest]
2687
+
2688
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2689
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2690
+
2691
+ options.apply_defaults timeout: @config.rpcs.delete_deploy_policy.timeout,
2692
+ metadata: call_metadata,
2693
+ retry_policy: @config.rpcs.delete_deploy_policy.retry_policy
2694
+
2695
+ options.apply_defaults timeout: @config.timeout,
2696
+ metadata: @config.metadata,
2697
+ retry_policy: @config.retry_policy
2698
+
2699
+ @cloud_deploy_stub.delete_deploy_policy request, options do |result, operation|
2700
+ result = ::Gapic::Operation.new result, @operations_client, options: options
2701
+ yield result, operation if block_given?
2702
+ return result
2703
+ end
2704
+ rescue ::Gapic::Rest::Error => e
2705
+ raise ::Google::Cloud::Error.from_error(e)
2706
+ end
2707
+
2708
+ ##
2709
+ # Lists DeployPolicies in a given project and location.
2710
+ #
2711
+ # @overload list_deploy_policies(request, options = nil)
2712
+ # Pass arguments to `list_deploy_policies` via a request object, either of type
2713
+ # {::Google::Cloud::Deploy::V1::ListDeployPoliciesRequest} or an equivalent Hash.
2714
+ #
2715
+ # @param request [::Google::Cloud::Deploy::V1::ListDeployPoliciesRequest, ::Hash]
2716
+ # A request object representing the call parameters. Required. To specify no
2717
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2718
+ # @param options [::Gapic::CallOptions, ::Hash]
2719
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2720
+ #
2721
+ # @overload list_deploy_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil)
2722
+ # Pass arguments to `list_deploy_policies` via keyword arguments. Note that at
2723
+ # least one keyword argument is required. To specify no parameters, or to keep all
2724
+ # the default parameter values, pass an empty Hash as a request object (see above).
2725
+ #
2726
+ # @param parent [::String]
2727
+ # Required. The parent, which owns this collection of deploy policies. Format
2728
+ # must be `projects/{project_id}/locations/{location_name}`.
2729
+ # @param page_size [::Integer]
2730
+ # The maximum number of deploy policies to return. The service may return
2731
+ # fewer than this value. If unspecified, at most 50 deploy policies will
2732
+ # be returned. The maximum value is 1000; values above 1000 will be set
2733
+ # to 1000.
2734
+ # @param page_token [::String]
2735
+ # A page token, received from a previous `ListDeployPolicies` call.
2736
+ # Provide this to retrieve the subsequent page.
2737
+ #
2738
+ # When paginating, all other provided parameters match
2739
+ # the call that provided the page token.
2740
+ # @param filter [::String]
2741
+ # Filter deploy policies to be returned. See https://google.aip.dev/160 for
2742
+ # more details. All fields can be used in the filter.
2743
+ # @param order_by [::String]
2744
+ # Field to sort by. See https://google.aip.dev/132#ordering for more details.
2745
+ # @yield [result, operation] Access the result along with the TransportOperation object
2746
+ # @yieldparam result [::Google::Cloud::Deploy::V1::ListDeployPoliciesResponse]
2747
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2748
+ #
2749
+ # @return [::Google::Cloud::Deploy::V1::ListDeployPoliciesResponse]
2750
+ #
2751
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2752
+ #
2753
+ # @example Basic example
2754
+ # require "google/cloud/deploy/v1"
2755
+ #
2756
+ # # Create a client object. The client can be reused for multiple calls.
2757
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
2758
+ #
2759
+ # # Create a request. To set request fields, pass in keyword arguments.
2760
+ # request = Google::Cloud::Deploy::V1::ListDeployPoliciesRequest.new
2761
+ #
2762
+ # # Call the list_deploy_policies method.
2763
+ # result = client.list_deploy_policies request
2764
+ #
2765
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2766
+ # # over elements, and API calls will be issued to fetch pages as needed.
2767
+ # result.each do |item|
2768
+ # # Each element is of type ::Google::Cloud::Deploy::V1::DeployPolicy.
2769
+ # p item
2770
+ # end
2771
+ #
2772
+ def list_deploy_policies request, options = nil
2773
+ raise ::ArgumentError, "request must be provided" if request.nil?
2774
+
2775
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListDeployPoliciesRequest
2776
+
2777
+ # Converts hash and nil to an options object
2778
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2779
+
2780
+ # Customize the options with defaults
2781
+ call_metadata = @config.rpcs.list_deploy_policies.metadata.to_h
2782
+
2783
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2784
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2785
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2786
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
2787
+ transports_version_send: [:rest]
2788
+
2789
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2790
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2791
+
2792
+ options.apply_defaults timeout: @config.rpcs.list_deploy_policies.timeout,
2793
+ metadata: call_metadata,
2794
+ retry_policy: @config.rpcs.list_deploy_policies.retry_policy
2795
+
2796
+ options.apply_defaults timeout: @config.timeout,
2797
+ metadata: @config.metadata,
2798
+ retry_policy: @config.retry_policy
2799
+
2800
+ @cloud_deploy_stub.list_deploy_policies request, options do |result, operation|
2801
+ yield result, operation if block_given?
2802
+ return result
2803
+ end
2804
+ rescue ::Gapic::Rest::Error => e
2805
+ raise ::Google::Cloud::Error.from_error(e)
2806
+ end
2807
+
2808
+ ##
2809
+ # Gets details of a single DeployPolicy.
2810
+ #
2811
+ # @overload get_deploy_policy(request, options = nil)
2812
+ # Pass arguments to `get_deploy_policy` via a request object, either of type
2813
+ # {::Google::Cloud::Deploy::V1::GetDeployPolicyRequest} or an equivalent Hash.
2814
+ #
2815
+ # @param request [::Google::Cloud::Deploy::V1::GetDeployPolicyRequest, ::Hash]
2816
+ # A request object representing the call parameters. Required. To specify no
2817
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2818
+ # @param options [::Gapic::CallOptions, ::Hash]
2819
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2820
+ #
2821
+ # @overload get_deploy_policy(name: nil)
2822
+ # Pass arguments to `get_deploy_policy` via keyword arguments. Note that at
2823
+ # least one keyword argument is required. To specify no parameters, or to keep all
2824
+ # the default parameter values, pass an empty Hash as a request object (see above).
2825
+ #
2826
+ # @param name [::String]
2827
+ # Required. Name of the `DeployPolicy`. Format must be
2828
+ # `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.
2829
+ # @yield [result, operation] Access the result along with the TransportOperation object
2830
+ # @yieldparam result [::Google::Cloud::Deploy::V1::DeployPolicy]
2831
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
2832
+ #
2833
+ # @return [::Google::Cloud::Deploy::V1::DeployPolicy]
2834
+ #
2835
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
2836
+ #
2837
+ # @example Basic example
2838
+ # require "google/cloud/deploy/v1"
2839
+ #
2840
+ # # Create a client object. The client can be reused for multiple calls.
2841
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new
2842
+ #
2843
+ # # Create a request. To set request fields, pass in keyword arguments.
2844
+ # request = Google::Cloud::Deploy::V1::GetDeployPolicyRequest.new
2845
+ #
2846
+ # # Call the get_deploy_policy method.
2847
+ # result = client.get_deploy_policy request
2848
+ #
2849
+ # # The returned object is of type Google::Cloud::Deploy::V1::DeployPolicy.
2850
+ # p result
2851
+ #
2852
+ def get_deploy_policy request, options = nil
2853
+ raise ::ArgumentError, "request must be provided" if request.nil?
2854
+
2855
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetDeployPolicyRequest
2856
+
2857
+ # Converts hash and nil to an options object
2858
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2859
+
2860
+ # Customize the options with defaults
2861
+ call_metadata = @config.rpcs.get_deploy_policy.metadata.to_h
2862
+
2863
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
2864
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2865
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2866
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
2867
+ transports_version_send: [:rest]
2868
+
2869
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
2870
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2871
+
2872
+ options.apply_defaults timeout: @config.rpcs.get_deploy_policy.timeout,
2873
+ metadata: call_metadata,
2874
+ retry_policy: @config.rpcs.get_deploy_policy.retry_policy
2875
+
2876
+ options.apply_defaults timeout: @config.timeout,
2877
+ metadata: @config.metadata,
2878
+ retry_policy: @config.retry_policy
2879
+
2880
+ @cloud_deploy_stub.get_deploy_policy request, options do |result, operation|
2881
+ yield result, operation if block_given?
2882
+ return result
2883
+ end
2884
+ rescue ::Gapic::Rest::Error => e
2885
+ raise ::Google::Cloud::Error.from_error(e)
2886
+ end
2887
+
2352
2888
  ##
2353
2889
  # Approves a Rollout.
2354
2890
  #
@@ -2362,7 +2898,7 @@ module Google
2362
2898
  # @param options [::Gapic::CallOptions, ::Hash]
2363
2899
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2364
2900
  #
2365
- # @overload approve_rollout(name: nil, approved: nil)
2901
+ # @overload approve_rollout(name: nil, approved: nil, override_deploy_policy: nil)
2366
2902
  # Pass arguments to `approve_rollout` via keyword arguments. Note that at
2367
2903
  # least one keyword argument is required. To specify no parameters, or to keep all
2368
2904
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2372,6 +2908,9 @@ module Google
2372
2908
  # `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
2373
2909
  # @param approved [::Boolean]
2374
2910
  # Required. True = approve; false = reject
2911
+ # @param override_deploy_policy [::Array<::String>]
2912
+ # Optional. Deploy policies to override. Format is
2913
+ # `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
2375
2914
  # @yield [result, operation] Access the result along with the TransportOperation object
2376
2915
  # @yieldparam result [::Google::Cloud::Deploy::V1::ApproveRolloutResponse]
2377
2916
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2444,7 +2983,7 @@ module Google
2444
2983
  # @param options [::Gapic::CallOptions, ::Hash]
2445
2984
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2446
2985
  #
2447
- # @overload advance_rollout(name: nil, phase_id: nil)
2986
+ # @overload advance_rollout(name: nil, phase_id: nil, override_deploy_policy: nil)
2448
2987
  # Pass arguments to `advance_rollout` via keyword arguments. Note that at
2449
2988
  # least one keyword argument is required. To specify no parameters, or to keep all
2450
2989
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2454,6 +2993,9 @@ module Google
2454
2993
  # `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
2455
2994
  # @param phase_id [::String]
2456
2995
  # Required. The phase ID to advance the `Rollout` to.
2996
+ # @param override_deploy_policy [::Array<::String>]
2997
+ # Optional. Deploy policies to override. Format is
2998
+ # `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
2457
2999
  # @yield [result, operation] Access the result along with the TransportOperation object
2458
3000
  # @yieldparam result [::Google::Cloud::Deploy::V1::AdvanceRolloutResponse]
2459
3001
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2526,7 +3068,7 @@ module Google
2526
3068
  # @param options [::Gapic::CallOptions, ::Hash]
2527
3069
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2528
3070
  #
2529
- # @overload cancel_rollout(name: nil)
3071
+ # @overload cancel_rollout(name: nil, override_deploy_policy: nil)
2530
3072
  # Pass arguments to `cancel_rollout` via keyword arguments. Note that at
2531
3073
  # least one keyword argument is required. To specify no parameters, or to keep all
2532
3074
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2534,6 +3076,9 @@ module Google
2534
3076
  # @param name [::String]
2535
3077
  # Required. Name of the Rollout. Format is
2536
3078
  # `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}`.
3079
+ # @param override_deploy_policy [::Array<::String>]
3080
+ # Optional. Deploy policies to override. Format is
3081
+ # `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
2537
3082
  # @yield [result, operation] Access the result along with the TransportOperation object
2538
3083
  # @yieldparam result [::Google::Cloud::Deploy::V1::CancelRolloutResponse]
2539
3084
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2786,7 +3331,7 @@ module Google
2786
3331
  # @param options [::Gapic::CallOptions, ::Hash]
2787
3332
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2788
3333
  #
2789
- # @overload create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil, starting_phase_id: nil)
3334
+ # @overload create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil, override_deploy_policy: nil, starting_phase_id: nil)
2790
3335
  # Pass arguments to `create_rollout` via keyword arguments. Note that at
2791
3336
  # least one keyword argument is required. To specify no parameters, or to keep all
2792
3337
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2816,6 +3361,9 @@ module Google
2816
3361
  # @param validate_only [::Boolean]
2817
3362
  # Optional. If set to true, the request is validated and the user is provided
2818
3363
  # with an expected result, but no actual change is made.
3364
+ # @param override_deploy_policy [::Array<::String>]
3365
+ # Optional. Deploy policies to override. Format is
3366
+ # `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
2819
3367
  # @param starting_phase_id [::String]
2820
3368
  # Optional. The starting phase ID for the `Rollout`. If empty the `Rollout`
2821
3369
  # will start at the first phase.
@@ -2899,7 +3447,7 @@ module Google
2899
3447
  # @param options [::Gapic::CallOptions, ::Hash]
2900
3448
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2901
3449
  #
2902
- # @overload ignore_job(rollout: nil, phase_id: nil, job_id: nil)
3450
+ # @overload ignore_job(rollout: nil, phase_id: nil, job_id: nil, override_deploy_policy: nil)
2903
3451
  # Pass arguments to `ignore_job` via keyword arguments. Note that at
2904
3452
  # least one keyword argument is required. To specify no parameters, or to keep all
2905
3453
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2911,6 +3459,9 @@ module Google
2911
3459
  # Required. The phase ID the Job to ignore belongs to.
2912
3460
  # @param job_id [::String]
2913
3461
  # Required. The job ID for the Job to ignore.
3462
+ # @param override_deploy_policy [::Array<::String>]
3463
+ # Optional. Deploy policies to override. Format is
3464
+ # `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
2914
3465
  # @yield [result, operation] Access the result along with the TransportOperation object
2915
3466
  # @yieldparam result [::Google::Cloud::Deploy::V1::IgnoreJobResponse]
2916
3467
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -2983,7 +3534,7 @@ module Google
2983
3534
  # @param options [::Gapic::CallOptions, ::Hash]
2984
3535
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
2985
3536
  #
2986
- # @overload retry_job(rollout: nil, phase_id: nil, job_id: nil)
3537
+ # @overload retry_job(rollout: nil, phase_id: nil, job_id: nil, override_deploy_policy: nil)
2987
3538
  # Pass arguments to `retry_job` via keyword arguments. Note that at
2988
3539
  # least one keyword argument is required. To specify no parameters, or to keep all
2989
3540
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2995,6 +3546,9 @@ module Google
2995
3546
  # Required. The phase ID the Job to retry belongs to.
2996
3547
  # @param job_id [::String]
2997
3548
  # Required. The job ID for the Job to retry.
3549
+ # @param override_deploy_policy [::Array<::String>]
3550
+ # Optional. Deploy policies to override. Format is
3551
+ # `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
2998
3552
  # @yield [result, operation] Access the result along with the TransportOperation object
2999
3553
  # @yieldparam result [::Google::Cloud::Deploy::V1::RetryJobResponse]
3000
3554
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -3247,7 +3801,7 @@ module Google
3247
3801
  # @param options [::Gapic::CallOptions, ::Hash]
3248
3802
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
3249
3803
  #
3250
- # @overload terminate_job_run(name: nil)
3804
+ # @overload terminate_job_run(name: nil, override_deploy_policy: nil)
3251
3805
  # Pass arguments to `terminate_job_run` via keyword arguments. Note that at
3252
3806
  # least one keyword argument is required. To specify no parameters, or to keep all
3253
3807
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3255,6 +3809,9 @@ module Google
3255
3809
  # @param name [::String]
3256
3810
  # Required. Name of the `JobRun`. Format must be
3257
3811
  # `projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}`.
3812
+ # @param override_deploy_policy [::Array<::String>]
3813
+ # Optional. Deploy policies to override. Format is
3814
+ # `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
3258
3815
  # @yield [result, operation] Access the result along with the TransportOperation object
3259
3816
  # @yieldparam result [::Google::Cloud::Deploy::V1::TerminateJobRunResponse]
3260
3817
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -4415,6 +4972,31 @@ module Google
4415
4972
  #
4416
4973
  attr_reader :abandon_release
4417
4974
  ##
4975
+ # RPC-specific configuration for `create_deploy_policy`
4976
+ # @return [::Gapic::Config::Method]
4977
+ #
4978
+ attr_reader :create_deploy_policy
4979
+ ##
4980
+ # RPC-specific configuration for `update_deploy_policy`
4981
+ # @return [::Gapic::Config::Method]
4982
+ #
4983
+ attr_reader :update_deploy_policy
4984
+ ##
4985
+ # RPC-specific configuration for `delete_deploy_policy`
4986
+ # @return [::Gapic::Config::Method]
4987
+ #
4988
+ attr_reader :delete_deploy_policy
4989
+ ##
4990
+ # RPC-specific configuration for `list_deploy_policies`
4991
+ # @return [::Gapic::Config::Method]
4992
+ #
4993
+ attr_reader :list_deploy_policies
4994
+ ##
4995
+ # RPC-specific configuration for `get_deploy_policy`
4996
+ # @return [::Gapic::Config::Method]
4997
+ #
4998
+ attr_reader :get_deploy_policy
4999
+ ##
4418
5000
  # RPC-specific configuration for `approve_rollout`
4419
5001
  # @return [::Gapic::Config::Method]
4420
5002
  #
@@ -4557,6 +5139,16 @@ module Google
4557
5139
  @create_release = ::Gapic::Config::Method.new create_release_config
4558
5140
  abandon_release_config = parent_rpcs.abandon_release if parent_rpcs.respond_to? :abandon_release
4559
5141
  @abandon_release = ::Gapic::Config::Method.new abandon_release_config
5142
+ create_deploy_policy_config = parent_rpcs.create_deploy_policy if parent_rpcs.respond_to? :create_deploy_policy
5143
+ @create_deploy_policy = ::Gapic::Config::Method.new create_deploy_policy_config
5144
+ update_deploy_policy_config = parent_rpcs.update_deploy_policy if parent_rpcs.respond_to? :update_deploy_policy
5145
+ @update_deploy_policy = ::Gapic::Config::Method.new update_deploy_policy_config
5146
+ delete_deploy_policy_config = parent_rpcs.delete_deploy_policy if parent_rpcs.respond_to? :delete_deploy_policy
5147
+ @delete_deploy_policy = ::Gapic::Config::Method.new delete_deploy_policy_config
5148
+ list_deploy_policies_config = parent_rpcs.list_deploy_policies if parent_rpcs.respond_to? :list_deploy_policies
5149
+ @list_deploy_policies = ::Gapic::Config::Method.new list_deploy_policies_config
5150
+ get_deploy_policy_config = parent_rpcs.get_deploy_policy if parent_rpcs.respond_to? :get_deploy_policy
5151
+ @get_deploy_policy = ::Gapic::Config::Method.new get_deploy_policy_config
4560
5152
  approve_rollout_config = parent_rpcs.approve_rollout if parent_rpcs.respond_to? :approve_rollout
4561
5153
  @approve_rollout = ::Gapic::Config::Method.new approve_rollout_config
4562
5154
  advance_rollout_config = parent_rpcs.advance_rollout if parent_rpcs.respond_to? :advance_rollout