The TargetPools API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of TargetPoolsClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
targetPoolsStub
targetPoolsStub?: Promise<{
[name: string]: Function;
}>;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
addHealthCheck(request, options)
addHealthCheck(request?: protos.google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Adds health check URLs to a target pool.
Parameters | |
---|---|
Name | Description |
request |
IAddHealthCheckTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Name of the target pool to add a health check to.
*/
// const targetPool = 'abc123'
/**
* The body resource for this request
*/
// const targetPoolsAddHealthCheckRequestResource = {}
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callAddHealthCheck() {
// Construct request
const request = {
project,
region,
targetPool,
targetPoolsAddHealthCheckRequestResource,
};
// Run request
const response = await computeClient.addHealthCheck(request);
console.log(response);
}
callAddHealthCheck();
addHealthCheck(request, options, callback)
addHealthCheck(request: protos.google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IAddHealthCheckTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
addHealthCheck(request, callback)
addHealthCheck(request: protos.google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IAddHealthCheckTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
addInstance(request, options)
addInstance(request?: protos.google.cloud.compute.v1.IAddInstanceTargetPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Adds an instance to a target pool.
Parameters | |
---|---|
Name | Description |
request |
IAddInstanceTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Name of the TargetPool resource to add instances to.
*/
// const targetPool = 'abc123'
/**
* The body resource for this request
*/
// const targetPoolsAddInstanceRequestResource = {}
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callAddInstance() {
// Construct request
const request = {
project,
region,
targetPool,
targetPoolsAddInstanceRequestResource,
};
// Run request
const response = await computeClient.addInstance(request);
console.log(response);
}
callAddInstance();
addInstance(request, options, callback)
addInstance(request: protos.google.cloud.compute.v1.IAddInstanceTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddInstanceTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IAddInstanceTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddInstanceTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
addInstance(request, callback)
addInstance(request: protos.google.cloud.compute.v1.IAddInstanceTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddInstanceTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IAddInstanceTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IAddInstanceTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
aggregatedListAsync(request, options)
aggregatedListAsync(request?: protos.google.cloud.compute.v1.IAggregatedListTargetPoolsRequest, options?: CallOptions): AsyncIterable<[
string,
protos.google.cloud.compute.v1.ITargetPoolsScopedList
]>;
Retrieves an aggregated list of target pools.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IAggregatedListTargetPoolsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<[
string,
protos.google.cloud.compute.v1.ITargetPoolsScopedList
]> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing as tuple [string, TargetPoolsScopedList]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: labels.owner:*
(scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake")
(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
/ // const filter = 'abc123' /*
- Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. / // const includeAllScopes = true /*
- The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults
, Compute Engine returns anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, inclusive. (Default:500
) / // const maxResults = 1234 /* - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc"
. This sorts results based on thecreationTimestamp
field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname
orcreationTimestamp desc
is supported. / // const orderBy = 'abc123' /* - Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. / // const pageToken = 'abc123' /* - Project ID for this request. / // const project = 'my-project' /*
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. / // const returnPartialSuccess = true /* */ // const serviceProjectNumber = 1234
// Imports the Compute library const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client const computeClient = new TargetPoolsClient();
async function callAggregatedList() { // Construct request const request = { project, };
// Run request const iterable = await computeClient.aggregatedListAsync(request); for await (const [key, value] of iterable) { console.log(response); } }
callAggregatedList();
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
delete(request, options)
delete(request?: protos.google.cloud.compute.v1.IDeleteTargetPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Deletes the specified target pool.
Parameters | |
---|---|
Name | Description |
request |
IDeleteTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Name of the TargetPool resource to delete.
*/
// const targetPool = 'abc123'
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callDelete() {
// Construct request
const request = {
project,
region,
targetPool,
};
// Run request
const response = await computeClient.delete(request);
console.log(response);
}
callDelete();
delete(request, options, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
delete(request, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IDeleteTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
get(request, options)
get(request?: protos.google.cloud.compute.v1.IGetTargetPoolRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ITargetPool,
protos.google.cloud.compute.v1.IGetTargetPoolRequest | undefined,
{} | undefined
]>;
Returns the specified target pool.
Parameters | |
---|---|
Name | Description |
request |
IGetTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ITargetPool,
protos.google.cloud.compute.v1.IGetTargetPoolRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* Name of the TargetPool resource to return.
*/
// const targetPool = 'abc123'
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callGet() {
// Construct request
const request = {
project,
region,
targetPool,
};
// Run request
const response = await computeClient.get(request);
console.log(response);
}
callGet();
get(request, options, callback)
get(request: protos.google.cloud.compute.v1.IGetTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ITargetPool, protos.google.cloud.compute.v1.IGetTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.ITargetPool, protos.google.cloud.compute.v1.IGetTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
get(request, callback)
get(request: protos.google.cloud.compute.v1.IGetTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.ITargetPool, protos.google.cloud.compute.v1.IGetTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.ITargetPool, protos.google.cloud.compute.v1.IGetTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getHealth(request, options)
getHealth(request?: protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ITargetPoolInstanceHealth,
protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest | undefined,
{} | undefined
]>;
Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.
Parameters | |
---|---|
Name | Description |
request |
IGetHealthTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ITargetPoolInstanceHealth,
protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing TargetPoolInstanceHealth. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The body resource for this request
*/
// const instanceReferenceResource = {}
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* Name of the TargetPool resource to which the queried instance belongs.
*/
// const targetPool = 'abc123'
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callGetHealth() {
// Construct request
const request = {
instanceReferenceResource,
project,
region,
targetPool,
};
// Run request
const response = await computeClient.getHealth(request);
console.log(response);
}
callGetHealth();
getHealth(request, options, callback)
getHealth(request: protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ITargetPoolInstanceHealth, protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetHealthTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.ITargetPoolInstanceHealth, protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getHealth(request, callback)
getHealth(request: protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.ITargetPoolInstanceHealth, protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetHealthTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.ITargetPoolInstanceHealth, protos.google.cloud.compute.v1.IGetHealthTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns | |
---|---|
Type | Description |
Promise<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub. |
insert(request, options)
insert(request?: protos.google.cloud.compute.v1.IInsertTargetPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Creates a target pool in the specified project and region using the data included in the request.
Parameters | |
---|---|
Name | Description |
request |
IInsertTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* The body resource for this request
*/
// const targetPoolResource = {}
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callInsert() {
// Construct request
const request = {
project,
region,
targetPoolResource,
};
// Run request
const response = await computeClient.insert(request);
console.log(response);
}
callInsert();
insert(request, options, callback)
insert(request: protos.google.cloud.compute.v1.IInsertTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IInsertTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
insert(request, callback)
insert(request: protos.google.cloud.compute.v1.IInsertTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IInsertTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IInsertTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
list(request, options)
list(request?: protos.google.cloud.compute.v1.IListTargetPoolsRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ITargetPool[],
protos.google.cloud.compute.v1.IListTargetPoolsRequest | null,
protos.google.cloud.compute.v1.ITargetPoolList
]>;
Retrieves a list of target pools available to the specified project and region.
Parameters | |
---|---|
Name | Description |
request |
IListTargetPoolsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ITargetPool[],
protos.google.cloud.compute.v1.IListTargetPoolsRequest | null,
protos.google.cloud.compute.v1.ITargetPoolList
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
list(request, options, callback)
list(request: protos.google.cloud.compute.v1.IListTargetPoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListTargetPoolsRequest, protos.google.cloud.compute.v1.ITargetPoolList | null | undefined, protos.google.cloud.compute.v1.ITargetPool>): void;
Parameters | |
---|---|
Name | Description |
request |
IListTargetPoolsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.compute.v1.IListTargetPoolsRequest, protos.google.cloud.compute.v1.ITargetPoolList | null | undefined, protos.google.cloud.compute.v1.ITargetPool>
|
Returns | |
---|---|
Type | Description |
void |
list(request, callback)
list(request: protos.google.cloud.compute.v1.IListTargetPoolsRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListTargetPoolsRequest, protos.google.cloud.compute.v1.ITargetPoolList | null | undefined, protos.google.cloud.compute.v1.ITargetPool>): void;
Parameters | |
---|---|
Name | Description |
request |
IListTargetPoolsRequest
|
callback |
PaginationCallback<protos.google.cloud.compute.v1.IListTargetPoolsRequest, protos.google.cloud.compute.v1.ITargetPoolList | null | undefined, protos.google.cloud.compute.v1.ITargetPool>
|
Returns | |
---|---|
Type | Description |
void |
listAsync(request, options)
listAsync(request?: protos.google.cloud.compute.v1.IListTargetPoolsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.ITargetPool>;
Equivalent to list
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListTargetPoolsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.ITargetPool> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`,><=`, `="">=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: labels.owner:*
(scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake")
(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
/ // const filter = 'abc123' /*
- The maximum number of results per page that should be returned. If the number of available results is larger than
maxResults
, Compute Engine returns anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, inclusive. (Default:500
) / // const maxResults = 1234 /* - Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using
orderBy="creationTimestamp desc"
. This sorts results based on thecreationTimestamp
field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting byname
orcreationTimestamp desc
is supported. / // const orderBy = 'abc123' /* - Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. / // const pageToken = 'abc123' /* - Project ID for this request. / // const project = 'my-project' /*
- Name of the region scoping this request. / // const region = 'us-central1' /*
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ // const returnPartialSuccess = true
// Imports the Compute library const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client const computeClient = new TargetPoolsClient();
async function callList() { // Construct request const request = { project, region, };
// Run request const iterable = await computeClient.listAsync(request); for await (const response of iterable) { console.log(response); } }
callList();
listStream(request, options)
listStream(request?: protos.google.cloud.compute.v1.IListTargetPoolsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListTargetPoolsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using |
removeHealthCheck(request, options)
removeHealthCheck(request?: protos.google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Removes health check URL from a target pool.
Parameters | |
---|---|
Name | Description |
request |
IRemoveHealthCheckTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Name of the target pool to remove health checks from.
*/
// const targetPool = 'abc123'
/**
* The body resource for this request
*/
// const targetPoolsRemoveHealthCheckRequestResource = {}
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callRemoveHealthCheck() {
// Construct request
const request = {
project,
region,
targetPool,
targetPoolsRemoveHealthCheckRequestResource,
};
// Run request
const response = await computeClient.removeHealthCheck(request);
console.log(response);
}
callRemoveHealthCheck();
removeHealthCheck(request, options, callback)
removeHealthCheck(request: protos.google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRemoveHealthCheckTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
removeHealthCheck(request, callback)
removeHealthCheck(request: protos.google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRemoveHealthCheckTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
removeInstance(request, options)
removeInstance(request?: protos.google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Removes instance URL from a target pool.
Parameters | |
---|---|
Name | Description |
request |
IRemoveInstanceTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Name of the TargetPool resource to remove instances from.
*/
// const targetPool = 'abc123'
/**
* The body resource for this request
*/
// const targetPoolsRemoveInstanceRequestResource = {}
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callRemoveInstance() {
// Construct request
const request = {
project,
region,
targetPool,
targetPoolsRemoveInstanceRequestResource,
};
// Run request
const response = await computeClient.removeInstance(request);
console.log(response);
}
callRemoveInstance();
removeInstance(request, options, callback)
removeInstance(request: protos.google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRemoveInstanceTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
removeInstance(request, callback)
removeInstance(request: protos.google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRemoveInstanceTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setBackup(request, options)
setBackup(request?: protos.google.cloud.compute.v1.ISetBackupTargetPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Changes a backup target pool's configurations.
Parameters | |
---|---|
Name | Description |
request |
ISetBackupTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* New failoverRatio value for the target pool.
*/
// const failoverRatio = 1234
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Name of the TargetPool resource to set a backup pool for.
*/
// const targetPool = 'abc123'
/**
* The body resource for this request
*/
// const targetReferenceResource = {}
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callSetBackup() {
// Construct request
const request = {
project,
region,
targetPool,
targetReferenceResource,
};
// Run request
const response = await computeClient.setBackup(request);
console.log(response);
}
callSetBackup();
setBackup(request, options, callback)
setBackup(request: protos.google.cloud.compute.v1.ISetBackupTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetBackupTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetBackupTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetBackupTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setBackup(request, callback)
setBackup(request: protos.google.cloud.compute.v1.ISetBackupTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetBackupTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetBackupTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetBackupTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setSecurityPolicy(request, options)
setSecurityPolicy(request?: protos.google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]>;
Sets the Google Cloud Armor security policy for the specified target pool. For more information, see Google Cloud Armor Overview
Parameters | |
---|---|
Name | Description |
request |
ISetSecurityPolicyTargetPoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.compute.v1.IOperation, null>,
protos.google.cloud.compute.v1.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the documentation for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region scoping this request.
*/
// const region = 'us-central1'
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* The body resource for this request
*/
// const securityPolicyReferenceResource = {}
/**
* Name of the TargetPool resource to which the security policy should be set. The name should conform to RFC1035.
*/
// const targetPool = 'abc123'
// Imports the Compute library
const {TargetPoolsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new TargetPoolsClient();
async function callSetSecurityPolicy() {
// Construct request
const request = {
project,
region,
securityPolicyReferenceResource,
targetPool,
};
// Run request
const response = await computeClient.setSecurityPolicy(request);
console.log(response);
}
callSetSecurityPolicy();
setSecurityPolicy(request, options, callback)
setSecurityPolicy(request: protos.google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetSecurityPolicyTargetPoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
setSecurityPolicy(request, callback)
setSecurityPolicy(request: protos.google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISetSecurityPolicyTargetPoolRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |