google-cloud-deploy-v1 0.3.0 → 0.4.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.
@@ -38,9 +38,7 @@ module Google
38
38
  # @!attribute [rw] annotations
39
39
  # @return [::Google::Protobuf::Map{::String => ::String}]
40
40
  # User annotations. These attributes can only be set and used by the
41
- # user, and not by Google Cloud Deploy. See
42
- # https://google.aip.dev/128#annotations for more details such as format and
43
- # size limitations.
41
+ # user, and not by Google Cloud Deploy.
44
42
  # @!attribute [rw] labels
45
43
  # @return [::Google::Protobuf::Map{::String => ::String}]
46
44
  # Labels are attributes that can be set and used by both the
@@ -73,6 +71,10 @@ module Google
73
71
  # This checksum is computed by the server based on the value of other
74
72
  # fields, and may be sent on update and delete requests to ensure the
75
73
  # client has an up-to-date value before proceeding.
74
+ # @!attribute [rw] suspended
75
+ # @return [::Boolean]
76
+ # When suspended, no new releases or rollouts can be created,
77
+ # but in-progress ones will complete.
76
78
  class DeliveryPipeline
77
79
  include ::Google::Protobuf::MessageExts
78
80
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -119,11 +121,33 @@ module Google
119
121
  # @return [::Array<::String>]
120
122
  # Skaffold profiles to use when rendering the manifest for this stage's
121
123
  # `Target`.
124
+ # @!attribute [rw] strategy
125
+ # @return [::Google::Cloud::Deploy::V1::Strategy]
126
+ # Optional. The strategy to use for a `Rollout` to this stage.
122
127
  class Stage
123
128
  include ::Google::Protobuf::MessageExts
124
129
  extend ::Google::Protobuf::MessageExts::ClassMethods
125
130
  end
126
131
 
132
+ # Strategy contains deployment strategy information.
133
+ # @!attribute [rw] standard
134
+ # @return [::Google::Cloud::Deploy::V1::Standard]
135
+ # Standard deployment strategy executes a single deploy and allows
136
+ # verifying the deployment.
137
+ class Strategy
138
+ include ::Google::Protobuf::MessageExts
139
+ extend ::Google::Protobuf::MessageExts::ClassMethods
140
+ end
141
+
142
+ # Standard represents the standard deployment strategy.
143
+ # @!attribute [rw] verify
144
+ # @return [::Boolean]
145
+ # Whether to verify a deployment.
146
+ class Standard
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
127
151
  # PipelineReadyCondition contains information around the status of the
128
152
  # Pipeline.
129
153
  # @!attribute [rw] status
@@ -394,6 +418,9 @@ module Google
394
418
  # @!attribute [rw] anthos_cluster
395
419
  # @return [::Google::Cloud::Deploy::V1::AnthosCluster]
396
420
  # Information specifying an Anthos Cluster.
421
+ # @!attribute [rw] run
422
+ # @return [::Google::Cloud::Deploy::V1::CloudRunLocation]
423
+ # Information specifying a Cloud Run deployment target.
397
424
  # @!attribute [rw] etag
398
425
  # @return [::String]
399
426
  # Optional. This checksum is computed by the server based on the value of other
@@ -458,6 +485,11 @@ module Google
458
485
  # either be a bucket ("gs://my-bucket") or a path within a bucket
459
486
  # ("gs://my-bucket/my-dir").
460
487
  # If unspecified, a default bucket located in the same region will be used.
488
+ # @!attribute [rw] execution_timeout
489
+ # @return [::Google::Protobuf::Duration]
490
+ # Optional. Execution timeout for a Cloud Build Execution. This must be between 10m and
491
+ # 24h in seconds format.
492
+ # If unspecified, a default timeout of 1h is used.
461
493
  class ExecutionConfig
462
494
  include ::Google::Protobuf::MessageExts
463
495
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -472,6 +504,9 @@ module Google
472
504
 
473
505
  # Use for deploying and deployment hooks.
474
506
  DEPLOY = 2
507
+
508
+ # Use for deployment verification.
509
+ VERIFY = 3
475
510
  end
476
511
  end
477
512
 
@@ -544,6 +579,16 @@ module Google
544
579
  extend ::Google::Protobuf::MessageExts::ClassMethods
545
580
  end
546
581
 
582
+ # Information specifying where to deploy a Cloud Run Service.
583
+ # @!attribute [rw] location
584
+ # @return [::String]
585
+ # Required. The location for the Cloud Run Service. Format must be
586
+ # `projects/{project}/locations/{location}`.
587
+ class CloudRunLocation
588
+ include ::Google::Protobuf::MessageExts
589
+ extend ::Google::Protobuf::MessageExts::ClassMethods
590
+ end
591
+
547
592
  # The request object for `ListTargets`.
548
593
  # @!attribute [rw] parent
549
594
  # @return [::String]
@@ -747,6 +792,9 @@ module Google
747
792
  # * Each resource is limited to a maximum of 64 labels.
748
793
  #
749
794
  # Both keys and values are additionally constrained to be <= 128 bytes.
795
+ # @!attribute [r] abandoned
796
+ # @return [::Boolean]
797
+ # Output only. Indicates whether this is an abandoned release.
750
798
  # @!attribute [r] create_time
751
799
  # @return [::Google::Protobuf::Timestamp]
752
800
  # Output only. Time at which the `Release` was created.
@@ -810,6 +858,9 @@ module Google
810
858
  # @return [::Google::Cloud::Deploy::V1::Release::TargetRender::FailureCause]
811
859
  # Output only. Reason this render failed. This will always be unspecified while the
812
860
  # render in progress.
861
+ # @!attribute [r] failure_message
862
+ # @return [::String]
863
+ # Output only. Additional information about the render failure, if available.
813
864
  class TargetRender
814
865
  include ::Google::Protobuf::MessageExts
815
866
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -835,7 +886,7 @@ module Google
835
886
  FAILURE_CAUSE_UNSPECIFIED = 0
836
887
 
837
888
  # Cloud Build is not available, either because it is not enabled or
838
- # because Cloud Deploy has insufficient permissions. See [required
889
+ # because Google Cloud Deploy has insufficient permissions. See [required
839
890
  # permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
840
891
  CLOUD_BUILD_UNAVAILABLE = 1
841
892
 
@@ -1079,7 +1130,7 @@ module Google
1079
1130
  # Output only. Current state of the `Rollout`.
1080
1131
  # @!attribute [r] failure_reason
1081
1132
  # @return [::String]
1082
- # Output only. Reason the build failed. Empty if the build succeeded.
1133
+ # Output only. Additional information about the rollout failure, if available.
1083
1134
  # @!attribute [r] deploying_build
1084
1135
  # @return [::String]
1085
1136
  # Output only. The resource name of the Cloud Build `Build` object that is used to deploy
@@ -1092,8 +1143,14 @@ module Google
1092
1143
  # client has an up-to-date value before proceeding.
1093
1144
  # @!attribute [r] deploy_failure_cause
1094
1145
  # @return [::Google::Cloud::Deploy::V1::Rollout::FailureCause]
1095
- # Output only. The reason this deploy failed. This will always be unspecified while the
1096
- # deploy in progress.
1146
+ # Output only. The reason this rollout failed. This will always be unspecified while the
1147
+ # rollout is in progress.
1148
+ # @!attribute [r] phases
1149
+ # @return [::Array<::Google::Cloud::Deploy::V1::Phase>]
1150
+ # Output only. The phases that represent the workflows of this `Rollout`.
1151
+ # @!attribute [r] metadata
1152
+ # @return [::Google::Cloud::Deploy::V1::Metadata]
1153
+ # Output only. Metadata contains information about the rollout.
1097
1154
  class Rollout
1098
1155
  include ::Google::Protobuf::MessageExts
1099
1156
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1162,7 +1219,7 @@ module Google
1162
1219
  PENDING_RELEASE = 7
1163
1220
  end
1164
1221
 
1165
- # Well-known deployment failures.
1222
+ # Well-known rollout failures.
1166
1223
  module FailureCause
1167
1224
  # No reason for failure is specified.
1168
1225
  FAILURE_CAUSE_UNSPECIFIED = 0
@@ -1181,9 +1238,157 @@ module Google
1181
1238
 
1182
1239
  # Release is in a failed state.
1183
1240
  RELEASE_FAILED = 4
1241
+
1242
+ # Release is abandoned.
1243
+ RELEASE_ABANDONED = 5
1244
+
1245
+ # No skaffold verify configuration was found.
1246
+ VERIFICATION_CONFIG_NOT_FOUND = 6
1247
+ end
1248
+ end
1249
+
1250
+ # Metadata includes information associated with a `Rollout`.
1251
+ # @!attribute [r] cloud_run
1252
+ # @return [::Google::Cloud::Deploy::V1::CloudRunMetadata]
1253
+ # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
1254
+ class Metadata
1255
+ include ::Google::Protobuf::MessageExts
1256
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1257
+ end
1258
+
1259
+ # DeployJobRunMetadata surfaces information associated with a `DeployJobRun` to
1260
+ # the user.
1261
+ # @!attribute [r] cloud_run
1262
+ # @return [::Google::Cloud::Deploy::V1::CloudRunMetadata]
1263
+ # Output only. The name of the Cloud Run Service that is associated with a `DeployJobRun`.
1264
+ class DeployJobRunMetadata
1265
+ include ::Google::Protobuf::MessageExts
1266
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1267
+ end
1268
+
1269
+ # CloudRunMetadata contains information from a Cloud Run deployment.
1270
+ # @!attribute [r] service
1271
+ # @return [::String]
1272
+ # Output only. The name of the Cloud Run Service that is associated with a `Rollout`.
1273
+ # Format is projects/\\{project}/locations/\\{location}/services/\\{service}.
1274
+ # @!attribute [r] service_urls
1275
+ # @return [::Array<::String>]
1276
+ # Output only. The Cloud Run Service urls that are associated with a `Rollout`.
1277
+ # @!attribute [r] revision
1278
+ # @return [::String]
1279
+ # Output only. The Cloud Run Revision id associated with a `Rollout`.
1280
+ class CloudRunMetadata
1281
+ include ::Google::Protobuf::MessageExts
1282
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1283
+ end
1284
+
1285
+ # Phase represents a collection of jobs that are logically grouped together
1286
+ # for a `Rollout`.
1287
+ # @!attribute [r] id
1288
+ # @return [::String]
1289
+ # Output only. The ID of the Phase.
1290
+ # @!attribute [r] state
1291
+ # @return [::Google::Cloud::Deploy::V1::Phase::State]
1292
+ # Output only. Current state of the Phase.
1293
+ # @!attribute [r] deployment_jobs
1294
+ # @return [::Google::Cloud::Deploy::V1::DeploymentJobs]
1295
+ # Output only. Deployment job composition.
1296
+ class Phase
1297
+ include ::Google::Protobuf::MessageExts
1298
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1299
+
1300
+ # Valid states of a Phase.
1301
+ module State
1302
+ # The Phase has an unspecified state.
1303
+ STATE_UNSPECIFIED = 0
1304
+
1305
+ # The Phase is waiting for an earlier Phase(s) to complete.
1306
+ PENDING = 1
1307
+
1308
+ # The Phase is in progress.
1309
+ IN_PROGRESS = 2
1310
+
1311
+ # The Phase has succeeded.
1312
+ SUCCEEDED = 3
1313
+
1314
+ # The Phase has failed.
1315
+ FAILED = 4
1316
+
1317
+ # The Phase was aborted.
1318
+ ABORTED = 5
1184
1319
  end
1185
1320
  end
1186
1321
 
1322
+ # Deployment job composition.
1323
+ # @!attribute [r] deploy_job
1324
+ # @return [::Google::Cloud::Deploy::V1::Job]
1325
+ # Output only. The deploy Job. This is the first job run in the phase.
1326
+ # @!attribute [r] verify_job
1327
+ # @return [::Google::Cloud::Deploy::V1::Job]
1328
+ # Output only. The verify Job. Runs after a deploy if the deploy succeeds.
1329
+ class DeploymentJobs
1330
+ include ::Google::Protobuf::MessageExts
1331
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1332
+ end
1333
+
1334
+ # Job represents an operation for a `Rollout`.
1335
+ # @!attribute [r] id
1336
+ # @return [::String]
1337
+ # Output only. The ID of the Job.
1338
+ # @!attribute [r] state
1339
+ # @return [::Google::Cloud::Deploy::V1::Job::State]
1340
+ # Output only. The current state of the Job.
1341
+ # @!attribute [r] job_run
1342
+ # @return [::String]
1343
+ # Output only. The name of the `JobRun` responsible for the most recent invocation of this
1344
+ # Job.
1345
+ # @!attribute [r] deploy_job
1346
+ # @return [::Google::Cloud::Deploy::V1::DeployJob]
1347
+ # Output only. A deploy Job.
1348
+ # @!attribute [r] verify_job
1349
+ # @return [::Google::Cloud::Deploy::V1::VerifyJob]
1350
+ # Output only. A verify Job.
1351
+ class Job
1352
+ include ::Google::Protobuf::MessageExts
1353
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1354
+
1355
+ # Valid states of a Job.
1356
+ module State
1357
+ # The Job has an unspecified state.
1358
+ STATE_UNSPECIFIED = 0
1359
+
1360
+ # The Job is waiting for an earlier Phase(s) or Job(s) to complete.
1361
+ PENDING = 1
1362
+
1363
+ # The Job is disabled.
1364
+ DISABLED = 2
1365
+
1366
+ # The Job is in progress.
1367
+ IN_PROGRESS = 3
1368
+
1369
+ # The Job succeeded.
1370
+ SUCCEEDED = 4
1371
+
1372
+ # The Job failed.
1373
+ FAILED = 5
1374
+
1375
+ # The Job was aborted.
1376
+ ABORTED = 6
1377
+ end
1378
+ end
1379
+
1380
+ # A deploy Job.
1381
+ class DeployJob
1382
+ include ::Google::Protobuf::MessageExts
1383
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1384
+ end
1385
+
1386
+ # A verify Job.
1387
+ class VerifyJob
1388
+ include ::Google::Protobuf::MessageExts
1389
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1390
+ end
1391
+
1187
1392
  # ListRolloutsRequest is the request object used by `ListRollouts`.
1188
1393
  # @!attribute [rw] parent
1189
1394
  # @return [::String]
@@ -1324,6 +1529,243 @@ module Google
1324
1529
  extend ::Google::Protobuf::MessageExts::ClassMethods
1325
1530
  end
1326
1531
 
1532
+ # RetryJobRequest is the request object used by `RetryJob`.
1533
+ # @!attribute [rw] rollout
1534
+ # @return [::String]
1535
+ # Required. Name of the Rollout. Format is
1536
+ # projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
1537
+ # releases/\\{release}/rollouts/\\{rollout}.
1538
+ # @!attribute [rw] phase_id
1539
+ # @return [::String]
1540
+ # Required. The phase ID the Job to retry belongs to.
1541
+ # @!attribute [rw] job_id
1542
+ # @return [::String]
1543
+ # Required. The job ID for the Job to retry.
1544
+ class RetryJobRequest
1545
+ include ::Google::Protobuf::MessageExts
1546
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1547
+ end
1548
+
1549
+ # The response object from 'RetryJob'.
1550
+ class RetryJobResponse
1551
+ include ::Google::Protobuf::MessageExts
1552
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1553
+ end
1554
+
1555
+ # The request object used by `AbandonRelease`.
1556
+ # @!attribute [rw] name
1557
+ # @return [::String]
1558
+ # Required. Name of the Release. Format is
1559
+ # projects/\\{project}/locations/\\{location}/deliveryPipelines/\\{deliveryPipeline}/
1560
+ # releases/\\{release}.
1561
+ class AbandonReleaseRequest
1562
+ include ::Google::Protobuf::MessageExts
1563
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1564
+ end
1565
+
1566
+ # The response object for `AbandonRelease`.
1567
+ class AbandonReleaseResponse
1568
+ include ::Google::Protobuf::MessageExts
1569
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1570
+ end
1571
+
1572
+ # A `JobRun` resource in the Google Cloud Deploy API.
1573
+ #
1574
+ # A `JobRun` contains information of a single `Rollout` job evaluation.
1575
+ # @!attribute [rw] name
1576
+ # @return [::String]
1577
+ # Optional. Name of the `JobRun`. Format is projects/\\{project}/locations/\\{location}/
1578
+ # deliveryPipelines/\\{deliveryPipeline}/releases/\\{releases}/rollouts/
1579
+ # \\{rollouts}/jobRuns/\\{uuid}.
1580
+ # @!attribute [r] uid
1581
+ # @return [::String]
1582
+ # Output only. Unique identifier of the `JobRun`.
1583
+ # @!attribute [r] phase_id
1584
+ # @return [::String]
1585
+ # Output only. ID of the `Rollout` phase this `JobRun` belongs in.
1586
+ # @!attribute [r] job_id
1587
+ # @return [::String]
1588
+ # Output only. ID of the `Rollout` job this `JobRun` corresponds to.
1589
+ # @!attribute [r] create_time
1590
+ # @return [::Google::Protobuf::Timestamp]
1591
+ # Output only. Time at which the `JobRun` was created.
1592
+ # @!attribute [r] start_time
1593
+ # @return [::Google::Protobuf::Timestamp]
1594
+ # Output only. Time at which the `JobRun` was started.
1595
+ # @!attribute [r] end_time
1596
+ # @return [::Google::Protobuf::Timestamp]
1597
+ # Output only. Time at which the `JobRun` ended.
1598
+ # @!attribute [r] state
1599
+ # @return [::Google::Cloud::Deploy::V1::JobRun::State]
1600
+ # Output only. The current state of the `JobRun`.
1601
+ # @!attribute [r] deploy_job_run
1602
+ # @return [::Google::Cloud::Deploy::V1::DeployJobRun]
1603
+ # Output only. Information specific to a deploy `JobRun`.
1604
+ # @!attribute [r] verify_job_run
1605
+ # @return [::Google::Cloud::Deploy::V1::VerifyJobRun]
1606
+ # Output only. Information specific to a verify `JobRun`.
1607
+ # @!attribute [r] etag
1608
+ # @return [::String]
1609
+ # Output only. This checksum is computed by the server based on the value of other
1610
+ # fields, and may be sent on update and delete requests to ensure the
1611
+ # client has an up-to-date value before proceeding.
1612
+ class JobRun
1613
+ include ::Google::Protobuf::MessageExts
1614
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1615
+
1616
+ # Valid states of a `JobRun`.
1617
+ module State
1618
+ # The `JobRun` has an unspecified state.
1619
+ STATE_UNSPECIFIED = 0
1620
+
1621
+ # The `JobRun` is in progress.
1622
+ IN_PROGRESS = 1
1623
+
1624
+ # The `JobRun` has succeeded.
1625
+ SUCCEEDED = 2
1626
+
1627
+ # The `JobRun` has failed.
1628
+ FAILED = 3
1629
+ end
1630
+ end
1631
+
1632
+ # DeployJobRun contains information specific to a deploy `JobRun`.
1633
+ # @!attribute [r] build
1634
+ # @return [::String]
1635
+ # Output only. The resource name of the Cloud Build `Build` object that is used to deploy.
1636
+ # Format is projects/\\{project}/locations/\\{location}/builds/\\{build}.
1637
+ # @!attribute [r] failure_cause
1638
+ # @return [::Google::Cloud::Deploy::V1::DeployJobRun::FailureCause]
1639
+ # Output only. The reason the deploy failed. This will always be unspecified while the
1640
+ # deploy is in progress or if it succeeded.
1641
+ # @!attribute [r] failure_message
1642
+ # @return [::String]
1643
+ # Output only. Additional information about the deploy failure, if available.
1644
+ # @!attribute [r] metadata
1645
+ # @return [::Google::Cloud::Deploy::V1::DeployJobRunMetadata]
1646
+ # Output only. Metadata containing information about the deploy job run.
1647
+ class DeployJobRun
1648
+ include ::Google::Protobuf::MessageExts
1649
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1650
+
1651
+ # Well-known deploy failures.
1652
+ module FailureCause
1653
+ # No reason for failure is specified.
1654
+ FAILURE_CAUSE_UNSPECIFIED = 0
1655
+
1656
+ # Cloud Build is not available, either because it is not enabled or because
1657
+ # Google Cloud Deploy has insufficient permissions. See [Required
1658
+ # permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
1659
+ CLOUD_BUILD_UNAVAILABLE = 1
1660
+
1661
+ # The deploy operation did not complete successfully; check Cloud Build
1662
+ # logs.
1663
+ EXECUTION_FAILED = 2
1664
+
1665
+ # The deploy build did not complete within the alloted time.
1666
+ DEADLINE_EXCEEDED = 3
1667
+ end
1668
+ end
1669
+
1670
+ # VerifyJobRun contains information specific to a verify `JobRun`.
1671
+ # @!attribute [r] build
1672
+ # @return [::String]
1673
+ # Output only. The resource name of the Cloud Build `Build` object that is used to verify.
1674
+ # Format is projects/\\{project}/locations/\\{location}/builds/\\{build}.
1675
+ # @!attribute [r] artifact_uri
1676
+ # @return [::String]
1677
+ # Output only. URI of a directory containing the verify artifacts. This contains the
1678
+ # Skaffold event log.
1679
+ # @!attribute [r] event_log_path
1680
+ # @return [::String]
1681
+ # Output only. File path of the Skaffold event log relative to the artifact URI.
1682
+ # @!attribute [r] failure_cause
1683
+ # @return [::Google::Cloud::Deploy::V1::VerifyJobRun::FailureCause]
1684
+ # Output only. The reason the verify failed. This will always be unspecified while the
1685
+ # verify is in progress or if it succeeded.
1686
+ # @!attribute [r] failure_message
1687
+ # @return [::String]
1688
+ # Output only. Additional information about the verify failure, if available.
1689
+ class VerifyJobRun
1690
+ include ::Google::Protobuf::MessageExts
1691
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1692
+
1693
+ # Well-known verify failures.
1694
+ module FailureCause
1695
+ # No reason for failure is specified.
1696
+ FAILURE_CAUSE_UNSPECIFIED = 0
1697
+
1698
+ # Cloud Build is not available, either because it is not enabled or because
1699
+ # Google Cloud Deploy has insufficient permissions. See [required
1700
+ # permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
1701
+ CLOUD_BUILD_UNAVAILABLE = 1
1702
+
1703
+ # The verify operation did not complete successfully; check Cloud Build
1704
+ # logs.
1705
+ EXECUTION_FAILED = 2
1706
+
1707
+ # The verify build did not complete within the alloted time.
1708
+ DEADLINE_EXCEEDED = 3
1709
+
1710
+ # No Skaffold verify configuration was found.
1711
+ VERIFICATION_CONFIG_NOT_FOUND = 4
1712
+ end
1713
+ end
1714
+
1715
+ # ListJobRunsRequest is the request object used by `ListJobRuns`.
1716
+ # @!attribute [rw] parent
1717
+ # @return [::String]
1718
+ # Required. The `Rollout` which owns this collection of `JobRun` objects.
1719
+ # @!attribute [rw] page_size
1720
+ # @return [::Integer]
1721
+ # Optional. The maximum number of `JobRun` objects to return. The service may return
1722
+ # fewer than this value. If unspecified, at most 50 `JobRun` objects will be
1723
+ # returned. The maximum value is 1000; values above 1000 will be set to 1000.
1724
+ # @!attribute [rw] page_token
1725
+ # @return [::String]
1726
+ # Optional. A page token, received from a previous `ListJobRuns` call. Provide this
1727
+ # to retrieve the subsequent page.
1728
+ #
1729
+ # When paginating, all other provided parameters match the call that provided
1730
+ # the page token.
1731
+ # @!attribute [rw] filter
1732
+ # @return [::String]
1733
+ # Optional. Filter results to be returned. See https://google.aip.dev/160 for more
1734
+ # details.
1735
+ # @!attribute [rw] order_by
1736
+ # @return [::String]
1737
+ # Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
1738
+ class ListJobRunsRequest
1739
+ include ::Google::Protobuf::MessageExts
1740
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1741
+ end
1742
+
1743
+ # ListJobRunsResponse is the response object returned by `ListJobRuns`.
1744
+ # @!attribute [rw] job_runs
1745
+ # @return [::Array<::Google::Cloud::Deploy::V1::JobRun>]
1746
+ # The `JobRun` objects.
1747
+ # @!attribute [rw] next_page_token
1748
+ # @return [::String]
1749
+ # A token, which can be sent as `page_token` to retrieve the next page. If
1750
+ # this field is omitted, there are no subsequent pages.
1751
+ # @!attribute [rw] unreachable
1752
+ # @return [::Array<::String>]
1753
+ # Locations that could not be reached
1754
+ class ListJobRunsResponse
1755
+ include ::Google::Protobuf::MessageExts
1756
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1757
+ end
1758
+
1759
+ # GetJobRunRequest is the request object used by `GetJobRun`.
1760
+ # @!attribute [rw] name
1761
+ # @return [::String]
1762
+ # Required. Name of the `JobRun`. Format must be
1763
+ # projects/\\{project_id}/locations/\\{location_name}/deliveryPipelines/\\{pipeline_name}/releases/\\{release_name}/rollouts/\\{rollout_name}/jobRuns/\\{job_run_name}.
1764
+ class GetJobRunRequest
1765
+ include ::Google::Protobuf::MessageExts
1766
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1767
+ end
1768
+
1327
1769
  # Service-wide configuration.
1328
1770
  # @!attribute [rw] name
1329
1771
  # @return [::String]
@@ -0,0 +1,55 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2022 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Deploy
23
+ module V1
24
+ # Payload proto for "clouddeploy.googleapis.com/jobrun_notification"
25
+ # Platform Log event that describes the failure to send JobRun resource update
26
+ # Pub/Sub notification.
27
+ # @!attribute [rw] message
28
+ # @return [::String]
29
+ # Debug message for when a notification fails to send.
30
+ # @!attribute [rw] job_run
31
+ # @return [::String]
32
+ # The name of the `JobRun`.
33
+ # @!attribute [rw] pipeline_uid
34
+ # @return [::String]
35
+ # Unique identifier of the `DeliveryPipeline`.
36
+ # @!attribute [rw] release_uid
37
+ # @return [::String]
38
+ # Unique identifier of the `Release`.
39
+ # @!attribute [rw] rollout_uid
40
+ # @return [::String]
41
+ # Unique identifier of the `Rollout`.
42
+ # @!attribute [rw] target_id
43
+ # @return [::String]
44
+ # ID of the `Target`.
45
+ # @!attribute [rw] type
46
+ # @return [::Google::Cloud::Deploy::V1::Type]
47
+ # Type of this notification, e.g. for a Pub/Sub failure.
48
+ class JobRunNotificationEvent
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+ end
52
+ end
53
+ end
54
+ end
55
+ end
@@ -26,8 +26,6 @@ module Google
26
26
  # service Foo {
27
27
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
28
  # }
29
- #
30
- # The JSON representation for `Empty` is empty JSON object `{}`.
31
29
  class Empty
32
30
  include ::Google::Protobuf::MessageExts
33
31
  extend ::Google::Protobuf::MessageExts::ClassMethods