google-cloud-build-v1 0.7.1 → 0.9.1

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.
@@ -57,9 +57,15 @@ module Google
57
57
 
58
58
  # Denotes that a (repeated) field is an unordered list.
59
59
  # This indicates that the service may provide the elements of the list
60
- # in any arbitrary order, rather than the order the user originally
60
+ # in any arbitrary order, rather than the order the user originally
61
61
  # provided. Additionally, the list's order may or may not be stable.
62
62
  UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
63
69
  end
64
70
  end
65
71
  end
@@ -43,7 +43,8 @@ module Google
43
43
  #
44
44
  # service ResourceService {
45
45
  # rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
46
- # rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);
46
+ # rpc UpdateResource(google.api.HttpBody) returns
47
+ # (google.protobuf.Empty);
47
48
  # }
48
49
  #
49
50
  # Example with streaming methods:
@@ -59,10 +60,10 @@ module Google
59
60
  # handled, all other features will continue to work unchanged.
60
61
  # @!attribute [rw] content_type
61
62
  # @return [::String]
62
- # The HTTP Content-Type string representing the content type of the body.
63
+ # The HTTP Content-Type header value specifying the content type of the body.
63
64
  # @!attribute [rw] data
64
65
  # @return [::String]
65
- # HTTP body binary data.
66
+ # The HTTP request/response body as raw binary.
66
67
  # @!attribute [rw] extensions
67
68
  # @return [::Array<::Google::Protobuf::Any>]
68
69
  # Application specific response metadata. Must be set in the first response
@@ -38,6 +38,10 @@ module Google
38
38
  end
39
39
 
40
40
  # Specifies a build trigger to run and the source to use.
41
+ # @!attribute [rw] name
42
+ # @return [::String]
43
+ # The name of the `Trigger` to run.
44
+ # Format: `projects/{project}/locations/{location}/triggers/{trigger}`
41
45
  # @!attribute [rw] project_id
42
46
  # @return [::String]
43
47
  # Required. ID of the project.
@@ -125,7 +129,8 @@ module Google
125
129
  end
126
130
 
127
131
  # Location of the source manifest in Google Cloud Storage.
128
- # This feature is in Preview.
132
+ # This feature is in Preview; see description
133
+ # [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).
129
134
  # @!attribute [rw] bucket
130
135
  # @return [::String]
131
136
  # Google Cloud Storage bucket containing the source manifest (see [Bucket
@@ -156,7 +161,8 @@ module Google
156
161
  # @!attribute [rw] storage_source_manifest
157
162
  # @return [::Google::Cloud::Build::V1::StorageSourceManifest]
158
163
  # If provided, get the source from this manifest in Google Cloud Storage.
159
- # This feature is in Preview.
164
+ # This feature is in Preview; see description
165
+ # [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher).
160
166
  class Source
161
167
  include ::Google::Protobuf::MessageExts
162
168
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -465,9 +471,10 @@ module Google
465
471
  # Output only. Stores timing information for phases of the build. Valid keys
466
472
  # are:
467
473
  #
468
- # * BUILD: time to execute all build steps
474
+ # * BUILD: time to execute all build steps.
469
475
  # * PUSH: time to push all specified images.
470
476
  # * FETCHSOURCE: time to fetch source.
477
+ # * SETUPBUILD: time to set up build.
471
478
  #
472
479
  # If the build does not specify source or images,
473
480
  # these keys will not be included.
@@ -476,15 +483,84 @@ module Google
476
483
  # IAM service account whose credentials will be used at build runtime.
477
484
  # Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
478
485
  # ACCOUNT can be email address or uniqueId of the service account.
479
- #
480
- # This field is in beta.
481
486
  # @!attribute [rw] available_secrets
482
487
  # @return [::Google::Cloud::Build::V1::Secrets]
483
488
  # Secrets and secret environment variables.
489
+ # @!attribute [r] warnings
490
+ # @return [::Array<::Google::Cloud::Build::V1::Build::Warning>]
491
+ # Output only. Non-fatal problems encountered during the execution of the
492
+ # build.
493
+ # @!attribute [r] failure_info
494
+ # @return [::Google::Cloud::Build::V1::Build::FailureInfo]
495
+ # Output only. Contains information about the build when status=FAILURE.
484
496
  class Build
485
497
  include ::Google::Protobuf::MessageExts
486
498
  extend ::Google::Protobuf::MessageExts::ClassMethods
487
499
 
500
+ # A non-fatal problem encountered during the execution of the build.
501
+ # @!attribute [rw] text
502
+ # @return [::String]
503
+ # Explanation of the warning generated.
504
+ # @!attribute [rw] priority
505
+ # @return [::Google::Cloud::Build::V1::Build::Warning::Priority]
506
+ # The priority for this warning.
507
+ class Warning
508
+ include ::Google::Protobuf::MessageExts
509
+ extend ::Google::Protobuf::MessageExts::ClassMethods
510
+
511
+ # The relative importance of this warning.
512
+ module Priority
513
+ # Should not be used.
514
+ PRIORITY_UNSPECIFIED = 0
515
+
516
+ # e.g. deprecation warnings and alternative feature highlights.
517
+ INFO = 1
518
+
519
+ # e.g. automated detection of possible issues with the build.
520
+ WARNING = 2
521
+
522
+ # e.g. alerts that a feature used in the build is pending removal
523
+ ALERT = 3
524
+ end
525
+ end
526
+
527
+ # A fatal problem encountered during the execution of the build.
528
+ # @!attribute [rw] type
529
+ # @return [::Google::Cloud::Build::V1::Build::FailureInfo::FailureType]
530
+ # The name of the failure.
531
+ # @!attribute [rw] detail
532
+ # @return [::String]
533
+ # Explains the failure issue in more detail using hard-coded text.
534
+ class FailureInfo
535
+ include ::Google::Protobuf::MessageExts
536
+ extend ::Google::Protobuf::MessageExts::ClassMethods
537
+
538
+ # The name of a fatal problem encountered during the execution of the
539
+ # build.
540
+ module FailureType
541
+ # Type unspecified
542
+ FAILURE_TYPE_UNSPECIFIED = 0
543
+
544
+ # Unable to push the image to the repository.
545
+ PUSH_FAILED = 1
546
+
547
+ # Final image not found.
548
+ PUSH_IMAGE_NOT_FOUND = 2
549
+
550
+ # Unauthorized push of the final image.
551
+ PUSH_NOT_AUTHORIZED = 3
552
+
553
+ # Backend logging failures. Should retry.
554
+ LOGGING_FAILURE = 4
555
+
556
+ # A build step has failed.
557
+ USER_BUILD_STEP = 5
558
+
559
+ # The source fetching has failed.
560
+ FETCH_SOURCE_FAILED = 6
561
+ end
562
+ end
563
+
488
564
  # @!attribute [rw] key
489
565
  # @return [::String]
490
566
  # @!attribute [rw] value
@@ -861,6 +937,11 @@ module Google
861
937
 
862
938
  # Configuration for an automated build in response to source repository
863
939
  # changes.
940
+ # @!attribute [rw] resource_name
941
+ # @return [::String]
942
+ # The `Trigger` name with format:
943
+ # `projects/{project}/locations/{location}/triggers/{trigger}`, where
944
+ # \\{trigger} is a unique identifier generated by the service.
864
945
  # @!attribute [r] id
865
946
  # @return [::String]
866
947
  # Output only. Unique identifier of the trigger.
@@ -895,8 +976,23 @@ module Google
895
976
  # Mutually exclusive with `trigger_template`.
896
977
  # @!attribute [rw] pubsub_config
897
978
  # @return [::Google::Cloud::Build::V1::PubsubConfig]
898
- # Optional. PubsubConfig describes the configuration of a trigger that
979
+ # PubsubConfig describes the configuration of a trigger that
899
980
  # creates a build whenever a Pub/Sub message is published.
981
+ # @!attribute [rw] webhook_config
982
+ # @return [::Google::Cloud::Build::V1::WebhookConfig]
983
+ # WebhookConfig describes the configuration of a trigger that
984
+ # creates a build whenever a webhook is sent to a trigger's webhook URL.
985
+ # @!attribute [rw] autodetect
986
+ # @return [::Boolean]
987
+ # Autodetect build configuration. The following precedence is used (case
988
+ # insensitive):
989
+ #
990
+ # 1. cloudbuild.yaml
991
+ # 2. cloudbuild.yml
992
+ # 3. cloudbuild.json
993
+ # 4. Dockerfile
994
+ #
995
+ # Currently only available for GitHub App Triggers.
900
996
  # @!attribute [rw] build
901
997
  # @return [::Google::Cloud::Build::V1::Build]
902
998
  # Contents of the build template.
@@ -1020,6 +1116,33 @@ module Google
1020
1116
  end
1021
1117
  end
1022
1118
 
1119
+ # WebhookConfig describes the configuration of a trigger that
1120
+ # creates a build whenever a webhook is sent to a trigger's webhook URL.
1121
+ # @!attribute [rw] secret
1122
+ # @return [::String]
1123
+ # Required. Resource name for the secret required as a URL parameter.
1124
+ # @!attribute [rw] state
1125
+ # @return [::Google::Cloud::Build::V1::WebhookConfig::State]
1126
+ # Potential issues with the underlying Pub/Sub subscription configuration.
1127
+ # Only populated on get requests.
1128
+ class WebhookConfig
1129
+ include ::Google::Protobuf::MessageExts
1130
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1131
+
1132
+ # Enumerates potential issues with the Secret Manager secret provided by the
1133
+ # user.
1134
+ module State
1135
+ # The webhook auth configuration not been checked.
1136
+ STATE_UNSPECIFIED = 0
1137
+
1138
+ # The auth configuration is properly setup.
1139
+ OK = 1
1140
+
1141
+ # The secret provided in auth_method has been deleted.
1142
+ SECRET_DELETED = 2
1143
+ end
1144
+ end
1145
+
1023
1146
  # PullRequestFilter contains filter properties for matching GitHub Pull
1024
1147
  # Requests.
1025
1148
  # @!attribute [rw] branch
@@ -1077,6 +1200,10 @@ module Google
1077
1200
  end
1078
1201
 
1079
1202
  # Request to create a new `BuildTrigger`.
1203
+ # @!attribute [rw] parent
1204
+ # @return [::String]
1205
+ # The parent resource where this trigger will be created.
1206
+ # Format: `projects/{project}/locations/{location}`
1080
1207
  # @!attribute [rw] project_id
1081
1208
  # @return [::String]
1082
1209
  # Required. ID of the project for which to configure automatic builds.
@@ -1089,6 +1216,10 @@ module Google
1089
1216
  end
1090
1217
 
1091
1218
  # Returns the `BuildTrigger` with the specified ID.
1219
+ # @!attribute [rw] name
1220
+ # @return [::String]
1221
+ # The name of the `Trigger` to retrieve.
1222
+ # Format: `projects/{project}/locations/{location}/triggers/{trigger}`
1092
1223
  # @!attribute [rw] project_id
1093
1224
  # @return [::String]
1094
1225
  # Required. ID of the project that owns the trigger.
@@ -1101,6 +1232,10 @@ module Google
1101
1232
  end
1102
1233
 
1103
1234
  # Request to list existing `BuildTriggers`.
1235
+ # @!attribute [rw] parent
1236
+ # @return [::String]
1237
+ # The parent of the collection of `Triggers`.
1238
+ # Format: `projects/{project}/locations/{location}`
1104
1239
  # @!attribute [rw] project_id
1105
1240
  # @return [::String]
1106
1241
  # Required. ID of the project for which to list BuildTriggers.
@@ -1128,6 +1263,10 @@ module Google
1128
1263
  end
1129
1264
 
1130
1265
  # Request to delete a `BuildTrigger`.
1266
+ # @!attribute [rw] name
1267
+ # @return [::String]
1268
+ # The name of the `Trigger` to delete.
1269
+ # Format: `projects/{project}/locations/{location}/triggers/{trigger}`
1131
1270
  # @!attribute [rw] project_id
1132
1271
  # @return [::String]
1133
1272
  # Required. ID of the project that owns the trigger.
@@ -1192,10 +1331,14 @@ module Google
1192
1331
  # Storage.
1193
1332
  # @!attribute [rw] worker_pool
1194
1333
  # @return [::String]
1195
- # Option to specify a `WorkerPool` for the build.
1196
- # Format: projects/\\{project}/locations/\\{location}/workerPools/\\{workerPool}
1334
+ # This field deprecated; please use `pool.name` instead.
1335
+ # @!attribute [rw] pool
1336
+ # @return [::Google::Cloud::Build::V1::BuildOptions::PoolOption]
1337
+ # Optional. Specification for execution on a `WorkerPool`.
1197
1338
  #
1198
- # This field is experimental.
1339
+ # See [running builds in a private
1340
+ # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
1341
+ # for more information.
1199
1342
  # @!attribute [rw] logging
1200
1343
  # @return [::Google::Cloud::Build::V1::BuildOptions::LoggingMode]
1201
1344
  # Option to specify the logging mode, which determines if and where build
@@ -1229,6 +1372,23 @@ module Google
1229
1372
  include ::Google::Protobuf::MessageExts
1230
1373
  extend ::Google::Protobuf::MessageExts::ClassMethods
1231
1374
 
1375
+ # Details about how a build should be executed on a `WorkerPool`.
1376
+ #
1377
+ # See [running builds in a private
1378
+ # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
1379
+ # for more information.
1380
+ # @!attribute [rw] name
1381
+ # @return [::String]
1382
+ # The `WorkerPool` resource to execute the build on.
1383
+ # You must have `cloudbuild.workerpools.use` on the project hosting the
1384
+ # WorkerPool.
1385
+ #
1386
+ # Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
1387
+ class PoolOption
1388
+ include ::Google::Protobuf::MessageExts
1389
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1390
+ end
1391
+
1232
1392
  # Specifies the manner in which the build should be verified, if at all.
1233
1393
  module VerifyOption
1234
1394
  # Not a verifiable build. (default)
@@ -1308,6 +1468,10 @@ module Google
1308
1468
 
1309
1469
  # ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by
1310
1470
  # the ReceiveTriggerWebhook method.
1471
+ # @!attribute [rw] name
1472
+ # @return [::String]
1473
+ # The name of the `ReceiveTriggerWebhook` to retrieve.
1474
+ # Format: `projects/{project}/locations/{location}/triggers/{trigger}`
1311
1475
  # @!attribute [rw] body
1312
1476
  # @return [::Google::Api::HttpBody]
1313
1477
  # HTTP request body.
@@ -1332,78 +1496,77 @@ module Google
1332
1496
  extend ::Google::Protobuf::MessageExts::ClassMethods
1333
1497
  end
1334
1498
 
1335
- # Configuration for a WorkerPool to run the builds.
1499
+ # Configuration for a `WorkerPool`.
1336
1500
  #
1337
- # Workers are machines that Cloud Build uses to run your builds. By default,
1338
- # all workers run in a project owned by Cloud Build. To have full control over
1339
- # the workers that execute your builds -- such as enabling them to access
1340
- # private resources on your private network -- you can request Cloud Build to
1341
- # run the workers in your own project by creating a custom workers pool.
1342
- # @!attribute [rw] name
1501
+ # Cloud Build owns and maintains a pool of workers for general use and have no
1502
+ # access to a project's private network. By default, builds submitted to
1503
+ # Cloud Build will use a worker from this pool.
1504
+ #
1505
+ # If your build needs access to resources on a private network,
1506
+ # create and use a `WorkerPool` to run your builds. Private `WorkerPool`s give
1507
+ # your builds access to any single VPC network that you
1508
+ # administer, including any on-prem resources connected to that VPC
1509
+ # network. For an overview of private pools, see
1510
+ # [Private pools
1511
+ # overview](https://cloud.google.com/build/docs/private-pools/private-pools-overview).
1512
+ # @!attribute [r] name
1343
1513
  # @return [::String]
1344
- # User-defined name of the `WorkerPool`.
1345
- # @!attribute [rw] project_id
1514
+ # Output only. The resource name of the `WorkerPool`, with format
1515
+ # `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
1516
+ # The value of `{worker_pool}` is provided by `worker_pool_id` in
1517
+ # `CreateWorkerPool` request and the value of `{location}` is determined by
1518
+ # the endpoint accessed.
1519
+ # @!attribute [rw] display_name
1346
1520
  # @return [::String]
1347
- # The project ID of the GCP project for which the `WorkerPool` is created.
1348
- # @!attribute [rw] service_account_email
1521
+ # A user-specified, human-readable name for the `WorkerPool`. If provided,
1522
+ # this value must be 1-63 characters.
1523
+ # @!attribute [r] uid
1349
1524
  # @return [::String]
1350
- # Output only. The service account used to manage the `WorkerPool`. The
1351
- # service account must have the Compute Instance Admin (Beta) permission at
1352
- # the project level.
1353
- # @!attribute [rw] worker_count
1354
- # @return [::Integer]
1355
- # Total number of workers to be created across all requested regions.
1356
- # @!attribute [rw] worker_config
1357
- # @return [::Google::Cloud::Build::V1::WorkerConfig]
1358
- # Configuration to be used for a creating workers in the `WorkerPool`.
1359
- # @!attribute [rw] regions
1360
- # @return [::Array<::Google::Cloud::Build::V1::WorkerPool::Region>]
1361
- # List of regions to create the `WorkerPool`. Regions can't be empty.
1362
- # If Cloud Build adds a new GCP region in the future, the existing
1363
- # `WorkerPool` will not be enabled in the new region automatically;
1364
- # you must add the new region to the `regions` field to enable the
1365
- # `WorkerPool` in that region.
1366
- # @!attribute [rw] create_time
1525
+ # Output only. A unique identifier for the `WorkerPool`.
1526
+ # @!attribute [rw] annotations
1527
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1528
+ # User specified annotations. See https://google.aip.dev/128#annotations
1529
+ # for more details such as format and size limitations.
1530
+ # @!attribute [r] create_time
1367
1531
  # @return [::Google::Protobuf::Timestamp]
1368
1532
  # Output only. Time at which the request to create the `WorkerPool` was
1369
1533
  # received.
1370
- # @!attribute [rw] update_time
1534
+ # @!attribute [r] update_time
1371
1535
  # @return [::Google::Protobuf::Timestamp]
1372
1536
  # Output only. Time at which the request to update the `WorkerPool` was
1373
1537
  # received.
1374
- # @!attribute [rw] delete_time
1538
+ # @!attribute [r] delete_time
1375
1539
  # @return [::Google::Protobuf::Timestamp]
1376
1540
  # Output only. Time at which the request to delete the `WorkerPool` was
1377
1541
  # received.
1378
- # @!attribute [rw] status
1379
- # @return [::Google::Cloud::Build::V1::WorkerPool::Status]
1380
- # Output only. WorkerPool Status.
1542
+ # @!attribute [r] state
1543
+ # @return [::Google::Cloud::Build::V1::WorkerPool::State]
1544
+ # Output only. `WorkerPool` state.
1545
+ # @!attribute [rw] private_pool_v1_config
1546
+ # @return [::Google::Cloud::Build::V1::PrivatePoolV1Config]
1547
+ # Private Pool using a v1 configuration.
1548
+ # @!attribute [r] etag
1549
+ # @return [::String]
1550
+ # Output only. Checksum computed by the server. May be sent on update and
1551
+ # delete requests to ensure that the client has an up-to-date value before
1552
+ # proceeding.
1381
1553
  class WorkerPool
1382
1554
  include ::Google::Protobuf::MessageExts
1383
1555
  extend ::Google::Protobuf::MessageExts::ClassMethods
1384
1556
 
1385
- # Supported GCP regions to create the `WorkerPool`.
1386
- module Region
1387
- # no region
1388
- REGION_UNSPECIFIED = 0
1389
-
1390
- # us-central1 region
1391
- US_CENTRAL1 = 1
1392
-
1393
- # us-west1 region
1394
- US_WEST1 = 2
1395
-
1396
- # us-east1 region
1397
- US_EAST1 = 3
1398
-
1399
- # us-east4 region
1400
- US_EAST4 = 4
1557
+ # @!attribute [rw] key
1558
+ # @return [::String]
1559
+ # @!attribute [rw] value
1560
+ # @return [::String]
1561
+ class AnnotationsEntry
1562
+ include ::Google::Protobuf::MessageExts
1563
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1401
1564
  end
1402
1565
 
1403
- # `WorkerPool` status
1404
- module Status
1405
- # Status of the `WorkerPool` is unknown.
1406
- STATUS_UNSPECIFIED = 0
1566
+ # State of the `WorkerPool`.
1567
+ module State
1568
+ # State of the `WorkerPool` is unknown.
1569
+ STATE_UNSPECIFIED = 0
1407
1570
 
1408
1571
  # `WorkerPool` is being created.
1409
1572
  CREATING = 1
@@ -1419,71 +1582,90 @@ module Google
1419
1582
  end
1420
1583
  end
1421
1584
 
1422
- # WorkerConfig defines the configuration to be used for a creating workers in
1423
- # the pool.
1424
- # @!attribute [rw] machine_type
1425
- # @return [::String]
1426
- # Machine Type of the worker, such as n1-standard-1.
1427
- # See https://cloud.google.com/compute/docs/machine-types.
1428
- # If left blank, Cloud Build will use a standard unspecified machine to
1429
- # create the worker pool.
1430
- # `machine_type` is overridden if you specify a different machine type in
1431
- # `build_options`. In this case, the VM specified in the `build_options`
1432
- # will be created on demand at build time. For more information see
1433
- # https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
1434
- # @!attribute [rw] disk_size_gb
1435
- # @return [::Integer]
1436
- # Size of the disk attached to the worker, in GB.
1437
- # See https://cloud.google.com/compute/docs/disks/
1438
- # If `0` is specified, Cloud Build will use a standard disk size.
1439
- # `disk_size` is overridden if you specify a different disk size in
1440
- # `build_options`. In this case, a VM with a disk size specified in the
1441
- # `build_options` will be created on demand at build time. For more
1442
- # information see
1443
- # https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
1444
- # @!attribute [rw] network
1445
- # @return [::Google::Cloud::Build::V1::Network]
1446
- # The network definition used to create the worker.
1447
- # If this section is left empty, the workers will be created in
1448
- # WorkerPool.project_id on the default network.
1449
- # @!attribute [rw] tag
1450
- # @return [::String]
1451
- # The tag applied to the worker, and the same tag used by the firewall rule.
1452
- # It is used to identify the Cloud Build workers among other VMs.
1453
- # The default value for tag is `worker`.
1454
- class WorkerConfig
1585
+ # Configuration for a V1 `PrivatePool`.
1586
+ # @!attribute [rw] worker_config
1587
+ # @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::WorkerConfig]
1588
+ # Machine configuration for the workers in the pool.
1589
+ # @!attribute [rw] network_config
1590
+ # @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig]
1591
+ # Network configuration for the pool.
1592
+ class PrivatePoolV1Config
1455
1593
  include ::Google::Protobuf::MessageExts
1456
1594
  extend ::Google::Protobuf::MessageExts::ClassMethods
1457
- end
1458
1595
 
1459
- # Network describes the GCP network used to create workers in.
1460
- # @!attribute [rw] project_id
1461
- # @return [::String]
1462
- # Project id containing the defined network and subnetwork. For a peered VPC,
1463
- # this will be the same as the project_id in which the workers are created.
1464
- # For a shared VPC, this will be the project sharing the network with the
1465
- # project_id project in which workers will be created. For custom workers
1466
- # with no VPC, this will be the same as project_id.
1467
- # @!attribute [rw] network
1468
- # @return [::String]
1469
- # Network on which the workers are created.
1470
- # "default" network is used if empty.
1471
- # @!attribute [rw] subnetwork
1472
- # @return [::String]
1473
- # Subnetwork on which the workers are created.
1474
- # "default" subnetwork is used if empty.
1475
- class Network
1476
- include ::Google::Protobuf::MessageExts
1477
- extend ::Google::Protobuf::MessageExts::ClassMethods
1596
+ # Defines the configuration to be used for creating workers in
1597
+ # the pool.
1598
+ # @!attribute [rw] machine_type
1599
+ # @return [::String]
1600
+ # Machine type of a worker, such as `e2-medium`.
1601
+ # See [Worker pool config
1602
+ # file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
1603
+ # If left blank, Cloud Build will use a sensible default.
1604
+ # @!attribute [rw] disk_size_gb
1605
+ # @return [::Integer]
1606
+ # Size of the disk attached to the worker, in GB.
1607
+ # See [Worker pool config
1608
+ # file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
1609
+ # Specify a value of up to 1000. If `0` is specified, Cloud Build will use
1610
+ # a standard disk size.
1611
+ class WorkerConfig
1612
+ include ::Google::Protobuf::MessageExts
1613
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1614
+ end
1615
+
1616
+ # Defines the network configuration for the pool.
1617
+ # @!attribute [rw] peered_network
1618
+ # @return [::String]
1619
+ # Required. Immutable. The network definition that the workers are peered
1620
+ # to. If this section is left empty, the workers will be peered to
1621
+ # `WorkerPool.project_id` on the service producer network. Must be in the
1622
+ # format `projects/{project}/global/networks/{network}`, where `{project}`
1623
+ # is a project number, such as `12345`, and `{network}` is the name of a
1624
+ # VPC network in the project. See
1625
+ # [Understanding network configuration
1626
+ # options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment)
1627
+ # @!attribute [rw] egress_option
1628
+ # @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig::EgressOption]
1629
+ # Option to configure network egress for the workers.
1630
+ class NetworkConfig
1631
+ include ::Google::Protobuf::MessageExts
1632
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1633
+
1634
+ # Defines the egress option for the pool.
1635
+ module EgressOption
1636
+ # If set, defaults to PUBLIC_EGRESS.
1637
+ EGRESS_OPTION_UNSPECIFIED = 0
1638
+
1639
+ # If set, workers are created without any public address, which prevents
1640
+ # network egress to public IPs unless a network proxy is configured.
1641
+ NO_PUBLIC_EGRESS = 1
1642
+
1643
+ # If set, workers are created with a public address which allows for
1644
+ # public internet egress.
1645
+ PUBLIC_EGRESS = 2
1646
+ end
1647
+ end
1478
1648
  end
1479
1649
 
1480
1650
  # Request to create a new `WorkerPool`.
1481
1651
  # @!attribute [rw] parent
1482
1652
  # @return [::String]
1483
- # ID of the parent project.
1653
+ # Required. The parent resource where this worker pool will be created.
1654
+ # Format: `projects/{project}/locations/{location}`.
1484
1655
  # @!attribute [rw] worker_pool
1485
1656
  # @return [::Google::Cloud::Build::V1::WorkerPool]
1486
- # `WorkerPool` resource to create.
1657
+ # Required. `WorkerPool` resource to create.
1658
+ # @!attribute [rw] worker_pool_id
1659
+ # @return [::String]
1660
+ # Required. Immutable. The ID to use for the `WorkerPool`, which will become
1661
+ # the final component of the resource name.
1662
+ #
1663
+ # This value should be 1-63 characters, and valid characters
1664
+ # are /[a-z][0-9]-/.
1665
+ # @!attribute [rw] validate_only
1666
+ # @return [::Boolean]
1667
+ # If set, validate the request and preview the response, but do not actually
1668
+ # post it.
1487
1669
  class CreateWorkerPoolRequest
1488
1670
  include ::Google::Protobuf::MessageExts
1489
1671
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1492,8 +1674,8 @@ module Google
1492
1674
  # Request to get a `WorkerPool` with the specified name.
1493
1675
  # @!attribute [rw] name
1494
1676
  # @return [::String]
1495
- # The field will contain name of the resource requested, for example:
1496
- # "projects/project-1/workerPools/workerpool-name"
1677
+ # Required. The name of the `WorkerPool` to retrieve.
1678
+ # Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`.
1497
1679
  class GetWorkerPoolRequest
1498
1680
  include ::Google::Protobuf::MessageExts
1499
1681
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1502,30 +1684,58 @@ module Google
1502
1684
  # Request to delete a `WorkerPool`.
1503
1685
  # @!attribute [rw] name
1504
1686
  # @return [::String]
1505
- # The field will contain name of the resource requested, for example:
1506
- # "projects/project-1/workerPools/workerpool-name"
1687
+ # Required. The name of the `WorkerPool` to delete.
1688
+ # Format:
1689
+ # `projects/{project}/locations/{workerPool}/workerPools/{workerPool}`.
1690
+ # @!attribute [rw] etag
1691
+ # @return [::String]
1692
+ # Optional. If this is provided, it must match the server's etag on the
1693
+ # workerpool for the request to be processed.
1694
+ # @!attribute [rw] allow_missing
1695
+ # @return [::Boolean]
1696
+ # If set to true, and the `WorkerPool` is not found, the request will succeed
1697
+ # but no action will be taken on the server.
1698
+ # @!attribute [rw] validate_only
1699
+ # @return [::Boolean]
1700
+ # If set, validate the request and preview the response, but do not actually
1701
+ # post it.
1507
1702
  class DeleteWorkerPoolRequest
1508
1703
  include ::Google::Protobuf::MessageExts
1509
1704
  extend ::Google::Protobuf::MessageExts::ClassMethods
1510
1705
  end
1511
1706
 
1512
1707
  # Request to update a `WorkerPool`.
1513
- # @!attribute [rw] name
1514
- # @return [::String]
1515
- # The field will contain name of the resource requested, for example:
1516
- # "projects/project-1/workerPools/workerpool-name"
1517
1708
  # @!attribute [rw] worker_pool
1518
1709
  # @return [::Google::Cloud::Build::V1::WorkerPool]
1519
- # `WorkerPool` resource to update.
1710
+ # Required. The `WorkerPool` to update.
1711
+ #
1712
+ # The `name` field is used to identify the `WorkerPool` to update.
1713
+ # Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`.
1714
+ # @!attribute [rw] update_mask
1715
+ # @return [::Google::Protobuf::FieldMask]
1716
+ # A mask specifying which fields in `worker_pool` to update.
1717
+ # @!attribute [rw] validate_only
1718
+ # @return [::Boolean]
1719
+ # If set, validate the request and preview the response, but do not actually
1720
+ # post it.
1520
1721
  class UpdateWorkerPoolRequest
1521
1722
  include ::Google::Protobuf::MessageExts
1522
1723
  extend ::Google::Protobuf::MessageExts::ClassMethods
1523
1724
  end
1524
1725
 
1525
- # Request to list `WorkerPools`.
1726
+ # Request to list `WorkerPool`s.
1526
1727
  # @!attribute [rw] parent
1527
1728
  # @return [::String]
1528
- # ID of the parent project.
1729
+ # Required. The parent of the collection of `WorkerPools`.
1730
+ # Format: `projects/{project}/locations/{location}`.
1731
+ # @!attribute [rw] page_size
1732
+ # @return [::Integer]
1733
+ # The maximum number of `WorkerPool`s to return. The service may return
1734
+ # fewer than this value. If omitted, the server will use a sensible default.
1735
+ # @!attribute [rw] page_token
1736
+ # @return [::String]
1737
+ # A page token, received from a previous `ListWorkerPools` call. Provide this
1738
+ # to retrieve the subsequent page.
1529
1739
  class ListWorkerPoolsRequest
1530
1740
  include ::Google::Protobuf::MessageExts
1531
1741
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1534,11 +1744,67 @@ module Google
1534
1744
  # Response containing existing `WorkerPools`.
1535
1745
  # @!attribute [rw] worker_pools
1536
1746
  # @return [::Array<::Google::Cloud::Build::V1::WorkerPool>]
1537
- # `WorkerPools` for the project.
1747
+ # `WorkerPools` for the specified project.
1748
+ # @!attribute [rw] next_page_token
1749
+ # @return [::String]
1750
+ # Continuation token used to page through large result sets. Provide this
1751
+ # value in a subsequent ListWorkerPoolsRequest to return the next page of
1752
+ # results.
1538
1753
  class ListWorkerPoolsResponse
1539
1754
  include ::Google::Protobuf::MessageExts
1540
1755
  extend ::Google::Protobuf::MessageExts::ClassMethods
1541
1756
  end
1757
+
1758
+ # Metadata for the `CreateWorkerPool` operation.
1759
+ # @!attribute [rw] worker_pool
1760
+ # @return [::String]
1761
+ # The resource name of the `WorkerPool` to create.
1762
+ # Format:
1763
+ # `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
1764
+ # @!attribute [rw] create_time
1765
+ # @return [::Google::Protobuf::Timestamp]
1766
+ # Time the operation was created.
1767
+ # @!attribute [rw] complete_time
1768
+ # @return [::Google::Protobuf::Timestamp]
1769
+ # Time the operation was completed.
1770
+ class CreateWorkerPoolOperationMetadata
1771
+ include ::Google::Protobuf::MessageExts
1772
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1773
+ end
1774
+
1775
+ # Metadata for the `UpdateWorkerPool` operation.
1776
+ # @!attribute [rw] worker_pool
1777
+ # @return [::String]
1778
+ # The resource name of the `WorkerPool` being updated.
1779
+ # Format:
1780
+ # `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
1781
+ # @!attribute [rw] create_time
1782
+ # @return [::Google::Protobuf::Timestamp]
1783
+ # Time the operation was created.
1784
+ # @!attribute [rw] complete_time
1785
+ # @return [::Google::Protobuf::Timestamp]
1786
+ # Time the operation was completed.
1787
+ class UpdateWorkerPoolOperationMetadata
1788
+ include ::Google::Protobuf::MessageExts
1789
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1790
+ end
1791
+
1792
+ # Metadata for the `DeleteWorkerPool` operation.
1793
+ # @!attribute [rw] worker_pool
1794
+ # @return [::String]
1795
+ # The resource name of the `WorkerPool` being deleted.
1796
+ # Format:
1797
+ # `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
1798
+ # @!attribute [rw] create_time
1799
+ # @return [::Google::Protobuf::Timestamp]
1800
+ # Time the operation was created.
1801
+ # @!attribute [rw] complete_time
1802
+ # @return [::Google::Protobuf::Timestamp]
1803
+ # Time the operation was completed.
1804
+ class DeleteWorkerPoolOperationMetadata
1805
+ include ::Google::Protobuf::MessageExts
1806
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1807
+ end
1542
1808
  end
1543
1809
  end
1544
1810
  end