ClusterManagerClient

ClusterManagerClient

Google Kubernetes Engine Cluster Manager v1

Constructor

new ClusterManagerClient(optionsopt, gaxInstanceopt)

Construct an instance of ClusterManagerClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port number <optional>

The port on which to connect to the remote host.

projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint string <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.

fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance gax <optional>

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 ClusterManagerClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

caPoolPath(project, location, ca_pool) → {string}

Return a fully-qualified caPool resource name string.

Parameters:
Name Type Description
project string
location string
ca_pool string
Returns:
Type Description
string

Resource name string.

close() → {Promise}

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

A promise that resolves when the client is closed.

cryptoKeyVersionPath(project, location, key_ring, crypto_key, crypto_key_version) → {string}

Return a fully-qualified cryptoKeyVersion resource name string.

Parameters:
Name Type Description
project string
location string
key_ring string
crypto_key string
crypto_key_version string
Returns:
Type Description
string

Resource name string.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listUsableSubnetworksAsync(request, optionsopt) → {Object}

Equivalent to listUsableSubnetworks, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The parent project where subnetworks are usable. Specified in the format projects/*.

filter string

Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where networkProjectId is the project which owns the listed subnetworks. This defaults to the parent project ID.

pageSize number

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

pageToken string

Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing UsableSubnetwork. 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.
   */
  /**
   *  The parent project where subnetworks are usable.
   *  Specified in the format `projects/*`.
   */
  // const parent = 'abc123'
  /**
   *  Filtering currently only supports equality on the networkProjectId and must
   *  be in the form: "networkProjectId=[PROJECTID]", where `networkProjectId`
   *  is the project which owns the listed subnetworks. This defaults to the
   *  parent project ID.
   */
  // const filter = 'abc123'
  /**
   *  The max number of results per page that should be returned. If the number
   *  of available results is larger than `page_size`, a `next_page_token` is
   *  returned which can be used to get the next page of results in subsequent
   *  requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
   */
  // const pageSize = 1234
  /**
   *  Specifies a page token to use. Set this to the nextPageToken returned by
   *  previous list requests to get the next page of results.
   */
  // const pageToken = 'abc123'

  // Imports the Container library
  const {ClusterManagerClient} = require('@google-cloud/container').v1;

  // Instantiates a client
  const containerClient = new ClusterManagerClient();

  async function callListUsableSubnetworks() {
    // Construct request
    const request = {
    };

    // Run request
    const iterable = containerClient.listUsableSubnetworksAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListUsableSubnetworks();

listUsableSubnetworksStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The parent project where subnetworks are usable. Specified in the format projects/*.

filter string

Filtering currently only supports equality on the networkProjectId and must be in the form: "networkProjectId=[PROJECTID]", where networkProjectId is the project which owns the listed subnetworks. This defaults to the parent project ID.

pageSize number

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

pageToken string

Specifies a page token to use. Set this to the nextPageToken returned by previous list requests to get the next page of results.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

An object stream which emits an object representing UsableSubnetwork 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 listUsableSubnetworksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchCaPoolFromCaPoolName(caPoolName) → {string}

Parse the ca_pool from CaPool resource.

Parameters:
Name Type Description
caPoolName string

A fully-qualified path representing CaPool resource.

Returns:
Type Description
string

A string representing the ca_pool.

matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the crypto_key from CryptoKeyVersion resource.

Parameters:
Name Type Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns:
Type Description
string

A string representing the crypto_key.

matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the crypto_key_version from CryptoKeyVersion resource.

Parameters:
Name Type Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns:
Type Description
string

A string representing the crypto_key_version.

matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the key_ring from CryptoKeyVersion resource.

Parameters:
Name Type Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns:
Type Description
string

A string representing the key_ring.

matchLocationFromCaPoolName(caPoolName) → {string}

Parse the location from CaPool resource.

Parameters:
Name Type Description
caPoolName string

A fully-qualified path representing CaPool resource.

Returns:
Type Description
string

A string representing the location.

matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the location from CryptoKeyVersion resource.

Parameters:
Name Type Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns:
Type Description
string

A string representing the location.

matchProjectFromCaPoolName(caPoolName) → {string}

Parse the project from CaPool resource.

Parameters:
Name Type Description
caPoolName string

A fully-qualified path representing CaPool resource.

Returns:
Type Description
string

A string representing the project.

matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName) → {string}

Parse the project from CryptoKeyVersion resource.

Parameters:
Name Type Description
cryptoKeyVersionName string

A fully-qualified path representing CryptoKeyVersion resource.

Returns:
Type Description
string

A string representing the project.