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_v1alpha1.html">Cloud Build API</a> . <a href="cloudbuild_v1alpha1.projects.html">projects</a> . <a href="cloudbuild_v1alpha1.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, 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` by its project ID and WorkerPool name.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Returns information about 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">List project's `WorkerPool`s.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Update 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, x__xgafv=None)</code> 103 <pre>Creates a `WorkerPool` to run the builds, and returns the new worker pool. 104 105Args: 106 parent: string, ID of the parent 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", # User-defined name of the `WorkerPool`. 114 "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created. 115 "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. 116 "A String", 117 ], 118 "serviceAccountEmail": "A String", # 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. 119 "status": "A String", # Output only. WorkerPool Status. 120 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 121 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`. 122 "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. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions 123 "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. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes 124 "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network. 125 "network": "A String", # Network on which the workers are created. "default" network is used if empty. 126 "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id. 127 "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty. 128 }, 129 "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`. 130 }, 131 "workerCount": "A String", # Total number of workers to be created across all requested regions. 132} 133 134 x__xgafv: string, V1 error format. 135 Allowed values 136 1 - v1 error format 137 2 - v2 error format 138 139Returns: 140 An object of the form: 141 142 { # 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. 143 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 144 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 145 "name": "A String", # User-defined name of the `WorkerPool`. 146 "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created. 147 "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. 148 "A String", 149 ], 150 "serviceAccountEmail": "A String", # 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. 151 "status": "A String", # Output only. WorkerPool Status. 152 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 153 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`. 154 "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. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions 155 "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. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes 156 "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network. 157 "network": "A String", # Network on which the workers are created. "default" network is used if empty. 158 "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id. 159 "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty. 160 }, 161 "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`. 162 }, 163 "workerCount": "A String", # Total number of workers to be created across all requested regions. 164}</pre> 165</div> 166 167<div class="method"> 168 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 169 <pre>Deletes a `WorkerPool` by its project ID and WorkerPool name. 170 171Args: 172 name: string, The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" (required) 173 x__xgafv: string, V1 error format. 174 Allowed values 175 1 - v1 error format 176 2 - v2 error format 177 178Returns: 179 An object of the form: 180 181 { # 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 `{}`. 182}</pre> 183</div> 184 185<div class="method"> 186 <code class="details" id="get">get(name, x__xgafv=None)</code> 187 <pre>Returns information about a `WorkerPool`. 188 189Args: 190 name: string, The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" (required) 191 x__xgafv: string, V1 error format. 192 Allowed values 193 1 - v1 error format 194 2 - v2 error format 195 196Returns: 197 An object of the form: 198 199 { # 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. 200 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 201 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 202 "name": "A String", # User-defined name of the `WorkerPool`. 203 "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created. 204 "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. 205 "A String", 206 ], 207 "serviceAccountEmail": "A String", # 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. 208 "status": "A String", # Output only. WorkerPool Status. 209 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 210 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`. 211 "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. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions 212 "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. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes 213 "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network. 214 "network": "A String", # Network on which the workers are created. "default" network is used if empty. 215 "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id. 216 "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty. 217 }, 218 "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`. 219 }, 220 "workerCount": "A String", # Total number of workers to be created across all requested regions. 221}</pre> 222</div> 223 224<div class="method"> 225 <code class="details" id="list">list(parent, x__xgafv=None)</code> 226 <pre>List project's `WorkerPool`s. 227 228Args: 229 parent: string, ID of the parent project. (required) 230 x__xgafv: string, V1 error format. 231 Allowed values 232 1 - v1 error format 233 2 - v2 error format 234 235Returns: 236 An object of the form: 237 238 { # Response containing existing `WorkerPools`. 239 "workerPools": [ # `WorkerPools` for the project. 240 { # 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. 241 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 242 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 243 "name": "A String", # User-defined name of the `WorkerPool`. 244 "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created. 245 "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. 246 "A String", 247 ], 248 "serviceAccountEmail": "A String", # 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. 249 "status": "A String", # Output only. WorkerPool Status. 250 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 251 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`. 252 "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. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions 253 "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. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes 254 "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network. 255 "network": "A String", # Network on which the workers are created. "default" network is used if empty. 256 "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id. 257 "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty. 258 }, 259 "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`. 260 }, 261 "workerCount": "A String", # Total number of workers to be created across all requested regions. 262 }, 263 ], 264}</pre> 265</div> 266 267<div class="method"> 268 <code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code> 269 <pre>Update a `WorkerPool`. 270 271Args: 272 name: string, The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" (required) 273 body: object, The request body. 274 The object takes the form of: 275 276{ # 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. 277 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 278 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 279 "name": "A String", # User-defined name of the `WorkerPool`. 280 "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created. 281 "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. 282 "A String", 283 ], 284 "serviceAccountEmail": "A String", # 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. 285 "status": "A String", # Output only. WorkerPool Status. 286 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 287 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`. 288 "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. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions 289 "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. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes 290 "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network. 291 "network": "A String", # Network on which the workers are created. "default" network is used if empty. 292 "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id. 293 "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty. 294 }, 295 "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`. 296 }, 297 "workerCount": "A String", # Total number of workers to be created across all requested regions. 298} 299 300 x__xgafv: string, V1 error format. 301 Allowed values 302 1 - v1 error format 303 2 - v2 error format 304 305Returns: 306 An object of the form: 307 308 { # 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. 309 "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received. 310 "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received. 311 "name": "A String", # User-defined name of the `WorkerPool`. 312 "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created. 313 "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. 314 "A String", 315 ], 316 "serviceAccountEmail": "A String", # 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. 317 "status": "A String", # Output only. WorkerPool Status. 318 "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received. 319 "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`. 320 "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. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions 321 "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. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes 322 "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network. 323 "network": "A String", # Network on which the workers are created. "default" network is used if empty. 324 "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id. 325 "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty. 326 }, 327 "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`. 328 }, 329 "workerCount": "A String", # Total number of workers to be created across all requested regions. 330}</pre> 331</div> 332 333</body></html>