1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudbuild_v1alpha2.html">Cloud Build API</a> . <a href="cloudbuild_v1alpha2.projects.html">projects</a> . <a href="cloudbuild_v1alpha2.projects.workerPools.html">workerPools</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, workerPoolId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a `WorkerPool` to run the builds, and returns the new worker pool.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a `WorkerPool`.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Returns details of a `WorkerPool`.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists `WorkerPool`s by project.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates a `WorkerPool`.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(parent, body=None, workerPoolId=None, x__xgafv=None)</code> 103 <pre>Creates a `WorkerPool` to run the builds, and returns the new worker pool. 104 105Args: 106 parent: string, Required. The parent resource where this book will be created. Format: projects/{project} (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # 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. 111 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 112 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 113 "name": "A String", # Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. 114 "networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`. 115 "peeredNetwork": "A 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 default 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. 116 }, 117 "region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. 118 "state": "A String", # Output only. WorkerPool state. 119 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 120 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`. 121 "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. 122 "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. 123 }, 124} 125 126 workerPoolId: string, Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. 127 x__xgafv: string, V1 error format. 128 Allowed values 129 1 - v1 error format 130 2 - v2 error format 131 132Returns: 133 An object of the form: 134 135 { # 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. 136 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 137 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 138 "name": "A String", # Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. 139 "networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`. 140 "peeredNetwork": "A 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 default 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. 141 }, 142 "region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. 143 "state": "A String", # Output only. WorkerPool state. 144 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 145 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`. 146 "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. 147 "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. 148 }, 149}</pre> 150</div> 151 152<div class="method"> 153 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 154 <pre>Deletes a `WorkerPool`. 155 156Args: 157 name: string, Required. The name of the `WorkerPool` to delete. Format: projects/{project}/workerPools/{workerPool} (required) 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 167}</pre> 168</div> 169 170<div class="method"> 171 <code class="details" id="get">get(name, x__xgafv=None)</code> 172 <pre>Returns details of a `WorkerPool`. 173 174Args: 175 name: string, Required. The name of the `WorkerPool` to retrieve. Format: projects/{project}/workerPools/{workerPool} (required) 176 x__xgafv: string, V1 error format. 177 Allowed values 178 1 - v1 error format 179 2 - v2 error format 180 181Returns: 182 An object of the form: 183 184 { # 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. 185 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 186 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 187 "name": "A String", # Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. 188 "networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`. 189 "peeredNetwork": "A 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 default 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. 190 }, 191 "region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. 192 "state": "A String", # Output only. WorkerPool state. 193 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 194 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`. 195 "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. 196 "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. 197 }, 198}</pre> 199</div> 200 201<div class="method"> 202 <code class="details" id="list">list(parent, x__xgafv=None)</code> 203 <pre>Lists `WorkerPool`s by project. 204 205Args: 206 parent: string, Required. The parent, which owns this collection of `WorkerPools`. Format: projects/{project} (required) 207 x__xgafv: string, V1 error format. 208 Allowed values 209 1 - v1 error format 210 2 - v2 error format 211 212Returns: 213 An object of the form: 214 215 { # Response containing existing `WorkerPools`. 216 "workerPools": [ # `WorkerPools` for the specified project. 217 { # 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. 218 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 219 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 220 "name": "A String", # Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. 221 "networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`. 222 "peeredNetwork": "A 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 default 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. 223 }, 224 "region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. 225 "state": "A String", # Output only. WorkerPool state. 226 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 227 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`. 228 "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. 229 "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. 230 }, 231 }, 232 ], 233}</pre> 234</div> 235 236<div class="method"> 237 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 238 <pre>Updates a `WorkerPool`. 239 240Args: 241 name: string, Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. (required) 242 body: object, The request body. 243 The object takes the form of: 244 245{ # 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. 246 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 247 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 248 "name": "A String", # Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. 249 "networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`. 250 "peeredNetwork": "A 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 default 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. 251 }, 252 "region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. 253 "state": "A String", # Output only. WorkerPool state. 254 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 255 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`. 256 "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. 257 "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. 258 }, 259} 260 261 updateMask: string, A mask specifying which fields in `WorkerPool` should be updated. 262 x__xgafv: string, V1 error format. 263 Allowed values 264 1 - v1 error format 265 2 - v2 error format 266 267Returns: 268 An object of the form: 269 270 { # 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. 271 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 272 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 273 "name": "A String", # Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. 274 "networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`. 275 "peeredNetwork": "A 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 default 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. 276 }, 277 "region": "A String", # Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. 278 "state": "A String", # Output only. WorkerPool state. 279 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 280 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`. 281 "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. 282 "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. 283 }, 284}</pre> 285</div> 286 287</body></html>