The RegionOperations API. v1small
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of RegionOperationsClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
port
static get port(): number;
The port for this API service.
regionOperationsStub
regionOperationsStub?: Promise<{
[name: string]: Function;
}>;
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.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
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.
Returns | |
---|---|
Type | Description |
Promise<void> |
{Promise} A promise that resolves when the client is closed. |
get(request, options)
get(request?: protos.google.cloud.compute.v1small.IGetRegionOperationRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1small.IOperation,
(protos.google.cloud.compute.v1small.IGetRegionOperationRequest | undefined),
{} | undefined
]>;
Retrieves the specified region-specific Operations resource.
Parameters | |
---|---|
Name | Description |
request |
IGetRegionOperationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.compute.v1small.IOperation,
(protos.google.cloud.compute.v1small.IGetRegionOperationRequest | 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.
*/
/**
* Name of the Operations resource to return.
*/
// const operation = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
// Imports the Compute library
const {RegionOperationsClient} = require('@google-cloud/compute-small').v1small;
// Instantiates a client
const computeClient = new RegionOperationsClient();
async function callGet() {
// Construct request
const request = {
operation,
project,
region,
};
// Run request
const response = await computeClient.get(request);
console.log(response);
}
callGet();
get(request, options, callback)
get(request: protos.google.cloud.compute.v1small.IGetRegionOperationRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IGetRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetRegionOperationRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IGetRegionOperationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
get(request, callback)
get(request: protos.google.cloud.compute.v1small.IGetRegionOperationRequest, callback: Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IGetRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetRegionOperationRequest
|
callback |
Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IGetRegionOperationRequest | 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. |
wait(request, options)
wait(request?: protos.google.cloud.compute.v1small.IWaitRegionOperationRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1small.IOperation,
(protos.google.cloud.compute.v1small.IWaitRegionOperationRequest | 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 differs from the GET
method in that it waits for no more than the default deadline (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
.
Parameters | |
---|---|
Name | Description |
request |
IWaitRegionOperationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.compute.v1small.IOperation,
(protos.google.cloud.compute.v1small.IWaitRegionOperationRequest | 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.
*/
/**
* Name of the Operations resource to return.
*/
// const operation = 'abc123'
/**
* Project ID for this request.
*/
// const project = 'my-project'
/**
* Name of the region for this request.
*/
// const region = 'us-central1'
// Imports the Compute library
const {RegionOperationsClient} = require('@google-cloud/compute-small').v1small;
// Instantiates a client
const computeClient = new RegionOperationsClient();
async function callWait() {
// Construct request
const request = {
operation,
project,
region,
};
// Run request
const response = await computeClient.wait(request);
console.log(response);
}
callWait();
wait(request, options, callback)
wait(request: protos.google.cloud.compute.v1small.IWaitRegionOperationRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IWaitRegionOperationRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
wait(request, callback)
wait(request: protos.google.cloud.compute.v1small.IWaitRegionOperationRequest, callback: Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IWaitRegionOperationRequest
|
callback |
Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |