Class v1.SnapshotSettingsServiceClient (4.3.0)

The SnapshotSettings API. v1

Package

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of SnapshotSettingsServiceClient.

Parameters
Name	Description
`opts`	`ClientOptions`
`gaxInstance`	`typeof gax \| typeof fallback` : loaded instance of `google-gax`. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new SnapshotSettingsServiceClient({fallback: true}, gax); ```

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.

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.

snapshotSettingsServiceStub

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

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.v1.IGetSnapshotSettingRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.ISnapshotSettings,
        protos.google.cloud.compute.v1.IGetSnapshotSettingRequest | undefined,
        {} | undefined
    ]>;

Get snapshot settings.

Parameters
Name	Description
`request`	`IGetSnapshotSettingRequest` 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.ISnapshotSettings, protos.google.cloud.compute.v1.IGetSnapshotSettingRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing SnapshotSettings. Please see the documentation for more details and examples.

Example


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

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

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

  async function callGet() {
    // Construct request
    const request = {
      project,
    };

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

  callGet();

get(request, options, callback)

get(request: protos.google.cloud.compute.v1.IGetSnapshotSettingRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ISnapshotSettings, protos.google.cloud.compute.v1.IGetSnapshotSettingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetSnapshotSettingRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.compute.v1.ISnapshotSettings, protos.google.cloud.compute.v1.IGetSnapshotSettingRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

get(request, callback)

get(request: protos.google.cloud.compute.v1.IGetSnapshotSettingRequest, callback: Callback<protos.google.cloud.compute.v1.ISnapshotSettings, protos.google.cloud.compute.v1.IGetSnapshotSettingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IGetSnapshotSettingRequest`
`callback`	`Callback<protos.google.cloud.compute.v1.ISnapshotSettings, protos.google.cloud.compute.v1.IGetSnapshotSettingRequest \| 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.

patch(request, options)

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

Patch snapshot settings.

Parameters
Name	Description
`request`	`IPatchSnapshotSettingRequest` 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. .promise() is not supported yet.

Example


  /**
   * 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'
  /**
   *  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 snapshotSettingsResource = {}
  /**
   *  update_mask indicates fields to be updated as part of this request.
   */
  // const updateMask = 'abc123'

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

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

  async function callPatch() {
    // Construct request
    const request = {
      project,
      snapshotSettingsResource,
    };

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

  callPatch();

patch(request, options, callback)

patch(request: protos.google.cloud.compute.v1.IPatchSnapshotSettingRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchSnapshotSettingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IPatchSnapshotSettingRequest`
`options`	`CallOptions`
`callback`	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchSnapshotSettingRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`

patch(request, callback)

patch(request: protos.google.cloud.compute.v1.IPatchSnapshotSettingRequest, callback: Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchSnapshotSettingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
`request`	`IPatchSnapshotSettingRequest`
`callback`	`Callback<protos.google.cloud.compute.v1.IOperation, protos.google.cloud.compute.v1.IPatchSnapshotSettingRequest \| null \| undefined, {} \| null \| undefined>`

Returns
Type	Description
`void`