The ZoneOperations API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of ZoneOperationsClient.
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof gax.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.
warn
warn: (code: string, message: string, warnType?: string) => void;
zoneOperationsStub
zoneOperationsStub?: Promise<{
[name: string]: Function;
}>;
Methods
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.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
delete(request, options)
delete(request?: protos.google.cloud.compute.v1.IDeleteZoneOperationRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IDeleteZoneOperationResponse,
protos.google.cloud.compute.v1.IDeleteZoneOperationRequest | undefined,
{} | undefined
]>;
Deletes the specified zone-specific Operations resource.
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteZoneOperationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.compute.v1.IDeleteZoneOperationResponse, protos.google.cloud.compute.v1.IDeleteZoneOperationRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [DeleteZoneOperationResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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.
*/
/**
* Name of the Operations resource to delete.
*/
// const operation = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the zone for this request.
*/
// const zone = 'abc123'
// Imports the Compute library
const {ZoneOperationsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new ZoneOperationsClient();
async function callDelete() {
// Construct request
const request = {
operation,
project,
zone,
};
// Run request
const response = await computeClient.delete(request);
console.log(response);
}
callDelete();
delete(request, options, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteZoneOperationRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IDeleteZoneOperationResponse, protos.google.cloud.compute.v1.IDeleteZoneOperationRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteZoneOperationRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IDeleteZoneOperationResponse, protos.google.cloud.compute.v1.IDeleteZoneOperationRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
delete(request, callback)
delete(request: protos.google.cloud.compute.v1.IDeleteZoneOperationRequest, callback: Callback<protos.google.cloud.compute.v1.IDeleteZoneOperationResponse, protos.google.cloud.compute.v1.IDeleteZoneOperationRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.compute.v1.IDeleteZoneOperationRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IDeleteZoneOperationResponse, protos.google.cloud.compute.v1.IDeleteZoneOperationRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
get(request, options)
get(request?: protos.google.cloud.compute.v1.IGetZoneOperationRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IOperation,
protos.google.cloud.compute.v1.IGetZoneOperationRequest | undefined,
{} | undefined
]>;
Retrieves the specified zone-specific Operations resource.
Name | Description |
request |
protos.google.cloud.compute.v1.IGetZoneOperationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetZoneOperationRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Operation]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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.
*/
/**
* Name of the Operations resource to return.
*/
// const operation = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the zone for this request.
*/
// const zone = 'abc123'
// Imports the Compute library
const {ZoneOperationsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new ZoneOperationsClient();
async function callGet() {
// Construct request
const request = {
operation,
project,
zone,
};
// Run request
const response = await computeClient.get(request);
console.log(response);
}
callGet();
get(request, options, callback)
get(request: protos.google.cloud.compute.v1.IGetZoneOperationRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetZoneOperationRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.compute.v1.IGetZoneOperationRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetZoneOperationRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
get(request, callback)
get(request: protos.google.cloud.compute.v1.IGetZoneOperationRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetZoneOperationRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.compute.v1.IGetZoneOperationRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetZoneOperationRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
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.
Type | Description |
Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
list(request, options)
list(request?: protos.google.cloud.compute.v1.IListZoneOperationsRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IOperation[],
protos.google.cloud.compute.v1.IListZoneOperationsRequest | null,
protos.google.cloud.compute.v1.IOperationList
]>;
Retrieves a list of Operation resources contained within the specified zone.
Name | Description |
request |
protos.google.cloud.compute.v1.IListZoneOperationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.compute.v1.IOperation[], protos.google.cloud.compute.v1.IListZoneOperationsRequest | null, protos.google.cloud.compute.v1.IOperationList ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Operation]. 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.IListZoneOperationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListZoneOperationsRequest, protos.google.cloud.compute.v1.IOperationList | null | undefined, protos.google.cloud.compute.v1.IOperation>): void;
Name | Description |
request |
protos.google.cloud.compute.v1.IListZoneOperationsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.compute.v1.IListZoneOperationsRequest, protos.google.cloud.compute.v1.IOperationList | null | undefined, protos.google.cloud.compute.v1.IOperation>
|
Type | Description |
void |
list(request, callback)
list(request: protos.google.cloud.compute.v1.IListZoneOperationsRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListZoneOperationsRequest, protos.google.cloud.compute.v1.IOperationList | null | undefined, protos.google.cloud.compute.v1.IOperation>): void;
Name | Description |
request |
protos.google.cloud.compute.v1.IListZoneOperationsRequest
|
callback |
PaginationCallback<protos.google.cloud.compute.v1.IListZoneOperationsRequest, protos.google.cloud.compute.v1.IOperationList | null | undefined, protos.google.cloud.compute.v1.IOperation>
|
Type | Description |
void |
listAsync(request, options)
listAsync(request?: protos.google.cloud.compute.v1.IListZoneOperationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.IOperation>;
Equivalent to list
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.compute.v1.IListZoneOperationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.compute.v1.IOperation> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Operation]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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. 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 `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. 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:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
*/
// 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 a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, 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 the `creationTimestamp` 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 by `name` or `creationTimestamp desc` is supported.
*/
// const orderBy = 'abc123'
/**
* Specifies a page token to use. Set `pageToken` to the `nextPageToken` 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
/**
* Name of the zone for request.
*/
// const zone = 'abc123'
// Imports the Compute library
const {ZoneOperationsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new ZoneOperationsClient();
async function callList() {
// Construct request
const request = {
project,
zone,
};
// 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.IListZoneOperationsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.compute.v1.IListZoneOperationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {Stream} An object stream which emits an object representing [Operation] 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 |
wait(request, options)
wait(request?: protos.google.cloud.compute.v1.IWaitZoneOperationRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.IOperation,
protos.google.cloud.compute.v1.IWaitZoneOperationRequest | undefined,
{} | undefined
]>;
Waits for the specified Operation resource to return as DONE
or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be DONE
or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE
.
Name | Description |
request |
protos.google.cloud.compute.v1.IWaitZoneOperationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitZoneOperationRequest | undefined, {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Operation]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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.
*/
/**
* Name of the Operations resource to return.
*/
// const operation = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the zone for this request.
*/
// const zone = 'abc123'
// Imports the Compute library
const {ZoneOperationsClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new ZoneOperationsClient();
async function callWait() {
// Construct request
const request = {
operation,
project,
zone,
};
// Run request
const response = await computeClient.wait(request);
console.log(response);
}
callWait();
wait(request, options, callback)
wait(request: protos.google.cloud.compute.v1.IWaitZoneOperationRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitZoneOperationRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.compute.v1.IWaitZoneOperationRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitZoneOperationRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
wait(request, callback)
wait(request: protos.google.cloud.compute.v1.IWaitZoneOperationRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitZoneOperationRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.compute.v1.IWaitZoneOperationRequest
|
callback |
Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitZoneOperationRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |