Class v1.ImageFamilyViewsClient (3.1.2)

The ImageFamilyViews API. v1

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ImageFamilyViewsClient.

Parameter

Name	Description
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;

imageFamilyViewsStub

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

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;

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

Returns the latest image that is part of an image family, is not deprecated and is rolled out in the specified zone.

Parameters

Name	Description
request	`protos.google.cloud.compute.v1.IGetImageFamilyViewRequest` 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.IImageFamilyView, protos.google.cloud.compute.v1.IGetImageFamilyViewRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ImageFamilyView]. 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 image family to search for.
   */
  // const family = 'abc123'
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  The name of the zone for this request.
   */
  // const zone = 'abc123'

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

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

  async function callGet() {
    // Construct request
    const request = {
      family,
      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.IGetImageFamilyViewRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IImageFamilyView, protos.google.cloud.compute.v1.IGetImageFamilyViewRequest | null | undefined, {} | null | undefined>): void;

Parameters

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

Returns

Type	Description
void

get(request, callback)

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

Parameters

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