google-cloud-build-v1 0.8.1 → 0.10.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/build/v1/cloud_build/client.rb +256 -89
- data/lib/google/cloud/build/v1/cloud_build/operations.rb +30 -21
- data/lib/google/cloud/build/v1/cloud_build/paths.rb +36 -0
- data/lib/google/cloud/build/v1/version.rb +1 -1
- data/lib/google/devtools/cloudbuild/v1/cloudbuild_pb.rb +122 -33
- data/lib/google/devtools/cloudbuild/v1/cloudbuild_services_pb.rb +15 -18
- data/proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb +393 -124
- metadata +4 -4
@@ -471,12 +471,17 @@ module Google
|
|
471
471
|
# Output only. Stores timing information for phases of the build. Valid keys
|
472
472
|
# are:
|
473
473
|
#
|
474
|
-
# * BUILD: time to execute all build steps
|
474
|
+
# * BUILD: time to execute all build steps.
|
475
475
|
# * PUSH: time to push all specified images.
|
476
476
|
# * FETCHSOURCE: time to fetch source.
|
477
|
+
# * SETUPBUILD: time to set up build.
|
477
478
|
#
|
478
479
|
# If the build does not specify source or images,
|
479
480
|
# these keys will not be included.
|
481
|
+
# @!attribute [r] approval
|
482
|
+
# @return [::Google::Cloud::Build::V1::BuildApproval]
|
483
|
+
# Output only. Describes this build's approval configuration, status,
|
484
|
+
# and result.
|
480
485
|
# @!attribute [rw] service_account
|
481
486
|
# @return [::String]
|
482
487
|
# IAM service account whose credentials will be used at build runtime.
|
@@ -489,6 +494,9 @@ module Google
|
|
489
494
|
# @return [::Array<::Google::Cloud::Build::V1::Build::Warning>]
|
490
495
|
# Output only. Non-fatal problems encountered during the execution of the
|
491
496
|
# build.
|
497
|
+
# @!attribute [r] failure_info
|
498
|
+
# @return [::Google::Cloud::Build::V1::Build::FailureInfo]
|
499
|
+
# Output only. Contains information about the build when status=FAILURE.
|
492
500
|
class Build
|
493
501
|
include ::Google::Protobuf::MessageExts
|
494
502
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -520,6 +528,43 @@ module Google
|
|
520
528
|
end
|
521
529
|
end
|
522
530
|
|
531
|
+
# A fatal problem encountered during the execution of the build.
|
532
|
+
# @!attribute [rw] type
|
533
|
+
# @return [::Google::Cloud::Build::V1::Build::FailureInfo::FailureType]
|
534
|
+
# The name of the failure.
|
535
|
+
# @!attribute [rw] detail
|
536
|
+
# @return [::String]
|
537
|
+
# Explains the failure issue in more detail using hard-coded text.
|
538
|
+
class FailureInfo
|
539
|
+
include ::Google::Protobuf::MessageExts
|
540
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
541
|
+
|
542
|
+
# The name of a fatal problem encountered during the execution of the
|
543
|
+
# build.
|
544
|
+
module FailureType
|
545
|
+
# Type unspecified
|
546
|
+
FAILURE_TYPE_UNSPECIFIED = 0
|
547
|
+
|
548
|
+
# Unable to push the image to the repository.
|
549
|
+
PUSH_FAILED = 1
|
550
|
+
|
551
|
+
# Final image not found.
|
552
|
+
PUSH_IMAGE_NOT_FOUND = 2
|
553
|
+
|
554
|
+
# Unauthorized push of the final image.
|
555
|
+
PUSH_NOT_AUTHORIZED = 3
|
556
|
+
|
557
|
+
# Backend logging failures. Should retry.
|
558
|
+
LOGGING_FAILURE = 4
|
559
|
+
|
560
|
+
# A build step has failed.
|
561
|
+
USER_BUILD_STEP = 5
|
562
|
+
|
563
|
+
# The source fetching has failed.
|
564
|
+
FETCH_SOURCE_FAILED = 6
|
565
|
+
end
|
566
|
+
end
|
567
|
+
|
523
568
|
# @!attribute [rw] key
|
524
569
|
# @return [::String]
|
525
570
|
# @!attribute [rw] value
|
@@ -543,6 +588,10 @@ module Google
|
|
543
588
|
# Status of the build is unknown.
|
544
589
|
STATUS_UNKNOWN = 0
|
545
590
|
|
591
|
+
# Build has been created and is pending execution and queuing. It has not
|
592
|
+
# been queued.
|
593
|
+
PENDING = 10
|
594
|
+
|
546
595
|
# Build or step is queued; work has not yet begun.
|
547
596
|
QUEUED = 1
|
548
597
|
|
@@ -894,6 +943,103 @@ module Google
|
|
894
943
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
895
944
|
end
|
896
945
|
|
946
|
+
# Request to approve or reject a pending build.
|
947
|
+
# @!attribute [rw] name
|
948
|
+
# @return [::String]
|
949
|
+
# Required. Name of the target build.
|
950
|
+
# For example: "projects/\\{$project_id}/builds/\\{$build_id}"
|
951
|
+
# @!attribute [rw] approval_result
|
952
|
+
# @return [::Google::Cloud::Build::V1::ApprovalResult]
|
953
|
+
# Approval decision and metadata.
|
954
|
+
class ApproveBuildRequest
|
955
|
+
include ::Google::Protobuf::MessageExts
|
956
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
957
|
+
end
|
958
|
+
|
959
|
+
# BuildApproval describes a build's approval configuration, state, and
|
960
|
+
# result.
|
961
|
+
# @!attribute [r] state
|
962
|
+
# @return [::Google::Cloud::Build::V1::BuildApproval::State]
|
963
|
+
# Output only. The state of this build's approval.
|
964
|
+
# @!attribute [r] config
|
965
|
+
# @return [::Google::Cloud::Build::V1::ApprovalConfig]
|
966
|
+
# Output only. Configuration for manual approval of this build.
|
967
|
+
# @!attribute [r] result
|
968
|
+
# @return [::Google::Cloud::Build::V1::ApprovalResult]
|
969
|
+
# Output only. Result of manual approval for this Build.
|
970
|
+
class BuildApproval
|
971
|
+
include ::Google::Protobuf::MessageExts
|
972
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
973
|
+
|
974
|
+
# Specifies the current state of a build's approval.
|
975
|
+
module State
|
976
|
+
# Default enum type. This should not be used.
|
977
|
+
STATE_UNSPECIFIED = 0
|
978
|
+
|
979
|
+
# Build approval is pending.
|
980
|
+
PENDING = 1
|
981
|
+
|
982
|
+
# Build approval has been approved.
|
983
|
+
APPROVED = 2
|
984
|
+
|
985
|
+
# Build approval has been rejected.
|
986
|
+
REJECTED = 3
|
987
|
+
|
988
|
+
# Build was cancelled while it was still pending approval.
|
989
|
+
CANCELLED = 5
|
990
|
+
end
|
991
|
+
end
|
992
|
+
|
993
|
+
# ApprovalConfig describes configuration for manual approval of a build.
|
994
|
+
# @!attribute [rw] approval_required
|
995
|
+
# @return [::Boolean]
|
996
|
+
# Whether or not approval is needed. If this is set on a build, it will
|
997
|
+
# become pending when created, and will need to be explicitly approved
|
998
|
+
# to start.
|
999
|
+
class ApprovalConfig
|
1000
|
+
include ::Google::Protobuf::MessageExts
|
1001
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1002
|
+
end
|
1003
|
+
|
1004
|
+
# ApprovalResult describes the decision and associated metadata of a manual
|
1005
|
+
# approval of a build.
|
1006
|
+
# @!attribute [r] approver_account
|
1007
|
+
# @return [::String]
|
1008
|
+
# Output only. Email of the user that called the ApproveBuild API to
|
1009
|
+
# approve or reject a build at the time that the API was called.
|
1010
|
+
# @!attribute [r] approval_time
|
1011
|
+
# @return [::Google::Protobuf::Timestamp]
|
1012
|
+
# Output only. The time when the approval decision was made.
|
1013
|
+
# @!attribute [rw] decision
|
1014
|
+
# @return [::Google::Cloud::Build::V1::ApprovalResult::Decision]
|
1015
|
+
# Required. The decision of this manual approval.
|
1016
|
+
# @!attribute [rw] comment
|
1017
|
+
# @return [::String]
|
1018
|
+
# Optional. An optional comment for this manual approval result.
|
1019
|
+
# @!attribute [rw] url
|
1020
|
+
# @return [::String]
|
1021
|
+
# Optional. An optional URL tied to this manual approval result. This field
|
1022
|
+
# is essentially the same as comment, except that it will be rendered by the
|
1023
|
+
# UI differently. An example use case is a link to an external job that
|
1024
|
+
# approved this Build.
|
1025
|
+
class ApprovalResult
|
1026
|
+
include ::Google::Protobuf::MessageExts
|
1027
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1028
|
+
|
1029
|
+
# Specifies whether or not this manual approval result is to approve
|
1030
|
+
# or reject a build.
|
1031
|
+
module Decision
|
1032
|
+
# Default enum type. This should not be used.
|
1033
|
+
DECISION_UNSPECIFIED = 0
|
1034
|
+
|
1035
|
+
# Build is approved.
|
1036
|
+
APPROVED = 1
|
1037
|
+
|
1038
|
+
# Build is rejected.
|
1039
|
+
REJECTED = 2
|
1040
|
+
end
|
1041
|
+
end
|
1042
|
+
|
897
1043
|
# Configuration for an automated build in response to source repository
|
898
1044
|
# changes.
|
899
1045
|
# @!attribute [rw] resource_name
|
@@ -1290,10 +1436,14 @@ module Google
|
|
1290
1436
|
# Storage.
|
1291
1437
|
# @!attribute [rw] worker_pool
|
1292
1438
|
# @return [::String]
|
1293
|
-
#
|
1294
|
-
#
|
1439
|
+
# This field deprecated; please use `pool.name` instead.
|
1440
|
+
# @!attribute [rw] pool
|
1441
|
+
# @return [::Google::Cloud::Build::V1::BuildOptions::PoolOption]
|
1442
|
+
# Optional. Specification for execution on a `WorkerPool`.
|
1295
1443
|
#
|
1296
|
-
#
|
1444
|
+
# See [running builds in a private
|
1445
|
+
# pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
|
1446
|
+
# for more information.
|
1297
1447
|
# @!attribute [rw] logging
|
1298
1448
|
# @return [::Google::Cloud::Build::V1::BuildOptions::LoggingMode]
|
1299
1449
|
# Option to specify the logging mode, which determines if and where build
|
@@ -1327,6 +1477,23 @@ module Google
|
|
1327
1477
|
include ::Google::Protobuf::MessageExts
|
1328
1478
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1329
1479
|
|
1480
|
+
# Details about how a build should be executed on a `WorkerPool`.
|
1481
|
+
#
|
1482
|
+
# See [running builds in a private
|
1483
|
+
# pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
|
1484
|
+
# for more information.
|
1485
|
+
# @!attribute [rw] name
|
1486
|
+
# @return [::String]
|
1487
|
+
# The `WorkerPool` resource to execute the build on.
|
1488
|
+
# You must have `cloudbuild.workerpools.use` on the project hosting the
|
1489
|
+
# WorkerPool.
|
1490
|
+
#
|
1491
|
+
# Format projects/\\{project}/locations/\\{location}/workerPools/\\{workerPoolId}
|
1492
|
+
class PoolOption
|
1493
|
+
include ::Google::Protobuf::MessageExts
|
1494
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1495
|
+
end
|
1496
|
+
|
1330
1497
|
# Specifies the manner in which the build should be verified, if at all.
|
1331
1498
|
module VerifyOption
|
1332
1499
|
# Not a verifiable build. (default)
|
@@ -1434,78 +1601,77 @@ module Google
|
|
1434
1601
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1435
1602
|
end
|
1436
1603
|
|
1437
|
-
# Configuration for a WorkerPool
|
1604
|
+
# Configuration for a `WorkerPool`.
|
1438
1605
|
#
|
1439
|
-
#
|
1440
|
-
#
|
1441
|
-
#
|
1442
|
-
#
|
1443
|
-
#
|
1444
|
-
#
|
1606
|
+
# Cloud Build owns and maintains a pool of workers for general use and have no
|
1607
|
+
# access to a project's private network. By default, builds submitted to
|
1608
|
+
# Cloud Build will use a worker from this pool.
|
1609
|
+
#
|
1610
|
+
# If your build needs access to resources on a private network,
|
1611
|
+
# create and use a `WorkerPool` to run your builds. Private `WorkerPool`s give
|
1612
|
+
# your builds access to any single VPC network that you
|
1613
|
+
# administer, including any on-prem resources connected to that VPC
|
1614
|
+
# network. For an overview of private pools, see
|
1615
|
+
# [Private pools
|
1616
|
+
# overview](https://cloud.google.com/build/docs/private-pools/private-pools-overview).
|
1617
|
+
# @!attribute [r] name
|
1445
1618
|
# @return [::String]
|
1446
|
-
#
|
1447
|
-
#
|
1619
|
+
# Output only. The resource name of the `WorkerPool`, with format
|
1620
|
+
# `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
|
1621
|
+
# The value of `{worker_pool}` is provided by `worker_pool_id` in
|
1622
|
+
# `CreateWorkerPool` request and the value of `{location}` is determined by
|
1623
|
+
# the endpoint accessed.
|
1624
|
+
# @!attribute [rw] display_name
|
1448
1625
|
# @return [::String]
|
1449
|
-
#
|
1450
|
-
#
|
1626
|
+
# A user-specified, human-readable name for the `WorkerPool`. If provided,
|
1627
|
+
# this value must be 1-63 characters.
|
1628
|
+
# @!attribute [r] uid
|
1451
1629
|
# @return [::String]
|
1452
|
-
# Output only.
|
1453
|
-
#
|
1454
|
-
#
|
1455
|
-
#
|
1456
|
-
#
|
1457
|
-
#
|
1458
|
-
# @!attribute [rw] worker_config
|
1459
|
-
# @return [::Google::Cloud::Build::V1::WorkerConfig]
|
1460
|
-
# Configuration to be used for a creating workers in the `WorkerPool`.
|
1461
|
-
# @!attribute [rw] regions
|
1462
|
-
# @return [::Array<::Google::Cloud::Build::V1::WorkerPool::Region>]
|
1463
|
-
# List of regions to create the `WorkerPool`. Regions can't be empty.
|
1464
|
-
# If Cloud Build adds a new GCP region in the future, the existing
|
1465
|
-
# `WorkerPool` will not be enabled in the new region automatically;
|
1466
|
-
# you must add the new region to the `regions` field to enable the
|
1467
|
-
# `WorkerPool` in that region.
|
1468
|
-
# @!attribute [rw] create_time
|
1630
|
+
# Output only. A unique identifier for the `WorkerPool`.
|
1631
|
+
# @!attribute [rw] annotations
|
1632
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
1633
|
+
# User specified annotations. See https://google.aip.dev/128#annotations
|
1634
|
+
# for more details such as format and size limitations.
|
1635
|
+
# @!attribute [r] create_time
|
1469
1636
|
# @return [::Google::Protobuf::Timestamp]
|
1470
1637
|
# Output only. Time at which the request to create the `WorkerPool` was
|
1471
1638
|
# received.
|
1472
|
-
# @!attribute [
|
1639
|
+
# @!attribute [r] update_time
|
1473
1640
|
# @return [::Google::Protobuf::Timestamp]
|
1474
1641
|
# Output only. Time at which the request to update the `WorkerPool` was
|
1475
1642
|
# received.
|
1476
|
-
# @!attribute [
|
1643
|
+
# @!attribute [r] delete_time
|
1477
1644
|
# @return [::Google::Protobuf::Timestamp]
|
1478
1645
|
# Output only. Time at which the request to delete the `WorkerPool` was
|
1479
1646
|
# received.
|
1480
|
-
# @!attribute [
|
1481
|
-
# @return [::Google::Cloud::Build::V1::WorkerPool::
|
1482
|
-
# Output only. WorkerPool
|
1647
|
+
# @!attribute [r] state
|
1648
|
+
# @return [::Google::Cloud::Build::V1::WorkerPool::State]
|
1649
|
+
# Output only. `WorkerPool` state.
|
1650
|
+
# @!attribute [rw] private_pool_v1_config
|
1651
|
+
# @return [::Google::Cloud::Build::V1::PrivatePoolV1Config]
|
1652
|
+
# Private Pool using a v1 configuration.
|
1653
|
+
# @!attribute [r] etag
|
1654
|
+
# @return [::String]
|
1655
|
+
# Output only. Checksum computed by the server. May be sent on update and
|
1656
|
+
# delete requests to ensure that the client has an up-to-date value before
|
1657
|
+
# proceeding.
|
1483
1658
|
class WorkerPool
|
1484
1659
|
include ::Google::Protobuf::MessageExts
|
1485
1660
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1486
1661
|
|
1487
|
-
#
|
1488
|
-
|
1489
|
-
|
1490
|
-
|
1491
|
-
|
1492
|
-
|
1493
|
-
|
1494
|
-
|
1495
|
-
# us-west1 region
|
1496
|
-
US_WEST1 = 2
|
1497
|
-
|
1498
|
-
# us-east1 region
|
1499
|
-
US_EAST1 = 3
|
1500
|
-
|
1501
|
-
# us-east4 region
|
1502
|
-
US_EAST4 = 4
|
1662
|
+
# @!attribute [rw] key
|
1663
|
+
# @return [::String]
|
1664
|
+
# @!attribute [rw] value
|
1665
|
+
# @return [::String]
|
1666
|
+
class AnnotationsEntry
|
1667
|
+
include ::Google::Protobuf::MessageExts
|
1668
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1503
1669
|
end
|
1504
1670
|
|
1505
|
-
# `WorkerPool
|
1506
|
-
module
|
1507
|
-
#
|
1508
|
-
|
1671
|
+
# State of the `WorkerPool`.
|
1672
|
+
module State
|
1673
|
+
# State of the `WorkerPool` is unknown.
|
1674
|
+
STATE_UNSPECIFIED = 0
|
1509
1675
|
|
1510
1676
|
# `WorkerPool` is being created.
|
1511
1677
|
CREATING = 1
|
@@ -1521,71 +1687,90 @@ module Google
|
|
1521
1687
|
end
|
1522
1688
|
end
|
1523
1689
|
|
1524
|
-
#
|
1525
|
-
#
|
1526
|
-
#
|
1527
|
-
#
|
1528
|
-
#
|
1529
|
-
#
|
1530
|
-
#
|
1531
|
-
|
1532
|
-
# `machine_type` is overridden if you specify a different machine type in
|
1533
|
-
# `build_options`. In this case, the VM specified in the `build_options`
|
1534
|
-
# will be created on demand at build time. For more information see
|
1535
|
-
# https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
|
1536
|
-
# @!attribute [rw] disk_size_gb
|
1537
|
-
# @return [::Integer]
|
1538
|
-
# Size of the disk attached to the worker, in GB.
|
1539
|
-
# See https://cloud.google.com/compute/docs/disks/
|
1540
|
-
# If `0` is specified, Cloud Build will use a standard disk size.
|
1541
|
-
# `disk_size` is overridden if you specify a different disk size in
|
1542
|
-
# `build_options`. In this case, a VM with a disk size specified in the
|
1543
|
-
# `build_options` will be created on demand at build time. For more
|
1544
|
-
# information see
|
1545
|
-
# https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
|
1546
|
-
# @!attribute [rw] network
|
1547
|
-
# @return [::Google::Cloud::Build::V1::Network]
|
1548
|
-
# The network definition used to create the worker.
|
1549
|
-
# If this section is left empty, the workers will be created in
|
1550
|
-
# WorkerPool.project_id on the default network.
|
1551
|
-
# @!attribute [rw] tag
|
1552
|
-
# @return [::String]
|
1553
|
-
# The tag applied to the worker, and the same tag used by the firewall rule.
|
1554
|
-
# It is used to identify the Cloud Build workers among other VMs.
|
1555
|
-
# The default value for tag is `worker`.
|
1556
|
-
class WorkerConfig
|
1690
|
+
# Configuration for a V1 `PrivatePool`.
|
1691
|
+
# @!attribute [rw] worker_config
|
1692
|
+
# @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::WorkerConfig]
|
1693
|
+
# Machine configuration for the workers in the pool.
|
1694
|
+
# @!attribute [rw] network_config
|
1695
|
+
# @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig]
|
1696
|
+
# Network configuration for the pool.
|
1697
|
+
class PrivatePoolV1Config
|
1557
1698
|
include ::Google::Protobuf::MessageExts
|
1558
1699
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1559
|
-
end
|
1560
1700
|
|
1561
|
-
|
1562
|
-
|
1563
|
-
|
1564
|
-
|
1565
|
-
|
1566
|
-
|
1567
|
-
|
1568
|
-
|
1569
|
-
|
1570
|
-
|
1571
|
-
|
1572
|
-
|
1573
|
-
|
1574
|
-
|
1575
|
-
|
1576
|
-
|
1577
|
-
|
1578
|
-
|
1579
|
-
|
1701
|
+
# Defines the configuration to be used for creating workers in
|
1702
|
+
# the pool.
|
1703
|
+
# @!attribute [rw] machine_type
|
1704
|
+
# @return [::String]
|
1705
|
+
# Machine type of a worker, such as `e2-medium`.
|
1706
|
+
# See [Worker pool config
|
1707
|
+
# file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
|
1708
|
+
# If left blank, Cloud Build will use a sensible default.
|
1709
|
+
# @!attribute [rw] disk_size_gb
|
1710
|
+
# @return [::Integer]
|
1711
|
+
# Size of the disk attached to the worker, in GB.
|
1712
|
+
# See [Worker pool config
|
1713
|
+
# file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
|
1714
|
+
# Specify a value of up to 1000. If `0` is specified, Cloud Build will use
|
1715
|
+
# a standard disk size.
|
1716
|
+
class WorkerConfig
|
1717
|
+
include ::Google::Protobuf::MessageExts
|
1718
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1719
|
+
end
|
1720
|
+
|
1721
|
+
# Defines the network configuration for the pool.
|
1722
|
+
# @!attribute [rw] peered_network
|
1723
|
+
# @return [::String]
|
1724
|
+
# Required. Immutable. The network definition that the workers are peered
|
1725
|
+
# to. If this section is left empty, the workers will be peered to
|
1726
|
+
# `WorkerPool.project_id` on the service producer network. Must be in the
|
1727
|
+
# format `projects/{project}/global/networks/{network}`, where `{project}`
|
1728
|
+
# is a project number, such as `12345`, and `{network}` is the name of a
|
1729
|
+
# VPC network in the project. See
|
1730
|
+
# [Understanding network configuration
|
1731
|
+
# options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment)
|
1732
|
+
# @!attribute [rw] egress_option
|
1733
|
+
# @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig::EgressOption]
|
1734
|
+
# Option to configure network egress for the workers.
|
1735
|
+
class NetworkConfig
|
1736
|
+
include ::Google::Protobuf::MessageExts
|
1737
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1738
|
+
|
1739
|
+
# Defines the egress option for the pool.
|
1740
|
+
module EgressOption
|
1741
|
+
# If set, defaults to PUBLIC_EGRESS.
|
1742
|
+
EGRESS_OPTION_UNSPECIFIED = 0
|
1743
|
+
|
1744
|
+
# If set, workers are created without any public address, which prevents
|
1745
|
+
# network egress to public IPs unless a network proxy is configured.
|
1746
|
+
NO_PUBLIC_EGRESS = 1
|
1747
|
+
|
1748
|
+
# If set, workers are created with a public address which allows for
|
1749
|
+
# public internet egress.
|
1750
|
+
PUBLIC_EGRESS = 2
|
1751
|
+
end
|
1752
|
+
end
|
1580
1753
|
end
|
1581
1754
|
|
1582
1755
|
# Request to create a new `WorkerPool`.
|
1583
1756
|
# @!attribute [rw] parent
|
1584
1757
|
# @return [::String]
|
1585
|
-
#
|
1758
|
+
# Required. The parent resource where this worker pool will be created.
|
1759
|
+
# Format: `projects/{project}/locations/{location}`.
|
1586
1760
|
# @!attribute [rw] worker_pool
|
1587
1761
|
# @return [::Google::Cloud::Build::V1::WorkerPool]
|
1588
|
-
# `WorkerPool` resource to create.
|
1762
|
+
# Required. `WorkerPool` resource to create.
|
1763
|
+
# @!attribute [rw] worker_pool_id
|
1764
|
+
# @return [::String]
|
1765
|
+
# Required. Immutable. The ID to use for the `WorkerPool`, which will become
|
1766
|
+
# the final component of the resource name.
|
1767
|
+
#
|
1768
|
+
# This value should be 1-63 characters, and valid characters
|
1769
|
+
# are /[a-z][0-9]-/.
|
1770
|
+
# @!attribute [rw] validate_only
|
1771
|
+
# @return [::Boolean]
|
1772
|
+
# If set, validate the request and preview the response, but do not actually
|
1773
|
+
# post it.
|
1589
1774
|
class CreateWorkerPoolRequest
|
1590
1775
|
include ::Google::Protobuf::MessageExts
|
1591
1776
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1594,8 +1779,8 @@ module Google
|
|
1594
1779
|
# Request to get a `WorkerPool` with the specified name.
|
1595
1780
|
# @!attribute [rw] name
|
1596
1781
|
# @return [::String]
|
1597
|
-
# The
|
1598
|
-
#
|
1782
|
+
# Required. The name of the `WorkerPool` to retrieve.
|
1783
|
+
# Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`.
|
1599
1784
|
class GetWorkerPoolRequest
|
1600
1785
|
include ::Google::Protobuf::MessageExts
|
1601
1786
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1604,30 +1789,58 @@ module Google
|
|
1604
1789
|
# Request to delete a `WorkerPool`.
|
1605
1790
|
# @!attribute [rw] name
|
1606
1791
|
# @return [::String]
|
1607
|
-
# The
|
1608
|
-
#
|
1792
|
+
# Required. The name of the `WorkerPool` to delete.
|
1793
|
+
# Format:
|
1794
|
+
# `projects/{project}/locations/{workerPool}/workerPools/{workerPool}`.
|
1795
|
+
# @!attribute [rw] etag
|
1796
|
+
# @return [::String]
|
1797
|
+
# Optional. If this is provided, it must match the server's etag on the
|
1798
|
+
# workerpool for the request to be processed.
|
1799
|
+
# @!attribute [rw] allow_missing
|
1800
|
+
# @return [::Boolean]
|
1801
|
+
# If set to true, and the `WorkerPool` is not found, the request will succeed
|
1802
|
+
# but no action will be taken on the server.
|
1803
|
+
# @!attribute [rw] validate_only
|
1804
|
+
# @return [::Boolean]
|
1805
|
+
# If set, validate the request and preview the response, but do not actually
|
1806
|
+
# post it.
|
1609
1807
|
class DeleteWorkerPoolRequest
|
1610
1808
|
include ::Google::Protobuf::MessageExts
|
1611
1809
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1612
1810
|
end
|
1613
1811
|
|
1614
1812
|
# Request to update a `WorkerPool`.
|
1615
|
-
# @!attribute [rw] name
|
1616
|
-
# @return [::String]
|
1617
|
-
# The field will contain name of the resource requested, for example:
|
1618
|
-
# "projects/project-1/workerPools/workerpool-name"
|
1619
1813
|
# @!attribute [rw] worker_pool
|
1620
1814
|
# @return [::Google::Cloud::Build::V1::WorkerPool]
|
1621
|
-
# `WorkerPool`
|
1815
|
+
# Required. The `WorkerPool` to update.
|
1816
|
+
#
|
1817
|
+
# The `name` field is used to identify the `WorkerPool` to update.
|
1818
|
+
# Format: `projects/{project}/locations/{location}/workerPools/{workerPool}`.
|
1819
|
+
# @!attribute [rw] update_mask
|
1820
|
+
# @return [::Google::Protobuf::FieldMask]
|
1821
|
+
# A mask specifying which fields in `worker_pool` to update.
|
1822
|
+
# @!attribute [rw] validate_only
|
1823
|
+
# @return [::Boolean]
|
1824
|
+
# If set, validate the request and preview the response, but do not actually
|
1825
|
+
# post it.
|
1622
1826
|
class UpdateWorkerPoolRequest
|
1623
1827
|
include ::Google::Protobuf::MessageExts
|
1624
1828
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1625
1829
|
end
|
1626
1830
|
|
1627
|
-
# Request to list `
|
1831
|
+
# Request to list `WorkerPool`s.
|
1628
1832
|
# @!attribute [rw] parent
|
1629
1833
|
# @return [::String]
|
1630
|
-
#
|
1834
|
+
# Required. The parent of the collection of `WorkerPools`.
|
1835
|
+
# Format: `projects/{project}/locations/{location}`.
|
1836
|
+
# @!attribute [rw] page_size
|
1837
|
+
# @return [::Integer]
|
1838
|
+
# The maximum number of `WorkerPool`s to return. The service may return
|
1839
|
+
# fewer than this value. If omitted, the server will use a sensible default.
|
1840
|
+
# @!attribute [rw] page_token
|
1841
|
+
# @return [::String]
|
1842
|
+
# A page token, received from a previous `ListWorkerPools` call. Provide this
|
1843
|
+
# to retrieve the subsequent page.
|
1631
1844
|
class ListWorkerPoolsRequest
|
1632
1845
|
include ::Google::Protobuf::MessageExts
|
1633
1846
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1636,11 +1849,67 @@ module Google
|
|
1636
1849
|
# Response containing existing `WorkerPools`.
|
1637
1850
|
# @!attribute [rw] worker_pools
|
1638
1851
|
# @return [::Array<::Google::Cloud::Build::V1::WorkerPool>]
|
1639
|
-
# `WorkerPools` for the project.
|
1852
|
+
# `WorkerPools` for the specified project.
|
1853
|
+
# @!attribute [rw] next_page_token
|
1854
|
+
# @return [::String]
|
1855
|
+
# Continuation token used to page through large result sets. Provide this
|
1856
|
+
# value in a subsequent ListWorkerPoolsRequest to return the next page of
|
1857
|
+
# results.
|
1640
1858
|
class ListWorkerPoolsResponse
|
1641
1859
|
include ::Google::Protobuf::MessageExts
|
1642
1860
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1643
1861
|
end
|
1862
|
+
|
1863
|
+
# Metadata for the `CreateWorkerPool` operation.
|
1864
|
+
# @!attribute [rw] worker_pool
|
1865
|
+
# @return [::String]
|
1866
|
+
# The resource name of the `WorkerPool` to create.
|
1867
|
+
# Format:
|
1868
|
+
# `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
|
1869
|
+
# @!attribute [rw] create_time
|
1870
|
+
# @return [::Google::Protobuf::Timestamp]
|
1871
|
+
# Time the operation was created.
|
1872
|
+
# @!attribute [rw] complete_time
|
1873
|
+
# @return [::Google::Protobuf::Timestamp]
|
1874
|
+
# Time the operation was completed.
|
1875
|
+
class CreateWorkerPoolOperationMetadata
|
1876
|
+
include ::Google::Protobuf::MessageExts
|
1877
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1878
|
+
end
|
1879
|
+
|
1880
|
+
# Metadata for the `UpdateWorkerPool` operation.
|
1881
|
+
# @!attribute [rw] worker_pool
|
1882
|
+
# @return [::String]
|
1883
|
+
# The resource name of the `WorkerPool` being updated.
|
1884
|
+
# Format:
|
1885
|
+
# `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
|
1886
|
+
# @!attribute [rw] create_time
|
1887
|
+
# @return [::Google::Protobuf::Timestamp]
|
1888
|
+
# Time the operation was created.
|
1889
|
+
# @!attribute [rw] complete_time
|
1890
|
+
# @return [::Google::Protobuf::Timestamp]
|
1891
|
+
# Time the operation was completed.
|
1892
|
+
class UpdateWorkerPoolOperationMetadata
|
1893
|
+
include ::Google::Protobuf::MessageExts
|
1894
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1895
|
+
end
|
1896
|
+
|
1897
|
+
# Metadata for the `DeleteWorkerPool` operation.
|
1898
|
+
# @!attribute [rw] worker_pool
|
1899
|
+
# @return [::String]
|
1900
|
+
# The resource name of the `WorkerPool` being deleted.
|
1901
|
+
# Format:
|
1902
|
+
# `projects/{project}/locations/{location}/workerPools/{worker_pool}`.
|
1903
|
+
# @!attribute [rw] create_time
|
1904
|
+
# @return [::Google::Protobuf::Timestamp]
|
1905
|
+
# Time the operation was created.
|
1906
|
+
# @!attribute [rw] complete_time
|
1907
|
+
# @return [::Google::Protobuf::Timestamp]
|
1908
|
+
# Time the operation was completed.
|
1909
|
+
class DeleteWorkerPoolOperationMetadata
|
1910
|
+
include ::Google::Protobuf::MessageExts
|
1911
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1912
|
+
end
|
1644
1913
|
end
|
1645
1914
|
end
|
1646
1915
|
end
|