Class v1.ZoneOperationsClient (3.1.2)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

port

static get port(): number;

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

zoneOperationsStub

zoneOperationsStub?: Promise<{
        [name: string]: Function;
    }>;

Methods

close()

close(): Promise<void>;

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
    ]>;

  /**
   * 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;

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;

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
    ]>;

  /**
   * 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;

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;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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
    ]>;

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;

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;

listAsync(request, options)

listAsync(request?: protos.google.cloud.compute.v1.IListZoneOperationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1.IOperation>;

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

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
    ]>;

  /**
   * 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;

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;