Class: Google::Cloud::Build::V1::PrivatePoolV1Config

Inherits:

Object

• Object
• Google::Cloud::Build::V1::PrivatePoolV1Config

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb

Overview

Configuration for a V1 PrivatePool.

Defined Under Namespace

Classes: NetworkConfig, PrivateServiceConnect, WorkerConfig

Instance Attribute Summary

• #network_config ⇒ ::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig

  Network configuration for the pool.

• #private_service_connect ⇒ ::Google::Cloud::Build::V1::PrivatePoolV1Config::PrivateServiceConnect

  Immutable.

• #worker_config ⇒ ::Google::Cloud::Build::V1::PrivatePoolV1Config::WorkerConfig

  Machine configuration for the workers in the pool.

Instance Attribute Details

#network_config ⇒ ::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig

Returns Network configuration for the pool.

Returns:

• (::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig) —

  Network configuration for the pool.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2183

class PrivatePoolV1Config
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the configuration to be used for creating workers in
  # the pool.
  # @!attribute [rw] machine_type
  #   @return [::String]
  #     Machine type of a worker, such as `e2-medium`.
  #     See [Worker pool config
  #     file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
  #     If left blank, Cloud Build will use a sensible default.
  # @!attribute [rw] disk_size_gb
  #   @return [::Integer]
  #     Size of the disk attached to the worker, in GB.
  #     See [Worker pool config
  #     file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
  #     Specify a value of up to 2000. If `0` is specified, Cloud Build will use
  #     a standard disk size.
  class WorkerConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the network configuration for the pool.
  # @!attribute [rw] peered_network
  #   @return [::String]
  #     Required. Immutable. The network definition that the workers are peered
  #     to. If this section is left empty, the workers will be peered to
  #     `WorkerPool.project_id` on the service producer network. Must be in the
  #     format `projects/{project}/global/networks/{network}`, where `{project}`
  #     is a project number, such as `12345`, and `{network}` is the name of a
  #     VPC network in the project. See
  #     [Understanding network configuration
  #     options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment)
  # @!attribute [rw] egress_option
  #   @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig::EgressOption]
  #     Option to configure network egress for the workers.
  # @!attribute [rw] peered_network_ip_range
  #   @return [::String]
  #     Immutable. Subnet IP range within the peered network. This is specified
  #     in CIDR notation with a slash and the subnet prefix size. You can
  #     optionally specify an IP address before the subnet prefix value. e.g.
  #     `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a
  #     prefix size of 29 bits.
  #     `/16` would specify a prefix size of 16 bits, with an automatically
  #     determined IP within the peered VPC.
  #     If unspecified, a value of `/24` will be used.
  class NetworkConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines the egress option for the pool.
    module EgressOption
      # If set, defaults to PUBLIC_EGRESS.
      EGRESS_OPTION_UNSPECIFIED = 0

      # If set, workers are created without any public address, which prevents
      # network egress to public IPs unless a network proxy is configured.
      NO_PUBLIC_EGRESS = 1

      # If set, workers are created with a public address which allows for
      # public internet egress.
      PUBLIC_EGRESS = 2
    end
  end

  # Defines the Private Service Connect network configuration for the pool.
  # @!attribute [rw] network_attachment
  #   @return [::String]
  #     Required. Immutable. The network attachment that the worker network
  #     interface is peered to. Must be in the format
  #     `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`.
  #     The region of network attachment must be the same as the worker pool.
  #     See [Network
  #     Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)
  # @!attribute [rw] public_ip_address_disabled
  #   @return [::Boolean]
  #     Required. Immutable. Disable public IP on the primary network interface.
  #
  #     If true, workers are created without any public address, which prevents
  #     network egress to public IPs unless a network proxy is configured.
  #     If false, workers are created with a public address which allows for
  #     public internet egress. The public address only applies to traffic
  #     through the primary network interface.
  #     If `route_all_traffic` is set to true, all traffic will go through the
  #     non-primary network interface, this boolean has no effect.
  # @!attribute [rw] route_all_traffic
  #   @return [::Boolean]
  #     Immutable. Route all traffic through PSC interface. Enable this if you
  #     want full control of traffic in the private pool. Configure Cloud NAT for
  #     the subnet of network attachment if you need to access public Internet.
  #
  #     If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and
  #     192.168.0.0/16 through PSC interface.
  class PrivateServiceConnect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#private_service_connect ⇒ ::Google::Cloud::Build::V1::PrivatePoolV1Config::PrivateServiceConnect

Returns Immutable. Private Service Connect(PSC) Network configuration for the pool.

Returns:

• (::Google::Cloud::Build::V1::PrivatePoolV1Config::PrivateServiceConnect) —

  Immutable. Private Service Connect(PSC) Network configuration for the pool.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2183

class PrivatePoolV1Config
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the configuration to be used for creating workers in
  # the pool.
  # @!attribute [rw] machine_type
  #   @return [::String]
  #     Machine type of a worker, such as `e2-medium`.
  #     See [Worker pool config
  #     file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
  #     If left blank, Cloud Build will use a sensible default.
  # @!attribute [rw] disk_size_gb
  #   @return [::Integer]
  #     Size of the disk attached to the worker, in GB.
  #     See [Worker pool config
  #     file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
  #     Specify a value of up to 2000. If `0` is specified, Cloud Build will use
  #     a standard disk size.
  class WorkerConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the network configuration for the pool.
  # @!attribute [rw] peered_network
  #   @return [::String]
  #     Required. Immutable. The network definition that the workers are peered
  #     to. If this section is left empty, the workers will be peered to
  #     `WorkerPool.project_id` on the service producer network. Must be in the
  #     format `projects/{project}/global/networks/{network}`, where `{project}`
  #     is a project number, such as `12345`, and `{network}` is the name of a
  #     VPC network in the project. See
  #     [Understanding network configuration
  #     options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment)
  # @!attribute [rw] egress_option
  #   @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig::EgressOption]
  #     Option to configure network egress for the workers.
  # @!attribute [rw] peered_network_ip_range
  #   @return [::String]
  #     Immutable. Subnet IP range within the peered network. This is specified
  #     in CIDR notation with a slash and the subnet prefix size. You can
  #     optionally specify an IP address before the subnet prefix value. e.g.
  #     `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a
  #     prefix size of 29 bits.
  #     `/16` would specify a prefix size of 16 bits, with an automatically
  #     determined IP within the peered VPC.
  #     If unspecified, a value of `/24` will be used.
  class NetworkConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines the egress option for the pool.
    module EgressOption
      # If set, defaults to PUBLIC_EGRESS.
      EGRESS_OPTION_UNSPECIFIED = 0

      # If set, workers are created without any public address, which prevents
      # network egress to public IPs unless a network proxy is configured.
      NO_PUBLIC_EGRESS = 1

      # If set, workers are created with a public address which allows for
      # public internet egress.
      PUBLIC_EGRESS = 2
    end
  end

  # Defines the Private Service Connect network configuration for the pool.
  # @!attribute [rw] network_attachment
  #   @return [::String]
  #     Required. Immutable. The network attachment that the worker network
  #     interface is peered to. Must be in the format
  #     `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`.
  #     The region of network attachment must be the same as the worker pool.
  #     See [Network
  #     Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)
  # @!attribute [rw] public_ip_address_disabled
  #   @return [::Boolean]
  #     Required. Immutable. Disable public IP on the primary network interface.
  #
  #     If true, workers are created without any public address, which prevents
  #     network egress to public IPs unless a network proxy is configured.
  #     If false, workers are created with a public address which allows for
  #     public internet egress. The public address only applies to traffic
  #     through the primary network interface.
  #     If `route_all_traffic` is set to true, all traffic will go through the
  #     non-primary network interface, this boolean has no effect.
  # @!attribute [rw] route_all_traffic
  #   @return [::Boolean]
  #     Immutable. Route all traffic through PSC interface. Enable this if you
  #     want full control of traffic in the private pool. Configure Cloud NAT for
  #     the subnet of network attachment if you need to access public Internet.
  #
  #     If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and
  #     192.168.0.0/16 through PSC interface.
  class PrivateServiceConnect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#worker_config ⇒ ::Google::Cloud::Build::V1::PrivatePoolV1Config::WorkerConfig

Returns Machine configuration for the workers in the pool.

Returns:

• (::Google::Cloud::Build::V1::PrivatePoolV1Config::WorkerConfig) —

  Machine configuration for the workers in the pool.

# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2183

class PrivatePoolV1Config
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the configuration to be used for creating workers in
  # the pool.
  # @!attribute [rw] machine_type
  #   @return [::String]
  #     Machine type of a worker, such as `e2-medium`.
  #     See [Worker pool config
  #     file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
  #     If left blank, Cloud Build will use a sensible default.
  # @!attribute [rw] disk_size_gb
  #   @return [::Integer]
  #     Size of the disk attached to the worker, in GB.
  #     See [Worker pool config
  #     file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema).
  #     Specify a value of up to 2000. If `0` is specified, Cloud Build will use
  #     a standard disk size.
  class WorkerConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Defines the network configuration for the pool.
  # @!attribute [rw] peered_network
  #   @return [::String]
  #     Required. Immutable. The network definition that the workers are peered
  #     to. If this section is left empty, the workers will be peered to
  #     `WorkerPool.project_id` on the service producer network. Must be in the
  #     format `projects/{project}/global/networks/{network}`, where `{project}`
  #     is a project number, such as `12345`, and `{network}` is the name of a
  #     VPC network in the project. See
  #     [Understanding network configuration
  #     options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment)
  # @!attribute [rw] egress_option
  #   @return [::Google::Cloud::Build::V1::PrivatePoolV1Config::NetworkConfig::EgressOption]
  #     Option to configure network egress for the workers.
  # @!attribute [rw] peered_network_ip_range
  #   @return [::String]
  #     Immutable. Subnet IP range within the peered network. This is specified
  #     in CIDR notation with a slash and the subnet prefix size. You can
  #     optionally specify an IP address before the subnet prefix value. e.g.
  #     `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a
  #     prefix size of 29 bits.
  #     `/16` would specify a prefix size of 16 bits, with an automatically
  #     determined IP within the peered VPC.
  #     If unspecified, a value of `/24` will be used.
  class NetworkConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Defines the egress option for the pool.
    module EgressOption
      # If set, defaults to PUBLIC_EGRESS.
      EGRESS_OPTION_UNSPECIFIED = 0

      # If set, workers are created without any public address, which prevents
      # network egress to public IPs unless a network proxy is configured.
      NO_PUBLIC_EGRESS = 1

      # If set, workers are created with a public address which allows for
      # public internet egress.
      PUBLIC_EGRESS = 2
    end
  end

  # Defines the Private Service Connect network configuration for the pool.
  # @!attribute [rw] network_attachment
  #   @return [::String]
  #     Required. Immutable. The network attachment that the worker network
  #     interface is peered to. Must be in the format
  #     `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`.
  #     The region of network attachment must be the same as the worker pool.
  #     See [Network
  #     Attachments](https://cloud.google.com/vpc/docs/about-network-attachments)
  # @!attribute [rw] public_ip_address_disabled
  #   @return [::Boolean]
  #     Required. Immutable. Disable public IP on the primary network interface.
  #
  #     If true, workers are created without any public address, which prevents
  #     network egress to public IPs unless a network proxy is configured.
  #     If false, workers are created with a public address which allows for
  #     public internet egress. The public address only applies to traffic
  #     through the primary network interface.
  #     If `route_all_traffic` is set to true, all traffic will go through the
  #     non-primary network interface, this boolean has no effect.
  # @!attribute [rw] route_all_traffic
  #   @return [::Boolean]
  #     Immutable. Route all traffic through PSC interface. Enable this if you
  #     want full control of traffic in the private pool. Configure Cloud NAT for
  #     the subnet of network attachment if you need to access public Internet.
  #
  #     If false, Only route private IPs, e.g. 10.0.0.0/8, 172.16.0.0/12, and
  #     192.168.0.0/16 through PSC interface.
  class PrivateServiceConnect
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end