Class v1.ImageFamilyViewsClient (4.8.0)
The ImageFamilyViews API. v1
Package
@google-cloud/computeConstructors
(constructor)(opts, gaxInstance)
constructor(opts?:ClientOptions,gaxInstance?:typeofgax|typeofgax.fallback);Construct an instance of ImageFamilyViewsClient.
| Parameters | |
|---|---|
| Name | Description |
opts | ClientOptions |
gaxInstance | typeofgax | typeoffallback: loaded instance of |
Properties
apiEndpoint
getapiEndpoint():string;The DNS address for this API service.
apiEndpoint
staticgetapiEndpoint():string;The DNS address for this API service - same as servicePath.
auth
auth:gax.GoogleAuth;descriptors
descriptors:Descriptors;imageFamilyViewsStub
imageFamilyViewsStub?:Promise<{[name:string]:Function;}>;innerApiCalls
innerApiCalls:{[name:string]:Function;};port
staticgetport():number;The port for this API service.
scopes
staticgetscopes():string[];The scopes needed to make gRPC calls for every method defined in this service.
servicePath
staticgetservicePath():string;The DNS address for this API service.
universeDomain
getuniverseDomain():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.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 | IGetImageFamilyViewRequestThe request object that will be sent. |
options | CallOptionsCall options. SeeCallOptions 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 representingImageFamilyView. Please see thedocumentation 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 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 libraryconst{ImageFamilyViewsClient}=require('@google-cloud/compute').v1;// Instantiates a clientconstcomputeClient=newImageFamilyViewsClient();asyncfunctioncallGet(){// Construct requestconstrequest={family,project,zone,};// Run requestconstresponse=awaitcomputeClient.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 | 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 | 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. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.