WorkerPool (Cloud Build API v1-rev20240427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudbuild.v1.model.WorkerPool

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class WorkerPool
extends com.google.api.client.json.GenericJson
```
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 `WorkerPool`s 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](https://cloud.google.com/build/docs/private-pools/private-pools-overview).
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Build API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

WorkerPool()

Constructors
Constructor and Description
`WorkerPool()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkerPool`	`clone()`
`Map<String,String>`	`getAnnotations()` User specified annotations.
`String`	`getCreateTime()` Output only.
`String`	`getDeleteTime()` Output only.
`String`	`getDisplayName()` A user-specified, human-readable name for the `WorkerPool`.
`String`	`getEtag()` Output only.
`String`	`getName()` Output only.
`PrivatePoolV1Config`	`getPrivatePoolV1Config()` Legacy Private Pool configuration.
`String`	`getState()` Output only.
`String`	`getUid()` Output only.
`String`	`getUpdateTime()` Output only.
`WorkerPool`	`set(String fieldName, Object value)`
`WorkerPool`	`setAnnotations(Map<String,String> annotations)` User specified annotations.
`WorkerPool`	`setCreateTime(String createTime)` Output only.
`WorkerPool`	`setDeleteTime(String deleteTime)` Output only.
`WorkerPool`	`setDisplayName(String displayName)` A user-specified, human-readable name for the `WorkerPool`.
`WorkerPool`	`setEtag(String etag)` Output only.
`WorkerPool`	`setName(String name)` Output only.
`WorkerPool`	`setPrivatePoolV1Config(PrivatePoolV1Config privatePoolV1Config)` Legacy Private Pool configuration.
`WorkerPool`	`setState(String state)` Output only.
`WorkerPool`	`setUid(String uid)` Output only.
`WorkerPool`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - WorkerPool
```
public WorkerPool()
```
- Method Detail
  - getAnnotations
```
public Map<String,String> getAnnotations()
```
    User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
    
    Returns:
    
    value or null for none
  - setAnnotations
```
public WorkerPool setAnnotations(Map<String,String> annotations)
```
    User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
    
    Parameters:
    
    annotations - annotations or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. Time at which the request to create the `WorkerPool` was received.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public WorkerPool setCreateTime(String createTime)
```
    Output only. Time at which the request to create the `WorkerPool` was received.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDeleteTime
```
public String getDeleteTime()
```
    Output only. Time at which the request to delete the `WorkerPool` was received.
    
    Returns:
    
    value or null for none
  - setDeleteTime
```
public WorkerPool setDeleteTime(String deleteTime)
```
    Output only. Time at which the request to delete the `WorkerPool` was received.
    
    Parameters:
    
    deleteTime - deleteTime or null for none
  - getDisplayName
```
public String getDisplayName()
```
    A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public WorkerPool setDisplayName(String displayName)
```
    A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters.
    
    Parameters:
    
    displayName - displayName or null for none
  - getEtag
```
public String getEtag()
```
    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:
    
    value or null for none
  - setEtag
```
public WorkerPool setEtag(String etag)
```
    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.
    
    Parameters:
    
    etag - etag or null for none
  - getName
```
public String getName()
```
    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:
    
    value or null for none
  - setName
```
public WorkerPool setName(String name)
```
    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.
    
    Parameters:
    
    name - name or null for none
  - getPrivatePoolV1Config
```
public PrivatePoolV1Config getPrivatePoolV1Config()
```
    Legacy Private Pool configuration.
    
    Returns:
    
    value or null for none
  - setPrivatePoolV1Config
```
public WorkerPool setPrivatePoolV1Config(PrivatePoolV1Config privatePoolV1Config)
```
    Legacy Private Pool configuration.
    
    Parameters:
    
    privatePoolV1Config - privatePoolV1Config or null for none
  - getState
```
public String getState()
```
    Output only. `WorkerPool` state.
    
    Returns:
    
    value or null for none
  - setState
```
public WorkerPool setState(String state)
```
    Output only. `WorkerPool` state.
    
    Parameters:
    
    state - state or null for none
  - getUid
```
public String getUid()
```
    Output only. A unique identifier for the `WorkerPool`.
    
    Returns:
    
    value or null for none
  - setUid
```
public WorkerPool setUid(String uid)
```
    Output only. A unique identifier for the `WorkerPool`.
    
    Parameters:
    
    uid - uid or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. Time at which the request to update the `WorkerPool` was received.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public WorkerPool setUpdateTime(String updateTime)
```
    Output only. Time at which the request to update the `WorkerPool` was received.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public WorkerPool set(String fieldName,
                      Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public WorkerPool clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class WorkerPool

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

WorkerPool

Method Detail

getAnnotations

setAnnotations

getCreateTime

setCreateTime

getDeleteTime

setDeleteTime

getDisplayName

setDisplayName

getEtag

setEtag

getName

setName

getPrivatePoolV1Config

setPrivatePoolV1Config

getState

setState

getUid

setUid

getUpdateTime

setUpdateTime

set

clone