287 lines
21 KiB
HTML
287 lines
21 KiB
HTML
<html><body>
|
|
<style>
|
|
|
|
body, h1, h2, h3, div, span, p, pre, a {
|
|
margin: 0;
|
|
padding: 0;
|
|
border: 0;
|
|
font-weight: inherit;
|
|
font-style: inherit;
|
|
font-size: 100%;
|
|
font-family: inherit;
|
|
vertical-align: baseline;
|
|
}
|
|
|
|
body {
|
|
font-size: 13px;
|
|
padding: 1em;
|
|
}
|
|
|
|
h1 {
|
|
font-size: 26px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h2 {
|
|
font-size: 24px;
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
h3 {
|
|
font-size: 20px;
|
|
margin-bottom: 1em;
|
|
margin-top: 1em;
|
|
}
|
|
|
|
pre, code {
|
|
line-height: 1.5;
|
|
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
|
|
}
|
|
|
|
pre {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
h1, h2, h3, p {
|
|
font-family: Arial, sans serif;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: solid #CCC 1px;
|
|
}
|
|
|
|
.toc_element {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
.firstline {
|
|
margin-left: 2 em;
|
|
}
|
|
|
|
.method {
|
|
margin-top: 1em;
|
|
border: solid 1px #CCC;
|
|
padding: 1em;
|
|
background: #EEE;
|
|
}
|
|
|
|
.details {
|
|
font-weight: bold;
|
|
font-size: 14px;
|
|
}
|
|
|
|
</style>
|
|
|
|
<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>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#close">close()</a></code></p>
|
|
<p class="firstline">Close httplib2 connections.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#create">create(parent, body=None, workerPoolId=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Creates a `WorkerPool` to run the builds, and returns the new worker pool.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Deletes a `WorkerPool`.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Returns details of a `WorkerPool`.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Lists `WorkerPool`s by project.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates a `WorkerPool`.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="close">close()</code>
|
|
<pre>Close httplib2 connections.</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="create">create(parent, body=None, workerPoolId=None, x__xgafv=None)</code>
|
|
<pre>Creates a `WorkerPool` to run the builds, and returns the new worker pool.
|
|
|
|
Args:
|
|
parent: string, Required. The parent resource where this book will be created. Format: projects/{project} (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # 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.
|
|
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
|
|
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
|
|
"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.
|
|
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
|
|
"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.
|
|
},
|
|
"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.
|
|
"state": "A String", # Output only. WorkerPool state.
|
|
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
|
|
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`.
|
|
"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.
|
|
"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.
|
|
},
|
|
}
|
|
|
|
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-/.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # 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.
|
|
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
|
|
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
|
|
"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.
|
|
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
|
|
"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.
|
|
},
|
|
"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.
|
|
"state": "A String", # Output only. WorkerPool state.
|
|
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
|
|
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`.
|
|
"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.
|
|
"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.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
|
|
<pre>Deletes a `WorkerPool`.
|
|
|
|
Args:
|
|
name: string, Required. The name of the `WorkerPool` to delete. Format: projects/{project}/workerPools/{workerPool} (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # 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 `{}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(name, x__xgafv=None)</code>
|
|
<pre>Returns details of a `WorkerPool`.
|
|
|
|
Args:
|
|
name: string, Required. The name of the `WorkerPool` to retrieve. Format: projects/{project}/workerPools/{workerPool} (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # 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.
|
|
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
|
|
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
|
|
"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.
|
|
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
|
|
"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.
|
|
},
|
|
"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.
|
|
"state": "A String", # Output only. WorkerPool state.
|
|
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
|
|
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`.
|
|
"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.
|
|
"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.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(parent, x__xgafv=None)</code>
|
|
<pre>Lists `WorkerPool`s by project.
|
|
|
|
Args:
|
|
parent: string, Required. The parent, which owns this collection of `WorkerPools`. Format: projects/{project} (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response containing existing `WorkerPools`.
|
|
"workerPools": [ # `WorkerPools` for the specified project.
|
|
{ # 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.
|
|
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
|
|
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
|
|
"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.
|
|
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
|
|
"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.
|
|
},
|
|
"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.
|
|
"state": "A String", # Output only. WorkerPool state.
|
|
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
|
|
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`.
|
|
"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.
|
|
"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.
|
|
},
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
|
|
<pre>Updates a `WorkerPool`.
|
|
|
|
Args:
|
|
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)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # 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.
|
|
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
|
|
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
|
|
"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.
|
|
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
|
|
"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.
|
|
},
|
|
"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.
|
|
"state": "A String", # Output only. WorkerPool state.
|
|
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
|
|
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`.
|
|
"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.
|
|
"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.
|
|
},
|
|
}
|
|
|
|
updateMask: string, A mask specifying which fields in `WorkerPool` should be updated.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # 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.
|
|
"createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
|
|
"deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
|
|
"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.
|
|
"networkConfig": { # Network describes the network configuration for a `WorkerPool`. # Network configuration for the `WorkerPool`.
|
|
"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.
|
|
},
|
|
"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.
|
|
"state": "A String", # Output only. WorkerPool state.
|
|
"updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
|
|
"workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Worker configuration for the `WorkerPool`.
|
|
"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.
|
|
"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.
|
|
},
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |