google-cloud-build-v1 0.7.0 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
@@ -476,15 +482,84 @@ module Google
476
482
  # IAM service account whose credentials will be used at build runtime.
477
483
  # Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
478
484
  # ACCOUNT can be email address or uniqueId of the service account.
479
- #
480
- # This field is in beta.
481
485
  # @!attribute [rw] available_secrets
482
486
  # @return [::Google::Cloud::Build::V1::Secrets]
483
487
  # Secrets and secret environment variables.
488
+ # @!attribute [r] warnings
489
+ # @return [::Array<::Google::Cloud::Build::V1::Build::Warning>]
490
+ # Output only. Non-fatal problems encountered during the execution of the
491
+ # build.
492
+ # @!attribute [r] failure_info
493
+ # @return [::Google::Cloud::Build::V1::Build::FailureInfo]
494
+ # Output only. Contains information about the build when status=FAILURE.
484
495
  class Build
485
496
  include ::Google::Protobuf::MessageExts
486
497
  extend ::Google::Protobuf::MessageExts::ClassMethods
487
498
 
499
+ # A non-fatal problem encountered during the execution of the build.
500
+ # @!attribute [rw] text
501
+ # @return [::String]
502
+ # Explanation of the warning generated.
503
+ # @!attribute [rw] priority
504
+ # @return [::Google::Cloud::Build::V1::Build::Warning::Priority]
505
+ # The priority for this warning.
506
+ class Warning
507
+ include ::Google::Protobuf::MessageExts
508
+ extend ::Google::Protobuf::MessageExts::ClassMethods
509
+
510
+ # The relative importance of this warning.
511
+ module Priority
512
+ # Should not be used.
513
+ PRIORITY_UNSPECIFIED = 0
514
+
515
+ # e.g. deprecation warnings and alternative feature highlights.
516
+ INFO = 1
517
+
518
+ # e.g. automated detection of possible issues with the build.
519
+ WARNING = 2
520
+
521
+ # e.g. alerts that a feature used in the build is pending removal
522
+ ALERT = 3
523
+ end
524
+ end
525
+
526
+ # A fatal problem encountered during the execution of the build.
527
+ # @!attribute [rw] type
528
+ # @return [::Google::Cloud::Build::V1::Build::FailureInfo::FailureType]
529
+ # The name of the failure.
530
+ # @!attribute [rw] detail
531
+ # @return [::String]
532
+ # Explains the failure issue in more detail using hard-coded text.
533
+ class FailureInfo
534
+ include ::Google::Protobuf::MessageExts
535
+ extend ::Google::Protobuf::MessageExts::ClassMethods
536
+
537
+ # The name of a fatal problem encountered during the execution of the
538
+ # build.
539
+ module FailureType
540
+ # Type unspecified
541
+ FAILURE_TYPE_UNSPECIFIED = 0
542
+
543
+ # Unable to push the image to the repository.
544
+ PUSH_FAILED = 1
545
+
546
+ # Final image not found.
547
+ PUSH_IMAGE_NOT_FOUND = 2
548
+
549
+ # Unauthorized push of the final image.
550
+ PUSH_NOT_AUTHORIZED = 3
551
+
552
+ # Backend logging failures. Should retry.
553
+ LOGGING_FAILURE = 4
554
+
555
+ # A build step has failed.
556
+ USER_BUILD_STEP = 5
557
+
558
+ # The source fetching has failed.
559
+ FETCH_SOURCE_FAILED = 6
560
+ end
561
+ end
562
+
488
563
  # @!attribute [rw] key
489
564
  # @return [::String]
490
565
  # @!attribute [rw] value
@@ -861,6 +936,11 @@ module Google
861
936
 
862
937
  # Configuration for an automated build in response to source repository
863
938
  # changes.
939
+ # @!attribute [rw] resource_name
940
+ # @return [::String]
941
+ # The `Trigger` name with format:
942
+ # `projects/{project}/locations/{location}/triggers/{trigger}`, where
943
+ # \\{trigger} is a unique identifier generated by the service.
864
944
  # @!attribute [r] id
865
945
  # @return [::String]
866
946
  # Output only. Unique identifier of the trigger.
@@ -895,8 +975,23 @@ module Google
895
975
  # Mutually exclusive with `trigger_template`.
896
976
  # @!attribute [rw] pubsub_config
897
977
  # @return [::Google::Cloud::Build::V1::PubsubConfig]
898
- # Optional. PubsubConfig describes the configuration of a trigger that
978
+ # PubsubConfig describes the configuration of a trigger that
899
979
  # creates a build whenever a Pub/Sub message is published.
980
+ # @!attribute [rw] webhook_config
981
+ # @return [::Google::Cloud::Build::V1::WebhookConfig]
982
+ # WebhookConfig describes the configuration of a trigger that
983
+ # creates a build whenever a webhook is sent to a trigger's webhook URL.
984
+ # @!attribute [rw] autodetect
985
+ # @return [::Boolean]
986
+ # Autodetect build configuration. The following precedence is used (case
987
+ # insensitive):
988
+ #
989
+ # 1. cloudbuild.yaml
990
+ # 2. cloudbuild.yml
991
+ # 3. cloudbuild.json
992
+ # 4. Dockerfile
993
+ #
994
+ # Currently only available for GitHub App Triggers.
900
995
  # @!attribute [rw] build
901
996
  # @return [::Google::Cloud::Build::V1::Build]
902
997
  # Contents of the build template.
@@ -1020,6 +1115,33 @@ module Google
1020
1115
  end
1021
1116
  end
1022
1117
 
1118
+ # WebhookConfig describes the configuration of a trigger that
1119
+ # creates a build whenever a webhook is sent to a trigger's webhook URL.
1120
+ # @!attribute [rw] secret
1121
+ # @return [::String]
1122
+ # Required. Resource name for the secret required as a URL parameter.
1123
+ # @!attribute [rw] state
1124
+ # @return [::Google::Cloud::Build::V1::WebhookConfig::State]
1125
+ # Potential issues with the underlying Pub/Sub subscription configuration.
1126
+ # Only populated on get requests.
1127
+ class WebhookConfig
1128
+ include ::Google::Protobuf::MessageExts
1129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1130
+
1131
+ # Enumerates potential issues with the Secret Manager secret provided by the
1132
+ # user.
1133
+ module State
1134
+ # The webhook auth configuration not been checked.
1135
+ STATE_UNSPECIFIED = 0
1136
+
1137
+ # The auth configuration is properly setup.
1138
+ OK = 1
1139
+
1140
+ # The secret provided in auth_method has been deleted.
1141
+ SECRET_DELETED = 2
1142
+ end
1143
+ end
1144
+
1023
1145
  # PullRequestFilter contains filter properties for matching GitHub Pull
1024
1146
  # Requests.
1025
1147
  # @!attribute [rw] branch
@@ -1077,6 +1199,10 @@ module Google
1077
1199
  end
1078
1200
 
1079
1201
  # Request to create a new `BuildTrigger`.
1202
+ # @!attribute [rw] parent
1203
+ # @return [::String]
1204
+ # The parent resource where this trigger will be created.
1205
+ # Format: `projects/{project}/locations/{location}`
1080
1206
  # @!attribute [rw] project_id
1081
1207
  # @return [::String]
1082
1208
  # Required. ID of the project for which to configure automatic builds.
@@ -1089,6 +1215,10 @@ module Google
1089
1215
  end
1090
1216
 
1091
1217
  # Returns the `BuildTrigger` with the specified ID.
1218
+ # @!attribute [rw] name
1219
+ # @return [::String]
1220
+ # The name of the `Trigger` to retrieve.
1221
+ # Format: `projects/{project}/locations/{location}/triggers/{trigger}`
1092
1222
  # @!attribute [rw] project_id
1093
1223
  # @return [::String]
1094
1224
  # Required. ID of the project that owns the trigger.
@@ -1101,6 +1231,10 @@ module Google
1101
1231
  end
1102
1232
 
1103
1233
  # Request to list existing `BuildTriggers`.
1234
+ # @!attribute [rw] parent
1235
+ # @return [::String]
1236
+ # The parent of the collection of `Triggers`.
1237
+ # Format: `projects/{project}/locations/{location}`
1104
1238
  # @!attribute [rw] project_id
1105
1239
  # @return [::String]
1106
1240
  # Required. ID of the project for which to list BuildTriggers.
@@ -1128,6 +1262,10 @@ module Google
1128
1262
  end
1129
1263
 
1130
1264
  # Request to delete a `BuildTrigger`.
1265
+ # @!attribute [rw] name
1266
+ # @return [::String]
1267
+ # The name of the `Trigger` to delete.
1268
+ # Format: `projects/{project}/locations/{location}/triggers/{trigger}`
1131
1269
  # @!attribute [rw] project_id
1132
1270
  # @return [::String]
1133
1271
  # Required. ID of the project that owns the trigger.
@@ -1192,10 +1330,14 @@ module Google
1192
1330
  # Storage.
1193
1331
  # @!attribute [rw] worker_pool
1194
1332
  # @return [::String]
1195
- # Option to specify a `WorkerPool` for the build.
1196
- # Format: projects/\\{project}/locations/\\{location}/workerPools/\\{workerPool}
1333
+ # This field deprecated; please use `pool.name` instead.
1334
+ # @!attribute [rw] pool
1335
+ # @return [::Google::Cloud::Build::V1::BuildOptions::PoolOption]
1336
+ # Optional. Specification for execution on a `WorkerPool`.
1197
1337
  #
1198
- # This field is experimental.
1338
+ # See [running builds in a private
1339
+ # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
1340
+ # for more information.
1199
1341
  # @!attribute [rw] logging
1200
1342
  # @return [::Google::Cloud::Build::V1::BuildOptions::LoggingMode]
1201
1343
  # Option to specify the logging mode, which determines if and where build
@@ -1229,6 +1371,23 @@ module Google
1229
1371
  include ::Google::Protobuf::MessageExts
1230
1372
  extend ::Google::Protobuf::MessageExts::ClassMethods
1231
1373
 
1374
+ # Details about how a build should be executed on a `WorkerPool`.
1375
+ #
1376
+ # See [running builds in a private
1377
+ # pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
1378
+ # for more information.
1379
+ # @!attribute [rw] name
1380
+ # @return [::String]
1381
+ # The `WorkerPool` resource to execute the build on.
1382
+ # You must have `cloudbuild.workerpools.use` on the project hosting the
1383
+ # WorkerPool.
1384
+ #
1385
+ # Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
1386
+ class PoolOption
1387
+ include ::Google::Protobuf::MessageExts
1388
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1389
+ end
1390
+
1232
1391
  # Specifies the manner in which the build should be verified, if at all.
1233
1392
  module VerifyOption
1234
1393
  # Not a verifiable build. (default)
@@ -1308,6 +1467,10 @@ module Google
1308
1467
 
1309
1468
  # ReceiveTriggerWebhookRequest [Experimental] is the request object accepted by
1310
1469
  # the ReceiveTriggerWebhook method.
1470
+ # @!attribute [rw] name
1471
+ # @return [::String]
1472
+ # The name of the `ReceiveTriggerWebhook` to retrieve.
1473
+ # Format: `projects/{project}/locations/{location}/triggers/{trigger}`
1311
1474
  # @!attribute [rw] body
1312
1475
  # @return [::Google::Api::HttpBody]
1313
1476
  # HTTP request body.
@@ -1332,78 +1495,77 @@ module Google
1332
1495
  extend ::Google::Protobuf::MessageExts::ClassMethods
1333
1496
  end
1334
1497
 
1335
- # Configuration for a WorkerPool to run the builds.
1498
+ # Configuration for a `WorkerPool`.
1336
1499
  #
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
1500
+ # Cloud Build owns and maintains a pool of workers for general use and have no
1501
+ # access to a project's private network. By default, builds submitted to
1502
+ # Cloud Build will use a worker from this pool.
1503
+ #
1504
+ # If your build needs access to resources on a private network,
1505
+ # create and use a `WorkerPool` to run your builds. Private `WorkerPool`s give
1506
+ # your builds access to any single VPC network that you
1507
+ # administer, including any on-prem resources connected to that VPC
1508
+ # network. For an overview of private pools, see
1509
+ # [Private pools
1510
+ # overview](https://cloud.google.com/build/docs/private-pools/private-pools-overview).
1511
+ # @!attribute [r] name
1343
1512
  # @return [::String]
1344
- # User-defined name of the `WorkerPool`.
1345
- # @!attribute [rw] project_id
1513
+ # Output only. The resource name of the `WorkerPool`, with format
1514
+ # `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
1515
+ # The value of `{worker_pool}` is provided by `worker_pool_id` in
1516
+ # `CreateWorkerPool` request and the value of `{location}` is determined by
1517
+ # the endpoint accessed.
1518
+ # @!attribute [rw] display_name
1346
1519
  # @return [::String]
1347
- # The project ID of the GCP project for which the `WorkerPool` is created.
1348
- # @!attribute [rw] service_account_email
1520
+ # A user-specified, human-readable name for the `WorkerPool`. If provided,
1521
+ # this value must be 1-63 characters.
1522
+ # @!attribute [r] uid
1349
1523
  # @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
1524
+ # Output only. A unique identifier for the `WorkerPool`.
1525
+ # @!attribute [rw] annotations
1526
+ # @return [::Google::Protobuf::Map{::String => ::String}]
1527
+ # User specified annotations. See https://google.aip.dev/128#annotations
1528
+ # for more details such as format and size limitations.
1529
+ # @!attribute [r] create_time
1367
1530
  # @return [::Google::Protobuf::Timestamp]
1368
1531
  # Output only. Time at which the request to create the `WorkerPool` was
1369
1532
  # received.
1370
- # @!attribute [rw] update_time
1533
+ # @!attribute [r] update_time
1371
1534
  # @return [::Google::Protobuf::Timestamp]
1372
1535
  # Output only. Time at which the request to update the `WorkerPool` was
1373
1536
  # received.
1374
- # @!attribute [rw] delete_time
1537
+ # @!attribute [r] delete_time
1375
1538
  # @return [::Google::Protobuf::Timestamp]
1376
1539
  # Output only. Time at which the request to delete the `WorkerPool` was
1377
1540
  # received.
1378
- # @!attribute [rw] status
1379
- # @return [::Google::Cloud::Build::V1::WorkerPool::Status]
1380
- # Output only. WorkerPool Status.
1541
+ # @!attribute [r] state
1542
+ # @return [::Google::Cloud::Build::V1::WorkerPool::State]
1543
+ # Output only. `WorkerPool` state.
1544
+ # @!attribute [rw] private_pool_v1_config
1545
+ # @return [::Google::Cloud::Build::V1::PrivatePoolV1Config]
1546
+ # Private Pool using a v1 configuration.
1547
+ # @!attribute [r] etag
1548
+ # @return [::String]
1549
+ # Output only. Checksum computed by the server. May be sent on update and
1550
+ # delete requests to ensure that the client has an up-to-date value before
1551
+ # proceeding.
1381
1552
  class WorkerPool
1382
1553
  include ::Google::Protobuf::MessageExts
1383
1554
  extend ::Google::Protobuf::MessageExts::ClassMethods
1384
1555
 
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
1556
+ # @!attribute [rw] key
1557
+ # @return [::String]
1558
+ # @!attribute [rw] value
1559
+ # @return [::String]
1560
+ class AnnotationsEntry
1561
+ include ::Google::Protobuf::MessageExts
1562
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1401
1563
  end
1402
1564
 
1403
- # `WorkerPool` status
1404
- module Status
1405
- # Status of the `WorkerPool` is unknown.
1406
- STATUS_UNSPECIFIED = 0
1565
+ # State of the `WorkerPool`.
1566
+ module State
1567
+ # State of the `WorkerPool` is unknown.
1568
+ STATE_UNSPECIFIED = 0
1407
1569
 
1408
1570
  # `WorkerPool` is being created.
1409
1571
  CREATING = 1
@@ -1419,71 +1581,90 @@ module Google
1419
1581
  end
1420
1582
  end
1421
1583
 
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
1584
+ # Configuration for a V1 `PrivatePool`.
1585
+ # @!attribute [rw] worker_config
1586
+ # @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::WorkerConfig]
1587
+ # Machine configuration for the workers in the pool.
1588
+ # @!attribute [rw] network_config
1589
+ # @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig]
1590
+ # Network configuration for the pool.
1591
+ class PrivatePoolV1Config
1455
1592
  include ::Google::Protobuf::MessageExts
1456
1593
  extend ::Google::Protobuf::MessageExts::ClassMethods
1457
- end
1458
1594
 
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
1595
+ # Defines the configuration to be used for creating workers in
1596
+ # the pool.
1597
+ # @!attribute [rw] machine_type
1598
+ # @return [::String]
1599
+ # Machine type of a worker, such as `e2-medium`.
1600
+ # See [Worker pool config
1601
+ # file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
1602
+ # If left blank, Cloud Build will use a sensible default.
1603
+ # @!attribute [rw] disk_size_gb
1604
+ # @return [::Integer]
1605
+ # Size of the disk attached to the worker, in GB.
1606
+ # See [Worker pool config
1607
+ # file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
1608
+ # Specify a value of up to 1000. If `0` is specified, Cloud Build will use
1609
+ # a standard disk size.
1610
+ class WorkerConfig
1611
+ include ::Google::Protobuf::MessageExts
1612
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1613
+ end
1614
+
1615
+ # Defines the network configuration for the pool.
1616
+ # @!attribute [rw] peered_network
1617
+ # @return [::String]
1618
+ # Required. Immutable. The network definition that the workers are peered
1619
+ # to. If this section is left empty, the workers will be peered to
1620
+ # `WorkerPool.project_id` on the service producer network. Must be in the
1621
+ # format `projects/{project}/global/networks/{network}`, where `{project}`
1622
+ # is a project number, such as `12345`, and `{network}` is the name of a
1623
+ # VPC network in the project. See
1624
+ # [Understanding network configuration
1625
+ # options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment)
1626
+ # @!attribute [rw] egress_option
1627
+ # @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig::EgressOption]
1628
+ # Option to configure network egress for the workers.
1629
+ class NetworkConfig
1630
+ include ::Google::Protobuf::MessageExts
1631
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1632
+
1633
+ # Defines the egress option for the pool.
1634
+ module EgressOption
1635
+ # If set, defaults to PUBLIC_EGRESS.
1636
+ EGRESS_OPTION_UNSPECIFIED = 0
1637
+
1638
+ # If set, workers are created without any public address, which prevents
1639
+ # network egress to public IPs unless a network proxy is configured.
1640
+ NO_PUBLIC_EGRESS = 1
1641
+
1642
+ # If set, workers are created with a public address which allows for
1643
+ # public internet egress.
1644
+ PUBLIC_EGRESS = 2
1645
+ end
1646
+ end
1478
1647
  end
1479
1648
 
1480
1649
  # Request to create a new `WorkerPool`.
1481
1650
  # @!attribute [rw] parent
1482
1651
  # @return [::String]
1483
- # ID of the parent project.
1652
+ # Required. The parent resource where this worker pool will be created.
1653
+ # Format: `projects/{project}/locations/{location}`.
1484
1654
  # @!attribute [rw] worker_pool
1485
1655
  # @return [::Google::Cloud::Build::V1::WorkerPool]
1486
- # `WorkerPool` resource to create.
1656
+ # Required. `WorkerPool` resource to create.
1657
+ # @!attribute [rw] worker_pool_id
1658
+ # @return [::String]
1659
+ # Required. Immutable. The ID to use for the `WorkerPool`, which will become
1660
+ # the final component of the resource name.
1661
+ #
1662
+ # This value should be 1-63 characters, and valid characters
1663
+ # are /[a-z][0-9]-/.
1664
+ # @!attribute [rw] validate_only
1665
+ # @return [::Boolean]
1666
+ # If set, validate the request and preview the response, but do not actually
1667
+ # post it.
1487
1668
  class CreateWorkerPoolRequest
1488
1669
  include ::Google::Protobuf::MessageExts
1489
1670
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1492,8 +1673,8 @@ module Google
1492
1673
  # Request to get a `WorkerPool` with the specified name.
1493
1674
  # @!attribute [rw] name
1494
1675
  # @return [::String]
1495
- # The field will contain name of the resource requested, for example:
1496
- # "projects/project-1/workerPools/workerpool-name"
1676
+ # Required. The name of the `WorkerPool` to retrieve.
1677
+ # Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`.
1497
1678
  class GetWorkerPoolRequest
1498
1679
  include ::Google::Protobuf::MessageExts
1499
1680
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1502,30 +1683,58 @@ module Google
1502
1683
  # Request to delete a `WorkerPool`.
1503
1684
  # @!attribute [rw] name
1504
1685
  # @return [::String]
1505
- # The field will contain name of the resource requested, for example:
1506
- # "projects/project-1/workerPools/workerpool-name"
1686
+ # Required. The name of the `WorkerPool` to delete.
1687
+ # Format:
1688
+ # `projects/{project}/locations/{workerPool}/workerPools/{workerPool}`.
1689
+ # @!attribute [rw] etag
1690
+ # @return [::String]
1691
+ # Optional. If this is provided, it must match the server's etag on the
1692
+ # workerpool for the request to be processed.
1693
+ # @!attribute [rw] allow_missing
1694
+ # @return [::Boolean]
1695
+ # If set to true, and the `WorkerPool` is not found, the request will succeed
1696
+ # but no action will be taken on the server.
1697
+ # @!attribute [rw] validate_only
1698
+ # @return [::Boolean]
1699
+ # If set, validate the request and preview the response, but do not actually
1700
+ # post it.
1507
1701
  class DeleteWorkerPoolRequest
1508
1702
  include ::Google::Protobuf::MessageExts
1509
1703
  extend ::Google::Protobuf::MessageExts::ClassMethods
1510
1704
  end
1511
1705
 
1512
1706
  # 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
1707
  # @!attribute [rw] worker_pool
1518
1708
  # @return [::Google::Cloud::Build::V1::WorkerPool]
1519
- # `WorkerPool` resource to update.
1709
+ # Required. The `WorkerPool` to update.
1710
+ #
1711
+ # The `name` field is used to identify the `WorkerPool` to update.
1712
+ # Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`.
1713
+ # @!attribute [rw] update_mask
1714
+ # @return [::Google::Protobuf::FieldMask]
1715
+ # A mask specifying which fields in `worker_pool` to update.
1716
+ # @!attribute [rw] validate_only
1717
+ # @return [::Boolean]
1718
+ # If set, validate the request and preview the response, but do not actually
1719
+ # post it.
1520
1720
  class UpdateWorkerPoolRequest
1521
1721
  include ::Google::Protobuf::MessageExts
1522
1722
  extend ::Google::Protobuf::MessageExts::ClassMethods
1523
1723
  end
1524
1724
 
1525
- # Request to list `WorkerPools`.
1725
+ # Request to list `WorkerPool`s.
1526
1726
  # @!attribute [rw] parent
1527
1727
  # @return [::String]
1528
- # ID of the parent project.
1728
+ # Required. The parent of the collection of `WorkerPools`.
1729
+ # Format: `projects/{project}/locations/{location}`.
1730
+ # @!attribute [rw] page_size
1731
+ # @return [::Integer]
1732
+ # The maximum number of `WorkerPool`s to return. The service may return
1733
+ # fewer than this value. If omitted, the server will use a sensible default.
1734
+ # @!attribute [rw] page_token
1735
+ # @return [::String]
1736
+ # A page token, received from a previous `ListWorkerPools` call. Provide this
1737
+ # to retrieve the subsequent page.
1529
1738
  class ListWorkerPoolsRequest
1530
1739
  include ::Google::Protobuf::MessageExts
1531
1740
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1534,11 +1743,67 @@ module Google
1534
1743
  # Response containing existing `WorkerPools`.
1535
1744
  # @!attribute [rw] worker_pools
1536
1745
  # @return [::Array<::Google::Cloud::Build::V1::WorkerPool>]
1537
- # `WorkerPools` for the project.
1746
+ # `WorkerPools` for the specified project.
1747
+ # @!attribute [rw] next_page_token
1748
+ # @return [::String]
1749
+ # Continuation token used to page through large result sets. Provide this
1750
+ # value in a subsequent ListWorkerPoolsRequest to return the next page of
1751
+ # results.
1538
1752
  class ListWorkerPoolsResponse
1539
1753
  include ::Google::Protobuf::MessageExts
1540
1754
  extend ::Google::Protobuf::MessageExts::ClassMethods
1541
1755
  end
1756
+
1757
+ # Metadata for the `CreateWorkerPool` operation.
1758
+ # @!attribute [rw] worker_pool
1759
+ # @return [::String]
1760
+ # The resource name of the `WorkerPool` to create.
1761
+ # Format:
1762
+ # `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
1763
+ # @!attribute [rw] create_time
1764
+ # @return [::Google::Protobuf::Timestamp]
1765
+ # Time the operation was created.
1766
+ # @!attribute [rw] complete_time
1767
+ # @return [::Google::Protobuf::Timestamp]
1768
+ # Time the operation was completed.
1769
+ class CreateWorkerPoolOperationMetadata
1770
+ include ::Google::Protobuf::MessageExts
1771
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1772
+ end
1773
+
1774
+ # Metadata for the `UpdateWorkerPool` operation.
1775
+ # @!attribute [rw] worker_pool
1776
+ # @return [::String]
1777
+ # The resource name of the `WorkerPool` being updated.
1778
+ # Format:
1779
+ # `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
1780
+ # @!attribute [rw] create_time
1781
+ # @return [::Google::Protobuf::Timestamp]
1782
+ # Time the operation was created.
1783
+ # @!attribute [rw] complete_time
1784
+ # @return [::Google::Protobuf::Timestamp]
1785
+ # Time the operation was completed.
1786
+ class UpdateWorkerPoolOperationMetadata
1787
+ include ::Google::Protobuf::MessageExts
1788
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1789
+ end
1790
+
1791
+ # Metadata for the `DeleteWorkerPool` operation.
1792
+ # @!attribute [rw] worker_pool
1793
+ # @return [::String]
1794
+ # The resource name of the `WorkerPool` being deleted.
1795
+ # Format:
1796
+ # `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
1797
+ # @!attribute [rw] create_time
1798
+ # @return [::Google::Protobuf::Timestamp]
1799
+ # Time the operation was created.
1800
+ # @!attribute [rw] complete_time
1801
+ # @return [::Google::Protobuf::Timestamp]
1802
+ # Time the operation was completed.
1803
+ class DeleteWorkerPoolOperationMetadata
1804
+ include ::Google::Protobuf::MessageExts
1805
+ extend ::Google::Protobuf::MessageExts::ClassMethods
1806
+ end
1542
1807
  end
1543
1808
  end
1544
1809
  end