google-cloud-deploy-v1 0.5.0 → 0.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/lib/google/cloud/deploy/v1/cloud_deploy/client.rb +461 -59
- data/lib/google/cloud/deploy/v1/cloud_deploy/operations.rb +2 -2
- data/lib/google/cloud/deploy/v1/cloud_deploy/paths.rb +19 -0
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb +369 -59
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/operations.rb +2 -2
- data/lib/google/cloud/deploy/v1/cloud_deploy/rest/service_stub.rb +240 -0
- data/lib/google/cloud/deploy/v1/cloud_deploy_pb.rb +181 -0
- data/lib/google/cloud/deploy/v1/cloud_deploy_services_pb.rb +8 -0
- data/lib/google/cloud/deploy/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +9 -3
- data/proto_docs/google/cloud/deploy/v1/cloud_deploy.rb +638 -118
- data/proto_docs/google/cloud/deploy/v1/log_enums.rb +1 -1
- metadata +2 -2
@@ -117,6 +117,10 @@ module Google
|
|
117
117
|
|
118
118
|
default_config.rpcs.approve_rollout.timeout = 60.0
|
119
119
|
|
120
|
+
default_config.rpcs.advance_rollout.timeout = 60.0
|
121
|
+
|
122
|
+
default_config.rpcs.cancel_rollout.timeout = 60.0
|
123
|
+
|
120
124
|
default_config.rpcs.list_rollouts.timeout = 60.0
|
121
125
|
default_config.rpcs.list_rollouts.retry_policy = {
|
122
126
|
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
@@ -129,6 +133,8 @@ module Google
|
|
129
133
|
|
130
134
|
default_config.rpcs.create_rollout.timeout = 60.0
|
131
135
|
|
136
|
+
default_config.rpcs.ignore_job.timeout = 60.0
|
137
|
+
|
132
138
|
default_config.rpcs.retry_job.timeout = 60.0
|
133
139
|
|
134
140
|
default_config.rpcs.list_job_runs.timeout = 60.0
|
@@ -141,6 +147,8 @@ module Google
|
|
141
147
|
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
142
148
|
}
|
143
149
|
|
150
|
+
default_config.rpcs.terminate_job_run.timeout = 60.0
|
151
|
+
|
144
152
|
default_config.rpcs.get_config.timeout = 60.0
|
145
153
|
default_config.rpcs.get_config.retry_policy = {
|
146
154
|
initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
|
@@ -275,8 +283,8 @@ module Google
|
|
275
283
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
276
284
|
#
|
277
285
|
# @param parent [::String]
|
278
|
-
# Required. The parent, which owns this collection of pipelines. Format must
|
279
|
-
# projects/\\{project_id}/locations/\\{location_name}.
|
286
|
+
# Required. The parent, which owns this collection of pipelines. Format must
|
287
|
+
# be projects/\\{project_id}/locations/\\{location_name}.
|
280
288
|
# @param page_size [::Integer]
|
281
289
|
# The maximum number of pipelines to return. The service may return
|
282
290
|
# fewer than this value. If unspecified, at most 50 pipelines will
|
@@ -417,8 +425,8 @@ module Google
|
|
417
425
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
418
426
|
#
|
419
427
|
# @param parent [::String]
|
420
|
-
# Required. The parent collection in which the `DeliveryPipeline` should be
|
421
|
-
# Format should be projects/\\{project_id}/locations/\\{location_name}.
|
428
|
+
# Required. The parent collection in which the `DeliveryPipeline` should be
|
429
|
+
# created. Format should be projects/\\{project_id}/locations/\\{location_name}.
|
422
430
|
# @param delivery_pipeline_id [::String]
|
423
431
|
# Required. ID of the `DeliveryPipeline`.
|
424
432
|
# @param delivery_pipeline [::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash]
|
@@ -438,8 +446,8 @@ module Google
|
|
438
446
|
# The request ID must be a valid UUID with the exception that zero UUID is
|
439
447
|
# not supported (00000000-0000-0000-0000-000000000000).
|
440
448
|
# @param validate_only [::Boolean]
|
441
|
-
# Optional. If set to true, the request is validated and the user is provided
|
442
|
-
# an expected result, but no actual change is made.
|
449
|
+
# Optional. If set to true, the request is validated and the user is provided
|
450
|
+
# with an expected result, but no actual change is made.
|
443
451
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
444
452
|
# @yieldparam result [::Gapic::Operation]
|
445
453
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -524,11 +532,11 @@ module Google
|
|
524
532
|
# The request ID must be a valid UUID with the exception that zero UUID is
|
525
533
|
# not supported (00000000-0000-0000-0000-000000000000).
|
526
534
|
# @param allow_missing [::Boolean]
|
527
|
-
# Optional. If set to true, updating a `DeliveryPipeline` that does not exist
|
528
|
-
# result in the creation of a new `DeliveryPipeline`.
|
535
|
+
# Optional. If set to true, updating a `DeliveryPipeline` that does not exist
|
536
|
+
# will result in the creation of a new `DeliveryPipeline`.
|
529
537
|
# @param validate_only [::Boolean]
|
530
|
-
# Optional. If set to true, the request is validated and the user is provided
|
531
|
-
# an expected result, but no actual change is made.
|
538
|
+
# Optional. If set to true, the request is validated and the user is provided
|
539
|
+
# with an expected result, but no actual change is made.
|
532
540
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
533
541
|
# @yieldparam result [::Gapic::Operation]
|
534
542
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -611,15 +619,15 @@ module Google
|
|
611
619
|
# Optional. If set to true, then deleting an already deleted or non-existing
|
612
620
|
# `DeliveryPipeline` will succeed.
|
613
621
|
# @param validate_only [::Boolean]
|
614
|
-
# Optional. If set, validate the request and preview the review, but do not
|
615
|
-
# post it.
|
622
|
+
# Optional. If set, validate the request and preview the review, but do not
|
623
|
+
# actually post it.
|
616
624
|
# @param force [::Boolean]
|
617
|
-
# Optional. If set to true, all child resources under this pipeline will also
|
618
|
-
# deleted. Otherwise, the request will only work if the pipeline has
|
619
|
-
#
|
625
|
+
# Optional. If set to true, all child resources under this pipeline will also
|
626
|
+
# be deleted. Otherwise, the request will only work if the pipeline has no
|
627
|
+
# child resources.
|
620
628
|
# @param etag [::String]
|
621
|
-
# Optional. This checksum is computed by the server based on the value of
|
622
|
-
# fields, and may be sent on update and delete requests to ensure the
|
629
|
+
# Optional. This checksum is computed by the server based on the value of
|
630
|
+
# other fields, and may be sent on update and delete requests to ensure the
|
623
631
|
# client has an up-to-date value before proceeding.
|
624
632
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
625
633
|
# @yieldparam result [::Gapic::Operation]
|
@@ -686,9 +694,10 @@ module Google
|
|
686
694
|
# Required. The parent, which owns this collection of targets. Format must be
|
687
695
|
# projects/\\{project_id}/locations/\\{location_name}.
|
688
696
|
# @param page_size [::Integer]
|
689
|
-
# Optional. The maximum number of `Target` objects to return. The service may
|
690
|
-
# fewer than this value. If unspecified, at most 50 `Target` objects
|
691
|
-
# returned. The maximum value is 1000; values above 1000 will be set
|
697
|
+
# Optional. The maximum number of `Target` objects to return. The service may
|
698
|
+
# return fewer than this value. If unspecified, at most 50 `Target` objects
|
699
|
+
# will be returned. The maximum value is 1000; values above 1000 will be set
|
700
|
+
# to 1000.
|
692
701
|
# @param page_token [::String]
|
693
702
|
# Optional. A page token, received from a previous `ListTargets` call.
|
694
703
|
# Provide this to retrieve the subsequent page.
|
@@ -696,10 +705,11 @@ module Google
|
|
696
705
|
# When paginating, all other provided parameters match
|
697
706
|
# the call that provided the page token.
|
698
707
|
# @param filter [::String]
|
699
|
-
# Optional. Filter targets to be returned. See https://google.aip.dev/160 for
|
700
|
-
# details.
|
708
|
+
# Optional. Filter targets to be returned. See https://google.aip.dev/160 for
|
709
|
+
# more details.
|
701
710
|
# @param order_by [::String]
|
702
|
-
# Optional. Field to sort by. See https://google.aip.dev/132#ordering for
|
711
|
+
# Optional. Field to sort by. See https://google.aip.dev/132#ordering for
|
712
|
+
# more details.
|
703
713
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
704
714
|
# @yieldparam result [::Google::Cloud::Deploy::V1::ListTargetsResponse]
|
705
715
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -846,8 +856,8 @@ module Google
|
|
846
856
|
# The request ID must be a valid UUID with the exception that zero UUID is
|
847
857
|
# not supported (00000000-0000-0000-0000-000000000000).
|
848
858
|
# @param validate_only [::Boolean]
|
849
|
-
# Optional. If set to true, the request is validated and the user is provided
|
850
|
-
# an expected result, but no actual change is made.
|
859
|
+
# Optional. If set to true, the request is validated and the user is provided
|
860
|
+
# with an expected result, but no actual change is made.
|
851
861
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
852
862
|
# @yieldparam result [::Gapic::Operation]
|
853
863
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -935,8 +945,8 @@ module Google
|
|
935
945
|
# Optional. If set to true, updating a `Target` that does not exist will
|
936
946
|
# result in the creation of a new `Target`.
|
937
947
|
# @param validate_only [::Boolean]
|
938
|
-
# Optional. If set to true, the request is validated and the user is provided
|
939
|
-
# an expected result, but no actual change is made.
|
948
|
+
# Optional. If set to true, the request is validated and the user is provided
|
949
|
+
# with an expected result, but no actual change is made.
|
940
950
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
941
951
|
# @yieldparam result [::Gapic::Operation]
|
942
952
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -1019,11 +1029,11 @@ module Google
|
|
1019
1029
|
# Optional. If set to true, then deleting an already deleted or non-existing
|
1020
1030
|
# DeliveryPipeline will succeed.
|
1021
1031
|
# @param validate_only [::Boolean]
|
1022
|
-
# Optional. If set, validate the request and preview the review, but do not
|
1023
|
-
# post it.
|
1032
|
+
# Optional. If set, validate the request and preview the review, but do not
|
1033
|
+
# actually post it.
|
1024
1034
|
# @param etag [::String]
|
1025
|
-
# Optional. This checksum is computed by the server based on the value of
|
1026
|
-
# fields, and may be sent on update and delete requests to ensure the
|
1035
|
+
# Optional. This checksum is computed by the server based on the value of
|
1036
|
+
# other fields, and may be sent on update and delete requests to ensure the
|
1027
1037
|
# client has an up-to-date value before proceeding.
|
1028
1038
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
1029
1039
|
# @yieldparam result [::Gapic::Operation]
|
@@ -1087,11 +1097,13 @@ module Google
|
|
1087
1097
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
1088
1098
|
#
|
1089
1099
|
# @param parent [::String]
|
1090
|
-
# Required. The `DeliveryPipeline` which owns this collection of `Release`
|
1100
|
+
# Required. The `DeliveryPipeline` which owns this collection of `Release`
|
1101
|
+
# objects.
|
1091
1102
|
# @param page_size [::Integer]
|
1092
|
-
# Optional. The maximum number of `Release` objects to return. The service
|
1093
|
-
# fewer than this value. If unspecified, at most 50 `Release`
|
1094
|
-
# returned. The maximum value is 1000; values above 1000 will
|
1103
|
+
# Optional. The maximum number of `Release` objects to return. The service
|
1104
|
+
# may return fewer than this value. If unspecified, at most 50 `Release`
|
1105
|
+
# objects will be returned. The maximum value is 1000; values above 1000 will
|
1106
|
+
# be set to 1000.
|
1095
1107
|
# @param page_token [::String]
|
1096
1108
|
# Optional. A page token, received from a previous `ListReleases` call.
|
1097
1109
|
# Provide this to retrieve the subsequent page.
|
@@ -1099,10 +1111,11 @@ module Google
|
|
1099
1111
|
# When paginating, all other provided parameters match
|
1100
1112
|
# the call that provided the page token.
|
1101
1113
|
# @param filter [::String]
|
1102
|
-
# Optional. Filter releases to be returned. See https://google.aip.dev/160
|
1103
|
-
# details.
|
1114
|
+
# Optional. Filter releases to be returned. See https://google.aip.dev/160
|
1115
|
+
# for more details.
|
1104
1116
|
# @param order_by [::String]
|
1105
|
-
# Optional. Field to sort by. See https://google.aip.dev/132#ordering for
|
1117
|
+
# Optional. Field to sort by. See https://google.aip.dev/132#ordering for
|
1118
|
+
# more details.
|
1106
1119
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
1107
1120
|
# @yieldparam result [::Google::Cloud::Deploy::V1::ListReleasesResponse]
|
1108
1121
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -1249,8 +1262,8 @@ module Google
|
|
1249
1262
|
# The request ID must be a valid UUID with the exception that zero UUID is
|
1250
1263
|
# not supported (00000000-0000-0000-0000-000000000000).
|
1251
1264
|
# @param validate_only [::Boolean]
|
1252
|
-
# Optional. If set to true, the request is validated and the user is provided
|
1253
|
-
# an expected result, but no actual change is made.
|
1265
|
+
# Optional. If set to true, the request is validated and the user is provided
|
1266
|
+
# with an expected result, but no actual change is made.
|
1254
1267
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
1255
1268
|
# @yieldparam result [::Gapic::Operation]
|
1256
1269
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -1424,6 +1437,136 @@ module Google
|
|
1424
1437
|
raise ::Google::Cloud::Error.from_error(e)
|
1425
1438
|
end
|
1426
1439
|
|
1440
|
+
##
|
1441
|
+
# Advances a Rollout in a given project and location.
|
1442
|
+
#
|
1443
|
+
# @overload advance_rollout(request, options = nil)
|
1444
|
+
# Pass arguments to `advance_rollout` via a request object, either of type
|
1445
|
+
# {::Google::Cloud::Deploy::V1::AdvanceRolloutRequest} or an equivalent Hash.
|
1446
|
+
#
|
1447
|
+
# @param request [::Google::Cloud::Deploy::V1::AdvanceRolloutRequest, ::Hash]
|
1448
|
+
# A request object representing the call parameters. Required. To specify no
|
1449
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1450
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1451
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1452
|
+
#
|
1453
|
+
# @overload advance_rollout(name: nil, phase_id: nil)
|
1454
|
+
# Pass arguments to `advance_rollout` via keyword arguments. Note that at
|
1455
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1456
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1457
|
+
#
|
1458
|
+
# @param name [::String]
|
1459
|
+
# Required. Name of the Rollout. Format is
|
1460
|
+
# projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
|
1461
|
+
# releases/\\{release}/rollouts/\\{rollout}.
|
1462
|
+
# @param phase_id [::String]
|
1463
|
+
# Required. The phase ID to advance the `Rollout` to.
|
1464
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1465
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::AdvanceRolloutResponse]
|
1466
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1467
|
+
#
|
1468
|
+
# @return [::Google::Cloud::Deploy::V1::AdvanceRolloutResponse]
|
1469
|
+
#
|
1470
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1471
|
+
def advance_rollout request, options = nil
|
1472
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1473
|
+
|
1474
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::AdvanceRolloutRequest
|
1475
|
+
|
1476
|
+
# Converts hash and nil to an options object
|
1477
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1478
|
+
|
1479
|
+
# Customize the options with defaults
|
1480
|
+
call_metadata = @config.rpcs.advance_rollout.metadata.to_h
|
1481
|
+
|
1482
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1483
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1484
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1485
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
1486
|
+
transports_version_send: [:rest]
|
1487
|
+
|
1488
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1489
|
+
|
1490
|
+
options.apply_defaults timeout: @config.rpcs.advance_rollout.timeout,
|
1491
|
+
metadata: call_metadata,
|
1492
|
+
retry_policy: @config.rpcs.advance_rollout.retry_policy
|
1493
|
+
|
1494
|
+
options.apply_defaults timeout: @config.timeout,
|
1495
|
+
metadata: @config.metadata,
|
1496
|
+
retry_policy: @config.retry_policy
|
1497
|
+
|
1498
|
+
@cloud_deploy_stub.advance_rollout request, options do |result, operation|
|
1499
|
+
yield result, operation if block_given?
|
1500
|
+
return result
|
1501
|
+
end
|
1502
|
+
rescue ::Gapic::Rest::Error => e
|
1503
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1504
|
+
end
|
1505
|
+
|
1506
|
+
##
|
1507
|
+
# Cancels a Rollout in a given project and location.
|
1508
|
+
#
|
1509
|
+
# @overload cancel_rollout(request, options = nil)
|
1510
|
+
# Pass arguments to `cancel_rollout` via a request object, either of type
|
1511
|
+
# {::Google::Cloud::Deploy::V1::CancelRolloutRequest} or an equivalent Hash.
|
1512
|
+
#
|
1513
|
+
# @param request [::Google::Cloud::Deploy::V1::CancelRolloutRequest, ::Hash]
|
1514
|
+
# A request object representing the call parameters. Required. To specify no
|
1515
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1516
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1517
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1518
|
+
#
|
1519
|
+
# @overload cancel_rollout(name: nil)
|
1520
|
+
# Pass arguments to `cancel_rollout` via keyword arguments. Note that at
|
1521
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1522
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1523
|
+
#
|
1524
|
+
# @param name [::String]
|
1525
|
+
# Required. Name of the Rollout. Format is
|
1526
|
+
# projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
|
1527
|
+
# releases/\\{release}/rollouts/\\{rollout}.
|
1528
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1529
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::CancelRolloutResponse]
|
1530
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1531
|
+
#
|
1532
|
+
# @return [::Google::Cloud::Deploy::V1::CancelRolloutResponse]
|
1533
|
+
#
|
1534
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1535
|
+
def cancel_rollout request, options = nil
|
1536
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1537
|
+
|
1538
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CancelRolloutRequest
|
1539
|
+
|
1540
|
+
# Converts hash and nil to an options object
|
1541
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1542
|
+
|
1543
|
+
# Customize the options with defaults
|
1544
|
+
call_metadata = @config.rpcs.cancel_rollout.metadata.to_h
|
1545
|
+
|
1546
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1547
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1548
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1549
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
1550
|
+
transports_version_send: [:rest]
|
1551
|
+
|
1552
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1553
|
+
|
1554
|
+
options.apply_defaults timeout: @config.rpcs.cancel_rollout.timeout,
|
1555
|
+
metadata: call_metadata,
|
1556
|
+
retry_policy: @config.rpcs.cancel_rollout.retry_policy
|
1557
|
+
|
1558
|
+
options.apply_defaults timeout: @config.timeout,
|
1559
|
+
metadata: @config.metadata,
|
1560
|
+
retry_policy: @config.retry_policy
|
1561
|
+
|
1562
|
+
@cloud_deploy_stub.cancel_rollout request, options do |result, operation|
|
1563
|
+
yield result, operation if block_given?
|
1564
|
+
return result
|
1565
|
+
end
|
1566
|
+
rescue ::Gapic::Rest::Error => e
|
1567
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1568
|
+
end
|
1569
|
+
|
1427
1570
|
##
|
1428
1571
|
# Lists Rollouts in a given project and location.
|
1429
1572
|
#
|
@@ -1445,9 +1588,10 @@ module Google
|
|
1445
1588
|
# @param parent [::String]
|
1446
1589
|
# Required. The `Release` which owns this collection of `Rollout` objects.
|
1447
1590
|
# @param page_size [::Integer]
|
1448
|
-
# Optional. The maximum number of `Rollout` objects to return. The service
|
1449
|
-
# fewer than this value. If unspecified, at most 50 `Rollout`
|
1450
|
-
# returned. The maximum value is 1000; values above 1000 will
|
1591
|
+
# Optional. The maximum number of `Rollout` objects to return. The service
|
1592
|
+
# may return fewer than this value. If unspecified, at most 50 `Rollout`
|
1593
|
+
# objects will be returned. The maximum value is 1000; values above 1000 will
|
1594
|
+
# be set to 1000.
|
1451
1595
|
# @param page_token [::String]
|
1452
1596
|
# Optional. A page token, received from a previous `ListRollouts` call.
|
1453
1597
|
# Provide this to retrieve the subsequent page.
|
@@ -1455,10 +1599,11 @@ module Google
|
|
1455
1599
|
# When paginating, all other provided parameters match
|
1456
1600
|
# the call that provided the page token.
|
1457
1601
|
# @param filter [::String]
|
1458
|
-
# Optional. Filter rollouts to be returned. See https://google.aip.dev/160
|
1459
|
-
# details.
|
1602
|
+
# Optional. Filter rollouts to be returned. See https://google.aip.dev/160
|
1603
|
+
# for more details.
|
1460
1604
|
# @param order_by [::String]
|
1461
|
-
# Optional. Field to sort by. See https://google.aip.dev/132#ordering for
|
1605
|
+
# Optional. Field to sort by. See https://google.aip.dev/132#ordering for
|
1606
|
+
# more details.
|
1462
1607
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
1463
1608
|
# @yieldparam result [::Google::Cloud::Deploy::V1::ListRolloutsResponse]
|
1464
1609
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -1577,7 +1722,7 @@ module Google
|
|
1577
1722
|
# @param options [::Gapic::CallOptions, ::Hash]
|
1578
1723
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1579
1724
|
#
|
1580
|
-
# @overload create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil)
|
1725
|
+
# @overload create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil, starting_phase_id: nil)
|
1581
1726
|
# Pass arguments to `create_rollout` via keyword arguments. Note that at
|
1582
1727
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
1583
1728
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -1605,8 +1750,11 @@ module Google
|
|
1605
1750
|
# The request ID must be a valid UUID with the exception that zero UUID is
|
1606
1751
|
# not supported (00000000-0000-0000-0000-000000000000).
|
1607
1752
|
# @param validate_only [::Boolean]
|
1608
|
-
# Optional. If set to true, the request is validated and the user is provided
|
1609
|
-
# an expected result, but no actual change is made.
|
1753
|
+
# Optional. If set to true, the request is validated and the user is provided
|
1754
|
+
# with an expected result, but no actual change is made.
|
1755
|
+
# @param starting_phase_id [::String]
|
1756
|
+
# Optional. The starting phase ID for the `Rollout`. If empty the `Rollout`
|
1757
|
+
# will start at the first phase.
|
1610
1758
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
1611
1759
|
# @yieldparam result [::Gapic::Operation]
|
1612
1760
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -1650,6 +1798,74 @@ module Google
|
|
1650
1798
|
raise ::Google::Cloud::Error.from_error(e)
|
1651
1799
|
end
|
1652
1800
|
|
1801
|
+
##
|
1802
|
+
# Ignores the specified Job in a Rollout.
|
1803
|
+
#
|
1804
|
+
# @overload ignore_job(request, options = nil)
|
1805
|
+
# Pass arguments to `ignore_job` via a request object, either of type
|
1806
|
+
# {::Google::Cloud::Deploy::V1::IgnoreJobRequest} or an equivalent Hash.
|
1807
|
+
#
|
1808
|
+
# @param request [::Google::Cloud::Deploy::V1::IgnoreJobRequest, ::Hash]
|
1809
|
+
# A request object representing the call parameters. Required. To specify no
|
1810
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
1811
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
1812
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
1813
|
+
#
|
1814
|
+
# @overload ignore_job(rollout: nil, phase_id: nil, job_id: nil)
|
1815
|
+
# Pass arguments to `ignore_job` via keyword arguments. Note that at
|
1816
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
1817
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
1818
|
+
#
|
1819
|
+
# @param rollout [::String]
|
1820
|
+
# Required. Name of the Rollout. Format is
|
1821
|
+
# projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
|
1822
|
+
# releases/\\{release}/rollouts/\\{rollout}.
|
1823
|
+
# @param phase_id [::String]
|
1824
|
+
# Required. The phase ID the Job to ignore belongs to.
|
1825
|
+
# @param job_id [::String]
|
1826
|
+
# Required. The job ID for the Job to ignore.
|
1827
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
1828
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::IgnoreJobResponse]
|
1829
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
1830
|
+
#
|
1831
|
+
# @return [::Google::Cloud::Deploy::V1::IgnoreJobResponse]
|
1832
|
+
#
|
1833
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1834
|
+
def ignore_job request, options = nil
|
1835
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
1836
|
+
|
1837
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::IgnoreJobRequest
|
1838
|
+
|
1839
|
+
# Converts hash and nil to an options object
|
1840
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
1841
|
+
|
1842
|
+
# Customize the options with defaults
|
1843
|
+
call_metadata = @config.rpcs.ignore_job.metadata.to_h
|
1844
|
+
|
1845
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
1846
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
1847
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
1848
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
1849
|
+
transports_version_send: [:rest]
|
1850
|
+
|
1851
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
1852
|
+
|
1853
|
+
options.apply_defaults timeout: @config.rpcs.ignore_job.timeout,
|
1854
|
+
metadata: call_metadata,
|
1855
|
+
retry_policy: @config.rpcs.ignore_job.retry_policy
|
1856
|
+
|
1857
|
+
options.apply_defaults timeout: @config.timeout,
|
1858
|
+
metadata: @config.metadata,
|
1859
|
+
retry_policy: @config.retry_policy
|
1860
|
+
|
1861
|
+
@cloud_deploy_stub.ignore_job request, options do |result, operation|
|
1862
|
+
yield result, operation if block_given?
|
1863
|
+
return result
|
1864
|
+
end
|
1865
|
+
rescue ::Gapic::Rest::Error => e
|
1866
|
+
raise ::Google::Cloud::Error.from_error(e)
|
1867
|
+
end
|
1868
|
+
|
1653
1869
|
##
|
1654
1870
|
# Retries the specified Job in a Rollout.
|
1655
1871
|
#
|
@@ -1739,20 +1955,22 @@ module Google
|
|
1739
1955
|
# @param parent [::String]
|
1740
1956
|
# Required. The `Rollout` which owns this collection of `JobRun` objects.
|
1741
1957
|
# @param page_size [::Integer]
|
1742
|
-
# Optional. The maximum number of `JobRun` objects to return. The service may
|
1743
|
-
# fewer than this value. If unspecified, at most 50 `JobRun` objects
|
1744
|
-
# returned. The maximum value is 1000; values above 1000 will be set
|
1958
|
+
# Optional. The maximum number of `JobRun` objects to return. The service may
|
1959
|
+
# return fewer than this value. If unspecified, at most 50 `JobRun` objects
|
1960
|
+
# will be returned. The maximum value is 1000; values above 1000 will be set
|
1961
|
+
# to 1000.
|
1745
1962
|
# @param page_token [::String]
|
1746
|
-
# Optional. A page token, received from a previous `ListJobRuns` call.
|
1747
|
-
# to retrieve the subsequent page.
|
1963
|
+
# Optional. A page token, received from a previous `ListJobRuns` call.
|
1964
|
+
# Provide this to retrieve the subsequent page.
|
1748
1965
|
#
|
1749
1966
|
# When paginating, all other provided parameters match the call that provided
|
1750
1967
|
# the page token.
|
1751
1968
|
# @param filter [::String]
|
1752
|
-
# Optional. Filter results to be returned. See https://google.aip.dev/160 for
|
1753
|
-
# details.
|
1969
|
+
# Optional. Filter results to be returned. See https://google.aip.dev/160 for
|
1970
|
+
# more details.
|
1754
1971
|
# @param order_by [::String]
|
1755
|
-
# Optional. Field to sort by. See https://google.aip.dev/132#ordering for
|
1972
|
+
# Optional. Field to sort by. See https://google.aip.dev/132#ordering for
|
1973
|
+
# more details.
|
1756
1974
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
1757
1975
|
# @yieldparam result [::Google::Cloud::Deploy::V1::ListJobRunsResponse]
|
1758
1976
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -1858,6 +2076,70 @@ module Google
|
|
1858
2076
|
raise ::Google::Cloud::Error.from_error(e)
|
1859
2077
|
end
|
1860
2078
|
|
2079
|
+
##
|
2080
|
+
# Terminates a Job Run in a given project and location.
|
2081
|
+
#
|
2082
|
+
# @overload terminate_job_run(request, options = nil)
|
2083
|
+
# Pass arguments to `terminate_job_run` via a request object, either of type
|
2084
|
+
# {::Google::Cloud::Deploy::V1::TerminateJobRunRequest} or an equivalent Hash.
|
2085
|
+
#
|
2086
|
+
# @param request [::Google::Cloud::Deploy::V1::TerminateJobRunRequest, ::Hash]
|
2087
|
+
# A request object representing the call parameters. Required. To specify no
|
2088
|
+
# parameters, or to keep all the default parameter values, pass an empty Hash.
|
2089
|
+
# @param options [::Gapic::CallOptions, ::Hash]
|
2090
|
+
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
2091
|
+
#
|
2092
|
+
# @overload terminate_job_run(name: nil)
|
2093
|
+
# Pass arguments to `terminate_job_run` via keyword arguments. Note that at
|
2094
|
+
# least one keyword argument is required. To specify no parameters, or to keep all
|
2095
|
+
# the default parameter values, pass an empty Hash as a request object (see above).
|
2096
|
+
#
|
2097
|
+
# @param name [::String]
|
2098
|
+
# Required. Name of the `JobRun`. Format must be
|
2099
|
+
# projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
|
2100
|
+
# releases/\\{release}/rollouts/\\{rollout}/jobRuns/\\{jobRun}.
|
2101
|
+
# @yield [result, operation] Access the result along with the TransportOperation object
|
2102
|
+
# @yieldparam result [::Google::Cloud::Deploy::V1::TerminateJobRunResponse]
|
2103
|
+
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
2104
|
+
#
|
2105
|
+
# @return [::Google::Cloud::Deploy::V1::TerminateJobRunResponse]
|
2106
|
+
#
|
2107
|
+
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
2108
|
+
def terminate_job_run request, options = nil
|
2109
|
+
raise ::ArgumentError, "request must be provided" if request.nil?
|
2110
|
+
|
2111
|
+
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::TerminateJobRunRequest
|
2112
|
+
|
2113
|
+
# Converts hash and nil to an options object
|
2114
|
+
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
|
2115
|
+
|
2116
|
+
# Customize the options with defaults
|
2117
|
+
call_metadata = @config.rpcs.terminate_job_run.metadata.to_h
|
2118
|
+
|
2119
|
+
# Set x-goog-api-client and x-goog-user-project headers
|
2120
|
+
call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
|
2121
|
+
lib_name: @config.lib_name, lib_version: @config.lib_version,
|
2122
|
+
gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
|
2123
|
+
transports_version_send: [:rest]
|
2124
|
+
|
2125
|
+
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
2126
|
+
|
2127
|
+
options.apply_defaults timeout: @config.rpcs.terminate_job_run.timeout,
|
2128
|
+
metadata: call_metadata,
|
2129
|
+
retry_policy: @config.rpcs.terminate_job_run.retry_policy
|
2130
|
+
|
2131
|
+
options.apply_defaults timeout: @config.timeout,
|
2132
|
+
metadata: @config.metadata,
|
2133
|
+
retry_policy: @config.retry_policy
|
2134
|
+
|
2135
|
+
@cloud_deploy_stub.terminate_job_run request, options do |result, operation|
|
2136
|
+
yield result, operation if block_given?
|
2137
|
+
return result
|
2138
|
+
end
|
2139
|
+
rescue ::Gapic::Rest::Error => e
|
2140
|
+
raise ::Google::Cloud::Error.from_error(e)
|
2141
|
+
end
|
2142
|
+
|
1861
2143
|
##
|
1862
2144
|
# Gets the configuration for a location.
|
1863
2145
|
#
|
@@ -1958,9 +2240,9 @@ module Google
|
|
1958
2240
|
# * (`String`) The path to a service account key file in JSON format
|
1959
2241
|
# * (`Hash`) A service account key as a Hash
|
1960
2242
|
# * (`Google::Auth::Credentials`) A googleauth credentials object
|
1961
|
-
# (see the [googleauth docs](https://
|
2243
|
+
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
|
1962
2244
|
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
|
1963
|
-
# (see the [signet docs](https://
|
2245
|
+
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
|
1964
2246
|
# * (`nil`) indicating no credentials
|
1965
2247
|
# @return [::Object]
|
1966
2248
|
# @!attribute [rw] scope
|
@@ -2126,6 +2408,16 @@ module Google
|
|
2126
2408
|
#
|
2127
2409
|
attr_reader :approve_rollout
|
2128
2410
|
##
|
2411
|
+
# RPC-specific configuration for `advance_rollout`
|
2412
|
+
# @return [::Gapic::Config::Method]
|
2413
|
+
#
|
2414
|
+
attr_reader :advance_rollout
|
2415
|
+
##
|
2416
|
+
# RPC-specific configuration for `cancel_rollout`
|
2417
|
+
# @return [::Gapic::Config::Method]
|
2418
|
+
#
|
2419
|
+
attr_reader :cancel_rollout
|
2420
|
+
##
|
2129
2421
|
# RPC-specific configuration for `list_rollouts`
|
2130
2422
|
# @return [::Gapic::Config::Method]
|
2131
2423
|
#
|
@@ -2141,6 +2433,11 @@ module Google
|
|
2141
2433
|
#
|
2142
2434
|
attr_reader :create_rollout
|
2143
2435
|
##
|
2436
|
+
# RPC-specific configuration for `ignore_job`
|
2437
|
+
# @return [::Gapic::Config::Method]
|
2438
|
+
#
|
2439
|
+
attr_reader :ignore_job
|
2440
|
+
##
|
2144
2441
|
# RPC-specific configuration for `retry_job`
|
2145
2442
|
# @return [::Gapic::Config::Method]
|
2146
2443
|
#
|
@@ -2156,6 +2453,11 @@ module Google
|
|
2156
2453
|
#
|
2157
2454
|
attr_reader :get_job_run
|
2158
2455
|
##
|
2456
|
+
# RPC-specific configuration for `terminate_job_run`
|
2457
|
+
# @return [::Gapic::Config::Method]
|
2458
|
+
#
|
2459
|
+
attr_reader :terminate_job_run
|
2460
|
+
##
|
2159
2461
|
# RPC-specific configuration for `get_config`
|
2160
2462
|
# @return [::Gapic::Config::Method]
|
2161
2463
|
#
|
@@ -2193,18 +2495,26 @@ module Google
|
|
2193
2495
|
@abandon_release = ::Gapic::Config::Method.new abandon_release_config
|
2194
2496
|
approve_rollout_config = parent_rpcs.approve_rollout if parent_rpcs.respond_to? :approve_rollout
|
2195
2497
|
@approve_rollout = ::Gapic::Config::Method.new approve_rollout_config
|
2498
|
+
advance_rollout_config = parent_rpcs.advance_rollout if parent_rpcs.respond_to? :advance_rollout
|
2499
|
+
@advance_rollout = ::Gapic::Config::Method.new advance_rollout_config
|
2500
|
+
cancel_rollout_config = parent_rpcs.cancel_rollout if parent_rpcs.respond_to? :cancel_rollout
|
2501
|
+
@cancel_rollout = ::Gapic::Config::Method.new cancel_rollout_config
|
2196
2502
|
list_rollouts_config = parent_rpcs.list_rollouts if parent_rpcs.respond_to? :list_rollouts
|
2197
2503
|
@list_rollouts = ::Gapic::Config::Method.new list_rollouts_config
|
2198
2504
|
get_rollout_config = parent_rpcs.get_rollout if parent_rpcs.respond_to? :get_rollout
|
2199
2505
|
@get_rollout = ::Gapic::Config::Method.new get_rollout_config
|
2200
2506
|
create_rollout_config = parent_rpcs.create_rollout if parent_rpcs.respond_to? :create_rollout
|
2201
2507
|
@create_rollout = ::Gapic::Config::Method.new create_rollout_config
|
2508
|
+
ignore_job_config = parent_rpcs.ignore_job if parent_rpcs.respond_to? :ignore_job
|
2509
|
+
@ignore_job = ::Gapic::Config::Method.new ignore_job_config
|
2202
2510
|
retry_job_config = parent_rpcs.retry_job if parent_rpcs.respond_to? :retry_job
|
2203
2511
|
@retry_job = ::Gapic::Config::Method.new retry_job_config
|
2204
2512
|
list_job_runs_config = parent_rpcs.list_job_runs if parent_rpcs.respond_to? :list_job_runs
|
2205
2513
|
@list_job_runs = ::Gapic::Config::Method.new list_job_runs_config
|
2206
2514
|
get_job_run_config = parent_rpcs.get_job_run if parent_rpcs.respond_to? :get_job_run
|
2207
2515
|
@get_job_run = ::Gapic::Config::Method.new get_job_run_config
|
2516
|
+
terminate_job_run_config = parent_rpcs.terminate_job_run if parent_rpcs.respond_to? :terminate_job_run
|
2517
|
+
@terminate_job_run = ::Gapic::Config::Method.new terminate_job_run_config
|
2208
2518
|
get_config_config = parent_rpcs.get_config if parent_rpcs.respond_to? :get_config
|
2209
2519
|
@get_config = ::Gapic::Config::Method.new get_config_config
|
2210
2520
|
|