Class v1.NodeTypesClient (4.3.0)

The NodeTypes API. v1

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of NodeTypesClient.

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 NodeTypesClient({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;
    };

nodeTypesStub

nodeTypesStub?: 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.

universeDomain

get universeDomain(): string;

warn

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

Methods

aggregatedListAsync(request, options)

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

Retrieves an aggregated list of node types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`IAggregatedListNodeTypesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<[ string, protos.google.cloud.compute.v1.INodeTypesScopedList ]>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing as tuple [string, NodeTypesScopedList]. 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 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.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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)  If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
   /
  // 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. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
/
// const returnPartialSuccess = true
/*
The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
*/
// const serviceProjectNumber = 1234
// Imports the Compute library
const {NodeTypesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new NodeTypesClient();
async function callAggregatedList() {
// Construct request
const request = {
project,
};
// Run request
const iterable = 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
Type	Description
`Promise<void>`	{Promise} A promise that resolves when the client is closed.

get(request, options)

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

Returns the specified node type.

Parameters
Name	Description
`request`	`IGetNodeTypeRequest` 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.INodeType, protos.google.cloud.compute.v1.IGetNodeTypeRequest \| undefined, {} \| undefined ]>`	{Promise} - The promise which resolves to an array. The first element of the array is an object representing NodeType. 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.
   */
  /**
   *  Name of the node type to return.
   */
  // const nodeType = '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 {NodeTypesClient} = require('@google-cloud/compute').v1;

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

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

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

Returns
Type	Description
`void`

get(request, callback)

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

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

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListNodeTypesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.INodeType[],
        protos.google.cloud.compute.v1.IListNodeTypesRequest | null,
        protos.google.cloud.compute.v1.INodeTypeList
    ]>;

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

Parameters
Name	Description
`request`	`IListNodeTypesRequest` 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.INodeType[],
        protos.google.cloud.compute.v1.IListNodeTypesRequest | null,
        protos.google.cloud.compute.v1.INodeTypeList
    ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of NodeType. 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 for more details and examples.

list(request, options, callback)

list(request: protos.google.cloud.compute.v1.IListNodeTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNodeTypesRequest, protos.google.cloud.compute.v1.INodeTypeList | null | undefined, protos.google.cloud.compute.v1.INodeType>): void;

Parameters
Name	Description
`request`	`IListNodeTypesRequest`
`options`	`CallOptions`
`callback`	`PaginationCallback<protos.google.cloud.compute.v1.IListNodeTypesRequest, protos.google.cloud.compute.v1.INodeTypeList \| null \| undefined, protos.google.cloud.compute.v1.INodeType>`

Returns
Type	Description
`void`

list(request, callback)

list(request: protos.google.cloud.compute.v1.IListNodeTypesRequest, callback: PaginationCallback<protos.google.cloud.compute.v1.IListNodeTypesRequest, protos.google.cloud.compute.v1.INodeTypeList | null | undefined, protos.google.cloud.compute.v1.INodeType>): void;

Parameters
Name	Description
`request`	`IListNodeTypesRequest`
`callback`	`PaginationCallback<protos.google.cloud.compute.v1.IListNodeTypesRequest, protos.google.cloud.compute.v1.INodeTypeList \| null \| undefined, protos.google.cloud.compute.v1.INodeType>`

Returns
Type	Description
`void`

listAsync(request, options)

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

Equivalent to list, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
`request`	`IListNodeTypesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`AsyncIterable<protos.google.cloud.compute.v1.INodeType>`	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing NodeType. 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 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.
   */
  /**
   *  A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your 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 `:*` 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)  If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
   /
  // 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. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
/
// const returnPartialSuccess = true
/*
The name of the zone for this request.
*/
// const zone = 'abc123'
// Imports the Compute library
const {NodeTypesClient} = require('@google-cloud/compute').v1;
// Instantiates a client
const computeClient = new NodeTypesClient();
async function callList() {
// Construct request
const request = {
project,
zone,
};
// Run request
const iterable = computeClient.listAsync(request);
for await (const response of iterable) {
  console.log(response);
}
}
callList();

listStream(request, options)

listStream(request?: protos.google.cloud.compute.v1.IListNodeTypesRequest, options?: CallOptions): Transform;

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

Parameters
Name	Description
`request`	`IListNodeTypesRequest` The request object that will be sent.
`options`	`CallOptions` Call options. See CallOptions for more details.

Returns
Type	Description
`Transform`	{Stream} An object stream which emits an object representing NodeType 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 for more details and examples.