Class: Google::Cloud::Build::V1::WorkerPool

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb

Overview

Configuration for a WorkerPool.

Cloud Build owns and maintains a pool of workers for general use and have no access to a project's private network. By default, builds submitted to Cloud Build will use a worker from this pool.

If your build needs access to resources on a private network, create and use a WorkerPool to run your builds. Private WorkerPools give your builds access to any single VPC network that you administer, including any on-prem resources connected to that VPC network. For an overview of private pools, see Private pools overview.

Defined Under Namespace

Modules: State Classes: AnnotationsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Returns:



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time at which the request to create the WorkerPool was received.

Returns:



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time at which the request to delete the WorkerPool was received.

Returns:



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#display_name ⇒ ::String

Returns A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.

Returns:

  • (::String) —

    A user-specified, human-readable name for the WorkerPool. If provided, this value must be 1-63 characters.



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#etag ⇒ ::String (readonly)

Returns Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.

Returns:

  • (::String) —

    Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding.



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the WorkerPool, with format projects/{project}/locations/{location}/workerPools/{worker_pool}. The value of {worker_pool} is provided by worker_pool_id in CreateWorkerPool request and the value of {location} is determined by the endpoint accessed.

Returns:

  • (::String) —

    Output only. The resource name of the WorkerPool, with format projects/{project}/locations/{location}/workerPools/{worker_pool}. The value of {worker_pool} is provided by worker_pool_id in CreateWorkerPool request and the value of {location} is determined by the endpoint accessed.



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#private_pool_v1_config ⇒ ::Google::Cloud::Build::V1::PrivatePoolV1Config

Returns Legacy Private Pool configuration.

Returns:



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#state ⇒ ::Google::Cloud::Build::V1::WorkerPool::State (readonly)

Returns Output only. WorkerPool state.

Returns:



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. A unique identifier for the WorkerPool.

Returns:

  • (::String) —

    Output only. A unique identifier for the WorkerPool.



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Time at which the request to update the WorkerPool was received.

Returns:



2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'proto_docs/google/devtools/cloudbuild/v1/cloudbuild.rb', line 2138

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the `WorkerPool`.
  module State
    # State of the `WorkerPool` is unknown.
    STATE_UNSPECIFIED = 0

    # `WorkerPool` is being created.
    CREATING = 1

    # `WorkerPool` is running.
    RUNNING = 2

    # `WorkerPool` is being deleted: cancelling builds and draining workers.
    DELETING = 3

    # `WorkerPool` is deleted.
    DELETED = 4

    # `WorkerPool` is being updated; new builds cannot be run.
    UPDATING = 5
  end
end