Class v1.MachineTypesClient

The MachineTypes API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of MachineTypesClient.

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

machineTypesStub

machineTypesStub?: Promise<{
        [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

aggregatedListAsync(request, options)

aggregatedListAsync(request?: protos.google.cloud.compute.v1.IAggregatedListMachineTypesRequest, options?: CallOptions): AsyncIterable<[
        string,
        protos.google.cloud.compute.v1.IMachineTypesScopedList
    ]>;

Equivalent to aggregatedList, 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.IAggregatedListMachineTypesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<[ string, protos.google.cloud.compute.v1.IMachineTypesScopedList ]>

{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 as tuple [string, [MachineTypesScopedList]]. 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, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`." 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' *="" *="" indicates="" whether="" every="" visible="" scope="" for="" each="" scope="" type="" (zone,="" region,="" global)="" should="" be="" included="" in="" the="" response.="" for="" new="" resource="" types="" added="" after="" this="" field,="" the="" flag="" has="" no="" effect="" as="" new="" resource="" types="" will="" always="" include="" every="" visible="" scope="" for="" each="" scope="" type="" in="" response.="" for="" resource="" types="" which="" predate="" this="" field,="" if="" this="" flag="" is="" omitted="" or="" false,="" only="" scopes="" of="" the="" scope="" types="" where="" the="" resource="" type="" is="" expected="" to="" be="" found="" will="" be="" included.="" */="" const="" includeallscopes="true" *="" *="" 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" imports="" the="" compute="" library="" const="" {machinetypesclient}="require('@google-cloud/compute').v1;" instantiates="" a="" client="" const="" computeclient="new" machinetypesclient();="" async="" function="" callaggregatedlist()="" {="" construct="" request="" const="" request="{" project,="" };="" run="" request="" const="" iterable="await" computeclient.aggregatedlistasync(request);="" for="" await="" (const="" [key,="" value]="" of="" iterable)="" {="" console.log(response);="" }="" }="" callaggregatedlist();="">

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.

get(request, options)

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

Returns the specified machine type. Gets a list of available machine types by making a list() request.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Promise} - The promise which resolves to an array. The first element of the array is an object representing [MachineType]. 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 machine type to return.
   */
  // const machineType = '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 {MachineTypesClient} = require('@google-cloud/compute').v1;

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

  async function callGet() {
    // Construct request
    const request = {
      machineType,
      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.IGetMachineTypeRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.IMachineType, protos.google.cloud.compute.v1.IGetMachineTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetMachineTypeRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1.IMachineType, protos.google.cloud.compute.v1.IGetMachineTypeRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

get(request, callback)

get(request: protos.google.cloud.compute.v1.IGetMachineTypeRequest, callback: Callback<protos.google.cloud.compute.v1.IMachineType, protos.google.cloud.compute.v1.IGetMachineTypeRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetMachineTypeRequest
callback Callback<protos.google.cloud.compute.v1.IMachineType, protos.google.cloud.compute.v1.IGetMachineTypeRequest | 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.IListMachineTypesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IMachineType[],
        protos.google.cloud.compute.v1.IListMachineTypesRequest | null,
        protos.google.cloud.compute.v1.IMachineTypeList
    ]>;

Retrieves a list of machine types available to the specified project.

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

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IMachineType[], protos.google.cloud.compute.v1.IListMachineTypesRequest | null, protos.google.cloud.compute.v1.IMachineTypeList ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [MachineType]. 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.IListMachineTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListMachineTypesRequest, protos.google.cloud.compute.v1.IMachineTypeList | null | undefined, protos.google.cloud.compute.v1.IMachineType>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListMachineTypesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1.IListMachineTypesRequest, protos.google.cloud.compute.v1.IMachineTypeList | null | undefined, protos.google.cloud.compute.v1.IMachineType>
Returns
TypeDescription
void

list(request, callback)

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

listAsync(request, options)

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

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.IListMachineTypesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1.IMachineType>

{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 [MachineType]. 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, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison 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`." 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" *="" *="" the="" name="" of="" the="" zone="" for="" this="" request.="" */="" const="" zone='abc123' imports="" the="" compute="" library="" const="" {machinetypesclient}="require('@google-cloud/compute').v1;" instantiates="" a="" client="" const="" computeclient="new" machinetypesclient();="" 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.IListMachineTypesRequest, options?: CallOptions): Transform;

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

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

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 [MachineType] 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.