Show / Hide Table of Contents

Class WorkerPool

Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.

Inheritance
System.Object
WorkerPool
Implements
IDirectResponseSchema
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.CloudBuild.v1alpha1.Data
Assembly: Google.Apis.CloudBuild.v1alpha1.dll
Syntax
public class WorkerPool : IDirectResponseSchema

Properties

CreateTime

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

Declaration
[JsonProperty("createTime")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
System.Object

DeleteTime

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

Declaration
[JsonProperty("deleteTime")]
public virtual object DeleteTime { get; set; }
Property Value
Type Description
System.Object

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
System.String

Name

User-defined name of the WorkerPool.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
System.String

ProjectId

The project ID of the GCP project for which the WorkerPool is created.

Declaration
[JsonProperty("projectId")]
public virtual string ProjectId { get; set; }
Property Value
Type Description
System.String

Regions

List of regions to create the WorkerPool. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing WorkerPool will not be enabled in the new region automatically; you must add the new region to the regions field to enable the WorkerPool in that region.

Declaration
[JsonProperty("regions")]
public virtual IList<string> Regions { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<System.String>

ServiceAccountEmail

Output only. The service account used to manage the WorkerPool. The service account must have the Compute Instance Admin (Beta) permission at the project level.

Declaration
[JsonProperty("serviceAccountEmail")]
public virtual string ServiceAccountEmail { get; set; }
Property Value
Type Description
System.String

Status

Output only. WorkerPool Status.

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
System.String

UpdateTime

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

Declaration
[JsonProperty("updateTime")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
System.Object

WorkerConfig

Configuration to be used for a creating workers in the WorkerPool.

Declaration
[JsonProperty("workerConfig")]
public virtual WorkerConfig WorkerConfig { get; set; }
Property Value
Type Description
WorkerConfig

WorkerCount

Total number of workers to be created across all requested regions.

Declaration
[JsonProperty("workerCount")]
public virtual long? WorkerCount { get; set; }
Property Value
Type Description
System.Nullable<System.Int64>

Implements

IDirectResponseSchema
In This Article
Back to top Generated by DocFX