google-cloud-deploy-v1 0.5.0 → 0.6.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.
@@ -115,6 +115,10 @@ module Google
115
115
 
116
116
  default_config.rpcs.approve_rollout.timeout = 60.0
117
117
 
118
+ default_config.rpcs.advance_rollout.timeout = 60.0
119
+
120
+ default_config.rpcs.cancel_rollout.timeout = 60.0
121
+
118
122
  default_config.rpcs.list_rollouts.timeout = 60.0
119
123
  default_config.rpcs.list_rollouts.retry_policy = {
120
124
  initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
@@ -127,6 +131,8 @@ module Google
127
131
 
128
132
  default_config.rpcs.create_rollout.timeout = 60.0
129
133
 
134
+ default_config.rpcs.ignore_job.timeout = 60.0
135
+
130
136
  default_config.rpcs.retry_job.timeout = 60.0
131
137
 
132
138
  default_config.rpcs.list_job_runs.timeout = 60.0
@@ -139,6 +145,8 @@ module Google
139
145
  initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
140
146
  }
141
147
 
148
+ default_config.rpcs.terminate_job_run.timeout = 60.0
149
+
142
150
  default_config.rpcs.get_config.timeout = 60.0
143
151
  default_config.rpcs.get_config.retry_policy = {
144
152
  initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
@@ -282,8 +290,8 @@ module Google
282
290
  # the default parameter values, pass an empty Hash as a request object (see above).
283
291
  #
284
292
  # @param parent [::String]
285
- # Required. The parent, which owns this collection of pipelines. Format must be
286
- # projects/\\{project_id}/locations/\\{location_name}.
293
+ # Required. The parent, which owns this collection of pipelines. Format must
294
+ # be projects/\\{project_id}/locations/\\{location_name}.
287
295
  # @param page_size [::Integer]
288
296
  # The maximum number of pipelines to return. The service may return
289
297
  # fewer than this value. If unspecified, at most 50 pipelines will
@@ -475,8 +483,8 @@ module Google
475
483
  # the default parameter values, pass an empty Hash as a request object (see above).
476
484
  #
477
485
  # @param parent [::String]
478
- # Required. The parent collection in which the `DeliveryPipeline` should be created.
479
- # Format should be projects/\\{project_id}/locations/\\{location_name}.
486
+ # Required. The parent collection in which the `DeliveryPipeline` should be
487
+ # created. Format should be projects/\\{project_id}/locations/\\{location_name}.
480
488
  # @param delivery_pipeline_id [::String]
481
489
  # Required. ID of the `DeliveryPipeline`.
482
490
  # @param delivery_pipeline [::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash]
@@ -496,8 +504,8 @@ module Google
496
504
  # The request ID must be a valid UUID with the exception that zero UUID is
497
505
  # not supported (00000000-0000-0000-0000-000000000000).
498
506
  # @param validate_only [::Boolean]
499
- # Optional. If set to true, the request is validated and the user is provided with
500
- # an expected result, but no actual change is made.
507
+ # Optional. If set to true, the request is validated and the user is provided
508
+ # with an expected result, but no actual change is made.
501
509
  #
502
510
  # @yield [response, operation] Access the result along with the RPC operation
503
511
  # @yieldparam response [::Gapic::Operation]
@@ -612,11 +620,11 @@ module Google
612
620
  # The request ID must be a valid UUID with the exception that zero UUID is
613
621
  # not supported (00000000-0000-0000-0000-000000000000).
614
622
  # @param allow_missing [::Boolean]
615
- # Optional. If set to true, updating a `DeliveryPipeline` that does not exist will
616
- # result in the creation of a new `DeliveryPipeline`.
623
+ # Optional. If set to true, updating a `DeliveryPipeline` that does not exist
624
+ # will result in the creation of a new `DeliveryPipeline`.
617
625
  # @param validate_only [::Boolean]
618
- # Optional. If set to true, the request is validated and the user is provided with
619
- # an expected result, but no actual change is made.
626
+ # Optional. If set to true, the request is validated and the user is provided
627
+ # with an expected result, but no actual change is made.
620
628
  #
621
629
  # @yield [response, operation] Access the result along with the RPC operation
622
630
  # @yieldparam response [::Gapic::Operation]
@@ -729,15 +737,15 @@ module Google
729
737
  # Optional. If set to true, then deleting an already deleted or non-existing
730
738
  # `DeliveryPipeline` will succeed.
731
739
  # @param validate_only [::Boolean]
732
- # Optional. If set, validate the request and preview the review, but do not actually
733
- # post it.
740
+ # Optional. If set, validate the request and preview the review, but do not
741
+ # actually post it.
734
742
  # @param force [::Boolean]
735
- # Optional. If set to true, all child resources under this pipeline will also be
736
- # deleted. Otherwise, the request will only work if the pipeline has
737
- # no child resources.
743
+ # Optional. If set to true, all child resources under this pipeline will also
744
+ # be deleted. Otherwise, the request will only work if the pipeline has no
745
+ # child resources.
738
746
  # @param etag [::String]
739
- # Optional. This checksum is computed by the server based on the value of other
740
- # fields, and may be sent on update and delete requests to ensure the
747
+ # Optional. This checksum is computed by the server based on the value of
748
+ # other fields, and may be sent on update and delete requests to ensure the
741
749
  # client has an up-to-date value before proceeding.
742
750
  #
743
751
  # @yield [response, operation] Access the result along with the RPC operation
@@ -834,9 +842,10 @@ module Google
834
842
  # Required. The parent, which owns this collection of targets. Format must be
835
843
  # projects/\\{project_id}/locations/\\{location_name}.
836
844
  # @param page_size [::Integer]
837
- # Optional. The maximum number of `Target` objects to return. The service may return
838
- # fewer than this value. If unspecified, at most 50 `Target` objects will be
839
- # returned. The maximum value is 1000; values above 1000 will be set to 1000.
845
+ # Optional. The maximum number of `Target` objects to return. The service may
846
+ # return fewer than this value. If unspecified, at most 50 `Target` objects
847
+ # will be returned. The maximum value is 1000; values above 1000 will be set
848
+ # to 1000.
840
849
  # @param page_token [::String]
841
850
  # Optional. A page token, received from a previous `ListTargets` call.
842
851
  # Provide this to retrieve the subsequent page.
@@ -844,10 +853,11 @@ module Google
844
853
  # When paginating, all other provided parameters match
845
854
  # the call that provided the page token.
846
855
  # @param filter [::String]
847
- # Optional. Filter targets to be returned. See https://google.aip.dev/160 for more
848
- # details.
856
+ # Optional. Filter targets to be returned. See https://google.aip.dev/160 for
857
+ # more details.
849
858
  # @param order_by [::String]
850
- # Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
859
+ # Optional. Field to sort by. See https://google.aip.dev/132#ordering for
860
+ # more details.
851
861
  #
852
862
  # @yield [response, operation] Access the result along with the RPC operation
853
863
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Target>]
@@ -1045,8 +1055,8 @@ module Google
1045
1055
  # The request ID must be a valid UUID with the exception that zero UUID is
1046
1056
  # not supported (00000000-0000-0000-0000-000000000000).
1047
1057
  # @param validate_only [::Boolean]
1048
- # Optional. If set to true, the request is validated and the user is provided with
1049
- # an expected result, but no actual change is made.
1058
+ # Optional. If set to true, the request is validated and the user is provided
1059
+ # with an expected result, but no actual change is made.
1050
1060
  #
1051
1061
  # @yield [response, operation] Access the result along with the RPC operation
1052
1062
  # @yieldparam response [::Gapic::Operation]
@@ -1164,8 +1174,8 @@ module Google
1164
1174
  # Optional. If set to true, updating a `Target` that does not exist will
1165
1175
  # result in the creation of a new `Target`.
1166
1176
  # @param validate_only [::Boolean]
1167
- # Optional. If set to true, the request is validated and the user is provided with
1168
- # an expected result, but no actual change is made.
1177
+ # Optional. If set to true, the request is validated and the user is provided
1178
+ # with an expected result, but no actual change is made.
1169
1179
  #
1170
1180
  # @yield [response, operation] Access the result along with the RPC operation
1171
1181
  # @yieldparam response [::Gapic::Operation]
@@ -1278,11 +1288,11 @@ module Google
1278
1288
  # Optional. If set to true, then deleting an already deleted or non-existing
1279
1289
  # DeliveryPipeline will succeed.
1280
1290
  # @param validate_only [::Boolean]
1281
- # Optional. If set, validate the request and preview the review, but do not actually
1282
- # post it.
1291
+ # Optional. If set, validate the request and preview the review, but do not
1292
+ # actually post it.
1283
1293
  # @param etag [::String]
1284
- # Optional. This checksum is computed by the server based on the value of other
1285
- # fields, and may be sent on update and delete requests to ensure the
1294
+ # Optional. This checksum is computed by the server based on the value of
1295
+ # other fields, and may be sent on update and delete requests to ensure the
1286
1296
  # client has an up-to-date value before proceeding.
1287
1297
  #
1288
1298
  # @yield [response, operation] Access the result along with the RPC operation
@@ -1376,11 +1386,13 @@ module Google
1376
1386
  # the default parameter values, pass an empty Hash as a request object (see above).
1377
1387
  #
1378
1388
  # @param parent [::String]
1379
- # Required. The `DeliveryPipeline` which owns this collection of `Release` objects.
1389
+ # Required. The `DeliveryPipeline` which owns this collection of `Release`
1390
+ # objects.
1380
1391
  # @param page_size [::Integer]
1381
- # Optional. The maximum number of `Release` objects to return. The service may return
1382
- # fewer than this value. If unspecified, at most 50 `Release` objects will be
1383
- # returned. The maximum value is 1000; values above 1000 will be set to 1000.
1392
+ # Optional. The maximum number of `Release` objects to return. The service
1393
+ # may return fewer than this value. If unspecified, at most 50 `Release`
1394
+ # objects will be returned. The maximum value is 1000; values above 1000 will
1395
+ # be set to 1000.
1384
1396
  # @param page_token [::String]
1385
1397
  # Optional. A page token, received from a previous `ListReleases` call.
1386
1398
  # Provide this to retrieve the subsequent page.
@@ -1388,10 +1400,11 @@ module Google
1388
1400
  # When paginating, all other provided parameters match
1389
1401
  # the call that provided the page token.
1390
1402
  # @param filter [::String]
1391
- # Optional. Filter releases to be returned. See https://google.aip.dev/160 for more
1392
- # details.
1403
+ # Optional. Filter releases to be returned. See https://google.aip.dev/160
1404
+ # for more details.
1393
1405
  # @param order_by [::String]
1394
- # Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
1406
+ # Optional. Field to sort by. See https://google.aip.dev/132#ordering for
1407
+ # more details.
1395
1408
  #
1396
1409
  # @yield [response, operation] Access the result along with the RPC operation
1397
1410
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Release>]
@@ -1589,8 +1602,8 @@ module Google
1589
1602
  # The request ID must be a valid UUID with the exception that zero UUID is
1590
1603
  # not supported (00000000-0000-0000-0000-000000000000).
1591
1604
  # @param validate_only [::Boolean]
1592
- # Optional. If set to true, the request is validated and the user is provided with
1593
- # an expected result, but no actual change is made.
1605
+ # Optional. If set to true, the request is validated and the user is provided
1606
+ # with an expected result, but no actual change is made.
1594
1607
  #
1595
1608
  # @yield [response, operation] Access the result along with the RPC operation
1596
1609
  # @yieldparam response [::Gapic::Operation]
@@ -1840,6 +1853,182 @@ module Google
1840
1853
  raise ::Google::Cloud::Error.from_error(e)
1841
1854
  end
1842
1855
 
1856
+ ##
1857
+ # Advances a Rollout in a given project and location.
1858
+ #
1859
+ # @overload advance_rollout(request, options = nil)
1860
+ # Pass arguments to `advance_rollout` via a request object, either of type
1861
+ # {::Google::Cloud::Deploy::V1::AdvanceRolloutRequest} or an equivalent Hash.
1862
+ #
1863
+ # @param request [::Google::Cloud::Deploy::V1::AdvanceRolloutRequest, ::Hash]
1864
+ # A request object representing the call parameters. Required. To specify no
1865
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1866
+ # @param options [::Gapic::CallOptions, ::Hash]
1867
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1868
+ #
1869
+ # @overload advance_rollout(name: nil, phase_id: nil)
1870
+ # Pass arguments to `advance_rollout` via keyword arguments. Note that at
1871
+ # least one keyword argument is required. To specify no parameters, or to keep all
1872
+ # the default parameter values, pass an empty Hash as a request object (see above).
1873
+ #
1874
+ # @param name [::String]
1875
+ # Required. Name of the Rollout. Format is
1876
+ # projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
1877
+ # releases/\\{release}/rollouts/\\{rollout}.
1878
+ # @param phase_id [::String]
1879
+ # Required. The phase ID to advance the `Rollout` to.
1880
+ #
1881
+ # @yield [response, operation] Access the result along with the RPC operation
1882
+ # @yieldparam response [::Google::Cloud::Deploy::V1::AdvanceRolloutResponse]
1883
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1884
+ #
1885
+ # @return [::Google::Cloud::Deploy::V1::AdvanceRolloutResponse]
1886
+ #
1887
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1888
+ #
1889
+ # @example Basic example
1890
+ # require "google/cloud/deploy/v1"
1891
+ #
1892
+ # # Create a client object. The client can be reused for multiple calls.
1893
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
1894
+ #
1895
+ # # Create a request. To set request fields, pass in keyword arguments.
1896
+ # request = Google::Cloud::Deploy::V1::AdvanceRolloutRequest.new
1897
+ #
1898
+ # # Call the advance_rollout method.
1899
+ # result = client.advance_rollout request
1900
+ #
1901
+ # # The returned object is of type Google::Cloud::Deploy::V1::AdvanceRolloutResponse.
1902
+ # p result
1903
+ #
1904
+ def advance_rollout request, options = nil
1905
+ raise ::ArgumentError, "request must be provided" if request.nil?
1906
+
1907
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::AdvanceRolloutRequest
1908
+
1909
+ # Converts hash and nil to an options object
1910
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1911
+
1912
+ # Customize the options with defaults
1913
+ metadata = @config.rpcs.advance_rollout.metadata.to_h
1914
+
1915
+ # Set x-goog-api-client and x-goog-user-project headers
1916
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1917
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
1918
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION
1919
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1920
+
1921
+ header_params = {}
1922
+ if request.name
1923
+ header_params["name"] = request.name
1924
+ end
1925
+
1926
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
1927
+ metadata[:"x-goog-request-params"] ||= request_params_header
1928
+
1929
+ options.apply_defaults timeout: @config.rpcs.advance_rollout.timeout,
1930
+ metadata: metadata,
1931
+ retry_policy: @config.rpcs.advance_rollout.retry_policy
1932
+
1933
+ options.apply_defaults timeout: @config.timeout,
1934
+ metadata: @config.metadata,
1935
+ retry_policy: @config.retry_policy
1936
+
1937
+ @cloud_deploy_stub.call_rpc :advance_rollout, request, options: options do |response, operation|
1938
+ yield response, operation if block_given?
1939
+ return response
1940
+ end
1941
+ rescue ::GRPC::BadStatus => e
1942
+ raise ::Google::Cloud::Error.from_error(e)
1943
+ end
1944
+
1945
+ ##
1946
+ # Cancels a Rollout in a given project and location.
1947
+ #
1948
+ # @overload cancel_rollout(request, options = nil)
1949
+ # Pass arguments to `cancel_rollout` via a request object, either of type
1950
+ # {::Google::Cloud::Deploy::V1::CancelRolloutRequest} or an equivalent Hash.
1951
+ #
1952
+ # @param request [::Google::Cloud::Deploy::V1::CancelRolloutRequest, ::Hash]
1953
+ # A request object representing the call parameters. Required. To specify no
1954
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
1955
+ # @param options [::Gapic::CallOptions, ::Hash]
1956
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
1957
+ #
1958
+ # @overload cancel_rollout(name: nil)
1959
+ # Pass arguments to `cancel_rollout` via keyword arguments. Note that at
1960
+ # least one keyword argument is required. To specify no parameters, or to keep all
1961
+ # the default parameter values, pass an empty Hash as a request object (see above).
1962
+ #
1963
+ # @param name [::String]
1964
+ # Required. Name of the Rollout. Format is
1965
+ # projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
1966
+ # releases/\\{release}/rollouts/\\{rollout}.
1967
+ #
1968
+ # @yield [response, operation] Access the result along with the RPC operation
1969
+ # @yieldparam response [::Google::Cloud::Deploy::V1::CancelRolloutResponse]
1970
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
1971
+ #
1972
+ # @return [::Google::Cloud::Deploy::V1::CancelRolloutResponse]
1973
+ #
1974
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
1975
+ #
1976
+ # @example Basic example
1977
+ # require "google/cloud/deploy/v1"
1978
+ #
1979
+ # # Create a client object. The client can be reused for multiple calls.
1980
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
1981
+ #
1982
+ # # Create a request. To set request fields, pass in keyword arguments.
1983
+ # request = Google::Cloud::Deploy::V1::CancelRolloutRequest.new
1984
+ #
1985
+ # # Call the cancel_rollout method.
1986
+ # result = client.cancel_rollout request
1987
+ #
1988
+ # # The returned object is of type Google::Cloud::Deploy::V1::CancelRolloutResponse.
1989
+ # p result
1990
+ #
1991
+ def cancel_rollout request, options = nil
1992
+ raise ::ArgumentError, "request must be provided" if request.nil?
1993
+
1994
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CancelRolloutRequest
1995
+
1996
+ # Converts hash and nil to an options object
1997
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
1998
+
1999
+ # Customize the options with defaults
2000
+ metadata = @config.rpcs.cancel_rollout.metadata.to_h
2001
+
2002
+ # Set x-goog-api-client and x-goog-user-project headers
2003
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2004
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2005
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION
2006
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2007
+
2008
+ header_params = {}
2009
+ if request.name
2010
+ header_params["name"] = request.name
2011
+ end
2012
+
2013
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2014
+ metadata[:"x-goog-request-params"] ||= request_params_header
2015
+
2016
+ options.apply_defaults timeout: @config.rpcs.cancel_rollout.timeout,
2017
+ metadata: metadata,
2018
+ retry_policy: @config.rpcs.cancel_rollout.retry_policy
2019
+
2020
+ options.apply_defaults timeout: @config.timeout,
2021
+ metadata: @config.metadata,
2022
+ retry_policy: @config.retry_policy
2023
+
2024
+ @cloud_deploy_stub.call_rpc :cancel_rollout, request, options: options do |response, operation|
2025
+ yield response, operation if block_given?
2026
+ return response
2027
+ end
2028
+ rescue ::GRPC::BadStatus => e
2029
+ raise ::Google::Cloud::Error.from_error(e)
2030
+ end
2031
+
1843
2032
  ##
1844
2033
  # Lists Rollouts in a given project and location.
1845
2034
  #
@@ -1861,9 +2050,10 @@ module Google
1861
2050
  # @param parent [::String]
1862
2051
  # Required. The `Release` which owns this collection of `Rollout` objects.
1863
2052
  # @param page_size [::Integer]
1864
- # Optional. The maximum number of `Rollout` objects to return. The service may return
1865
- # fewer than this value. If unspecified, at most 50 `Rollout` objects will be
1866
- # returned. The maximum value is 1000; values above 1000 will be set to 1000.
2053
+ # Optional. The maximum number of `Rollout` objects to return. The service
2054
+ # may return fewer than this value. If unspecified, at most 50 `Rollout`
2055
+ # objects will be returned. The maximum value is 1000; values above 1000 will
2056
+ # be set to 1000.
1867
2057
  # @param page_token [::String]
1868
2058
  # Optional. A page token, received from a previous `ListRollouts` call.
1869
2059
  # Provide this to retrieve the subsequent page.
@@ -1871,10 +2061,11 @@ module Google
1871
2061
  # When paginating, all other provided parameters match
1872
2062
  # the call that provided the page token.
1873
2063
  # @param filter [::String]
1874
- # Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more
1875
- # details.
2064
+ # Optional. Filter rollouts to be returned. See https://google.aip.dev/160
2065
+ # for more details.
1876
2066
  # @param order_by [::String]
1877
- # Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
2067
+ # Optional. Field to sort by. See https://google.aip.dev/132#ordering for
2068
+ # more details.
1878
2069
  #
1879
2070
  # @yield [response, operation] Access the result along with the RPC operation
1880
2071
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Rollout>]
@@ -2044,7 +2235,7 @@ module Google
2044
2235
  # @param options [::Gapic::CallOptions, ::Hash]
2045
2236
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2046
2237
  #
2047
- # @overload create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil)
2238
+ # @overload create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil, starting_phase_id: nil)
2048
2239
  # Pass arguments to `create_rollout` via keyword arguments. Note that at
2049
2240
  # least one keyword argument is required. To specify no parameters, or to keep all
2050
2241
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -2072,8 +2263,11 @@ module Google
2072
2263
  # The request ID must be a valid UUID with the exception that zero UUID is
2073
2264
  # not supported (00000000-0000-0000-0000-000000000000).
2074
2265
  # @param validate_only [::Boolean]
2075
- # Optional. If set to true, the request is validated and the user is provided with
2076
- # an expected result, but no actual change is made.
2266
+ # Optional. If set to true, the request is validated and the user is provided
2267
+ # with an expected result, but no actual change is made.
2268
+ # @param starting_phase_id [::String]
2269
+ # Optional. The starting phase ID for the `Rollout`. If empty the `Rollout`
2270
+ # will start at the first phase.
2077
2271
  #
2078
2272
  # @yield [response, operation] Access the result along with the RPC operation
2079
2273
  # @yieldparam response [::Gapic::Operation]
@@ -2147,6 +2341,97 @@ module Google
2147
2341
  raise ::Google::Cloud::Error.from_error(e)
2148
2342
  end
2149
2343
 
2344
+ ##
2345
+ # Ignores the specified Job in a Rollout.
2346
+ #
2347
+ # @overload ignore_job(request, options = nil)
2348
+ # Pass arguments to `ignore_job` via a request object, either of type
2349
+ # {::Google::Cloud::Deploy::V1::IgnoreJobRequest} or an equivalent Hash.
2350
+ #
2351
+ # @param request [::Google::Cloud::Deploy::V1::IgnoreJobRequest, ::Hash]
2352
+ # A request object representing the call parameters. Required. To specify no
2353
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2354
+ # @param options [::Gapic::CallOptions, ::Hash]
2355
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2356
+ #
2357
+ # @overload ignore_job(rollout: nil, phase_id: nil, job_id: nil)
2358
+ # Pass arguments to `ignore_job` via keyword arguments. Note that at
2359
+ # least one keyword argument is required. To specify no parameters, or to keep all
2360
+ # the default parameter values, pass an empty Hash as a request object (see above).
2361
+ #
2362
+ # @param rollout [::String]
2363
+ # Required. Name of the Rollout. Format is
2364
+ # projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
2365
+ # releases/\\{release}/rollouts/\\{rollout}.
2366
+ # @param phase_id [::String]
2367
+ # Required. The phase ID the Job to ignore belongs to.
2368
+ # @param job_id [::String]
2369
+ # Required. The job ID for the Job to ignore.
2370
+ #
2371
+ # @yield [response, operation] Access the result along with the RPC operation
2372
+ # @yieldparam response [::Google::Cloud::Deploy::V1::IgnoreJobResponse]
2373
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2374
+ #
2375
+ # @return [::Google::Cloud::Deploy::V1::IgnoreJobResponse]
2376
+ #
2377
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2378
+ #
2379
+ # @example Basic example
2380
+ # require "google/cloud/deploy/v1"
2381
+ #
2382
+ # # Create a client object. The client can be reused for multiple calls.
2383
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
2384
+ #
2385
+ # # Create a request. To set request fields, pass in keyword arguments.
2386
+ # request = Google::Cloud::Deploy::V1::IgnoreJobRequest.new
2387
+ #
2388
+ # # Call the ignore_job method.
2389
+ # result = client.ignore_job request
2390
+ #
2391
+ # # The returned object is of type Google::Cloud::Deploy::V1::IgnoreJobResponse.
2392
+ # p result
2393
+ #
2394
+ def ignore_job request, options = nil
2395
+ raise ::ArgumentError, "request must be provided" if request.nil?
2396
+
2397
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::IgnoreJobRequest
2398
+
2399
+ # Converts hash and nil to an options object
2400
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2401
+
2402
+ # Customize the options with defaults
2403
+ metadata = @config.rpcs.ignore_job.metadata.to_h
2404
+
2405
+ # Set x-goog-api-client and x-goog-user-project headers
2406
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2407
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2408
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION
2409
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2410
+
2411
+ header_params = {}
2412
+ if request.rollout
2413
+ header_params["rollout"] = request.rollout
2414
+ end
2415
+
2416
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2417
+ metadata[:"x-goog-request-params"] ||= request_params_header
2418
+
2419
+ options.apply_defaults timeout: @config.rpcs.ignore_job.timeout,
2420
+ metadata: metadata,
2421
+ retry_policy: @config.rpcs.ignore_job.retry_policy
2422
+
2423
+ options.apply_defaults timeout: @config.timeout,
2424
+ metadata: @config.metadata,
2425
+ retry_policy: @config.retry_policy
2426
+
2427
+ @cloud_deploy_stub.call_rpc :ignore_job, request, options: options do |response, operation|
2428
+ yield response, operation if block_given?
2429
+ return response
2430
+ end
2431
+ rescue ::GRPC::BadStatus => e
2432
+ raise ::Google::Cloud::Error.from_error(e)
2433
+ end
2434
+
2150
2435
  ##
2151
2436
  # Retries the specified Job in a Rollout.
2152
2437
  #
@@ -2259,20 +2544,22 @@ module Google
2259
2544
  # @param parent [::String]
2260
2545
  # Required. The `Rollout` which owns this collection of `JobRun` objects.
2261
2546
  # @param page_size [::Integer]
2262
- # Optional. The maximum number of `JobRun` objects to return. The service may return
2263
- # fewer than this value. If unspecified, at most 50 `JobRun` objects will be
2264
- # returned. The maximum value is 1000; values above 1000 will be set to 1000.
2547
+ # Optional. The maximum number of `JobRun` objects to return. The service may
2548
+ # return fewer than this value. If unspecified, at most 50 `JobRun` objects
2549
+ # will be returned. The maximum value is 1000; values above 1000 will be set
2550
+ # to 1000.
2265
2551
  # @param page_token [::String]
2266
- # Optional. A page token, received from a previous `ListJobRuns` call. Provide this
2267
- # to retrieve the subsequent page.
2552
+ # Optional. A page token, received from a previous `ListJobRuns` call.
2553
+ # Provide this to retrieve the subsequent page.
2268
2554
  #
2269
2555
  # When paginating, all other provided parameters match the call that provided
2270
2556
  # the page token.
2271
2557
  # @param filter [::String]
2272
- # Optional. Filter results to be returned. See https://google.aip.dev/160 for more
2273
- # details.
2558
+ # Optional. Filter results to be returned. See https://google.aip.dev/160 for
2559
+ # more details.
2274
2560
  # @param order_by [::String]
2275
- # Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
2561
+ # Optional. Field to sort by. See https://google.aip.dev/132#ordering for
2562
+ # more details.
2276
2563
  #
2277
2564
  # @yield [response, operation] Access the result along with the RPC operation
2278
2565
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::JobRun>]
@@ -2429,6 +2716,93 @@ module Google
2429
2716
  raise ::Google::Cloud::Error.from_error(e)
2430
2717
  end
2431
2718
 
2719
+ ##
2720
+ # Terminates a Job Run in a given project and location.
2721
+ #
2722
+ # @overload terminate_job_run(request, options = nil)
2723
+ # Pass arguments to `terminate_job_run` via a request object, either of type
2724
+ # {::Google::Cloud::Deploy::V1::TerminateJobRunRequest} or an equivalent Hash.
2725
+ #
2726
+ # @param request [::Google::Cloud::Deploy::V1::TerminateJobRunRequest, ::Hash]
2727
+ # A request object representing the call parameters. Required. To specify no
2728
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
2729
+ # @param options [::Gapic::CallOptions, ::Hash]
2730
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
2731
+ #
2732
+ # @overload terminate_job_run(name: nil)
2733
+ # Pass arguments to `terminate_job_run` via keyword arguments. Note that at
2734
+ # least one keyword argument is required. To specify no parameters, or to keep all
2735
+ # the default parameter values, pass an empty Hash as a request object (see above).
2736
+ #
2737
+ # @param name [::String]
2738
+ # Required. Name of the `JobRun`. Format must be
2739
+ # projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
2740
+ # releases/\\{release}/rollouts/\\{rollout}/jobRuns/\\{jobRun}.
2741
+ #
2742
+ # @yield [response, operation] Access the result along with the RPC operation
2743
+ # @yieldparam response [::Google::Cloud::Deploy::V1::TerminateJobRunResponse]
2744
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
2745
+ #
2746
+ # @return [::Google::Cloud::Deploy::V1::TerminateJobRunResponse]
2747
+ #
2748
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
2749
+ #
2750
+ # @example Basic example
2751
+ # require "google/cloud/deploy/v1"
2752
+ #
2753
+ # # Create a client object. The client can be reused for multiple calls.
2754
+ # client = Google::Cloud::Deploy::V1::CloudDeploy::Client.new
2755
+ #
2756
+ # # Create a request. To set request fields, pass in keyword arguments.
2757
+ # request = Google::Cloud::Deploy::V1::TerminateJobRunRequest.new
2758
+ #
2759
+ # # Call the terminate_job_run method.
2760
+ # result = client.terminate_job_run request
2761
+ #
2762
+ # # The returned object is of type Google::Cloud::Deploy::V1::TerminateJobRunResponse.
2763
+ # p result
2764
+ #
2765
+ def terminate_job_run request, options = nil
2766
+ raise ::ArgumentError, "request must be provided" if request.nil?
2767
+
2768
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::TerminateJobRunRequest
2769
+
2770
+ # Converts hash and nil to an options object
2771
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
2772
+
2773
+ # Customize the options with defaults
2774
+ metadata = @config.rpcs.terminate_job_run.metadata.to_h
2775
+
2776
+ # Set x-goog-api-client and x-goog-user-project headers
2777
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
2778
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
2779
+ gapic_version: ::Google::Cloud::Deploy::V1::VERSION
2780
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
2781
+
2782
+ header_params = {}
2783
+ if request.name
2784
+ header_params["name"] = request.name
2785
+ end
2786
+
2787
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
2788
+ metadata[:"x-goog-request-params"] ||= request_params_header
2789
+
2790
+ options.apply_defaults timeout: @config.rpcs.terminate_job_run.timeout,
2791
+ metadata: metadata,
2792
+ retry_policy: @config.rpcs.terminate_job_run.retry_policy
2793
+
2794
+ options.apply_defaults timeout: @config.timeout,
2795
+ metadata: @config.metadata,
2796
+ retry_policy: @config.retry_policy
2797
+
2798
+ @cloud_deploy_stub.call_rpc :terminate_job_run, request, options: options do |response, operation|
2799
+ yield response, operation if block_given?
2800
+ return response
2801
+ end
2802
+ rescue ::GRPC::BadStatus => e
2803
+ raise ::Google::Cloud::Error.from_error(e)
2804
+ end
2805
+
2432
2806
  ##
2433
2807
  # Gets the configuration for a location.
2434
2808
  #
@@ -2552,9 +2926,9 @@ module Google
2552
2926
  # * (`String`) The path to a service account key file in JSON format
2553
2927
  # * (`Hash`) A service account key as a Hash
2554
2928
  # * (`Google::Auth::Credentials`) A googleauth credentials object
2555
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
2929
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
2556
2930
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2557
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
2931
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2558
2932
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
2559
2933
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
2560
2934
  # * (`nil`) indicating no credentials
@@ -2725,6 +3099,16 @@ module Google
2725
3099
  #
2726
3100
  attr_reader :approve_rollout
2727
3101
  ##
3102
+ # RPC-specific configuration for `advance_rollout`
3103
+ # @return [::Gapic::Config::Method]
3104
+ #
3105
+ attr_reader :advance_rollout
3106
+ ##
3107
+ # RPC-specific configuration for `cancel_rollout`
3108
+ # @return [::Gapic::Config::Method]
3109
+ #
3110
+ attr_reader :cancel_rollout
3111
+ ##
2728
3112
  # RPC-specific configuration for `list_rollouts`
2729
3113
  # @return [::Gapic::Config::Method]
2730
3114
  #
@@ -2740,6 +3124,11 @@ module Google
2740
3124
  #
2741
3125
  attr_reader :create_rollout
2742
3126
  ##
3127
+ # RPC-specific configuration for `ignore_job`
3128
+ # @return [::Gapic::Config::Method]
3129
+ #
3130
+ attr_reader :ignore_job
3131
+ ##
2743
3132
  # RPC-specific configuration for `retry_job`
2744
3133
  # @return [::Gapic::Config::Method]
2745
3134
  #
@@ -2755,6 +3144,11 @@ module Google
2755
3144
  #
2756
3145
  attr_reader :get_job_run
2757
3146
  ##
3147
+ # RPC-specific configuration for `terminate_job_run`
3148
+ # @return [::Gapic::Config::Method]
3149
+ #
3150
+ attr_reader :terminate_job_run
3151
+ ##
2758
3152
  # RPC-specific configuration for `get_config`
2759
3153
  # @return [::Gapic::Config::Method]
2760
3154
  #
@@ -2792,18 +3186,26 @@ module Google
2792
3186
  @abandon_release = ::Gapic::Config::Method.new abandon_release_config
2793
3187
  approve_rollout_config = parent_rpcs.approve_rollout if parent_rpcs.respond_to? :approve_rollout
2794
3188
  @approve_rollout = ::Gapic::Config::Method.new approve_rollout_config
3189
+ advance_rollout_config = parent_rpcs.advance_rollout if parent_rpcs.respond_to? :advance_rollout
3190
+ @advance_rollout = ::Gapic::Config::Method.new advance_rollout_config
3191
+ cancel_rollout_config = parent_rpcs.cancel_rollout if parent_rpcs.respond_to? :cancel_rollout
3192
+ @cancel_rollout = ::Gapic::Config::Method.new cancel_rollout_config
2795
3193
  list_rollouts_config = parent_rpcs.list_rollouts if parent_rpcs.respond_to? :list_rollouts
2796
3194
  @list_rollouts = ::Gapic::Config::Method.new list_rollouts_config
2797
3195
  get_rollout_config = parent_rpcs.get_rollout if parent_rpcs.respond_to? :get_rollout
2798
3196
  @get_rollout = ::Gapic::Config::Method.new get_rollout_config
2799
3197
  create_rollout_config = parent_rpcs.create_rollout if parent_rpcs.respond_to? :create_rollout
2800
3198
  @create_rollout = ::Gapic::Config::Method.new create_rollout_config
3199
+ ignore_job_config = parent_rpcs.ignore_job if parent_rpcs.respond_to? :ignore_job
3200
+ @ignore_job = ::Gapic::Config::Method.new ignore_job_config
2801
3201
  retry_job_config = parent_rpcs.retry_job if parent_rpcs.respond_to? :retry_job
2802
3202
  @retry_job = ::Gapic::Config::Method.new retry_job_config
2803
3203
  list_job_runs_config = parent_rpcs.list_job_runs if parent_rpcs.respond_to? :list_job_runs
2804
3204
  @list_job_runs = ::Gapic::Config::Method.new list_job_runs_config
2805
3205
  get_job_run_config = parent_rpcs.get_job_run if parent_rpcs.respond_to? :get_job_run
2806
3206
  @get_job_run = ::Gapic::Config::Method.new get_job_run_config
3207
+ terminate_job_run_config = parent_rpcs.terminate_job_run if parent_rpcs.respond_to? :terminate_job_run
3208
+ @terminate_job_run = ::Gapic::Config::Method.new terminate_job_run_config
2807
3209
  get_config_config = parent_rpcs.get_config if parent_rpcs.respond_to? :get_config
2808
3210
  @get_config = ::Gapic::Config::Method.new get_config_config
2809
3211