Class v1.RegionOperationsClient

The RegionOperations API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of RegionOperationsClient.

Parameter
NameDescription
opts ClientOptions

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.

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.

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

delete(request, options)

delete(request?: protos.google.cloud.compute.v1.IDeleteRegionOperationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IDeleteRegionOperationResponse,
        protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | undefined,
        {} | undefined
    ]>;

Deletes the specified region-specific Operations resource.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteRegionOperationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IDeleteRegionOperationResponse, protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [DeleteRegionOperationResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

  /**
   * 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 region for this request.
   */
  // const region = 'us-central1'

  // Imports the Compute library
  const {RegionOperationsClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RegionOperationsClient();

  async function callDelete() {
    // Construct request
    const request = {
      operation,
      project,
      region,
    };

    // Run request
    const response = await computeClient.delete(request);
    console.log(response);
  }

  callDelete();

delete(request, options, callback)

delete(request: protos.google.cloud.compute.v1.IDeleteRegionOperationRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IDeleteRegionOperationResponse, protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteRegionOperationRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IDeleteRegionOperationResponse, protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

delete(request, callback)

delete(request: protos.google.cloud.compute.v1.IDeleteRegionOperationRequest, callback: Callback<protos.google.cloud.compute.v1.IDeleteRegionOperationResponse, protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteRegionOperationRequest
callback Callback<protos.google.cloud.compute.v1.IDeleteRegionOperationResponse, protos.google.cloud.compute.v1.IDeleteRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, options)

get(request?: protos.google.cloud.compute.v1.IGetRegionOperationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IOperation,
        protos.google.cloud.compute.v1.IGetRegionOperationRequest | undefined,
        {} | undefined
    ]>;

Retrieves the specified region-specific Operations resource.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetRegionOperationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetRegionOperationRequest | 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.

Example

  /**
   * 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').v1;

  // 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.v1.IGetRegionOperationRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetRegionOperationRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

get(request: protos.google.cloud.compute.v1.IGetRegionOperationRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetRegionOperationRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IGetRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListRegionOperationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IOperation[],
        protos.google.cloud.compute.v1.IListRegionOperationsRequest | null,
        protos.google.cloud.compute.v1.IOperationList
    ]>;

Retrieves a list of Operation resources contained within the specified region.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListRegionOperationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IOperation[], protos.google.cloud.compute.v1.IListRegionOperationsRequest | 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 listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

list(request, options, callback)

list(request: protos.google.cloud.compute.v1.IListRegionOperationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListRegionOperationsRequest, protos.google.cloud.compute.v1.IOperationList | null | undefined, protos.google.cloud.compute.v1.IOperation>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListRegionOperationsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1.IListRegionOperationsRequest, protos.google.cloud.compute.v1.IOperationList | null | undefined, protos.google.cloud.compute.v1.IOperation>
Returns
TypeDescription
void

list(request, callback)

list(request: protos.google.cloud.compute.v1.IListRegionOperationsRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListRegionOperationsRequest, protos.google.cloud.compute.v1.IOperationList | null | undefined, protos.google.cloud.compute.v1.IOperation>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListRegionOperationsRequest
callback PaginationCallback<protos.google.cloud.compute.v1.IListRegionOperationsRequest, protos.google.cloud.compute.v1.IOperationList | null | undefined, protos.google.cloud.compute.v1.IOperation>
Returns
TypeDescription
void

listAsync(request, options)

listAsync(request?: protos.google.cloud.compute.v1.IListRegionOperationsRequest, 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.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListRegionOperationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. The 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) ```
   */
  // 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'
  /**
   *  Name of the region for 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 {RegionOperationsClient} = require('@google-cloud/compute').v1;

  // Instantiates a client
  const computeClient = new RegionOperationsClient();

  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.IListRegionOperationsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListRegionOperationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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 listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

wait(request, options)

wait(request?: protos.google.cloud.compute.v1.IWaitRegionOperationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IOperation,
        protos.google.cloud.compute.v1.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
NameDescription
request protos.google.cloud.compute.v1.IWaitRegionOperationRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitRegionOperationRequest | 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.

Example

  /**
   * 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').v1;

  // 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.v1.IWaitRegionOperationRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IWaitRegionOperationRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

wait(request, callback)

wait(request: protos.google.cloud.compute.v1.IWaitRegionOperationRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IWaitRegionOperationRequest
callback Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IWaitRegionOperationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void