GkeHubClient

GkeHubClient

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

  • Membership
  • Feature

GKE Hub is currently only available in the global region.

Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

Constructor

new GkeHubClient(optionsopt, gaxInstanceopt)

Construct an instance of GkeHubClient.

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 GkeHubClient({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

(async) checkCreateFeatureProgress(name) → {Promise}

Check the status of the long running operation returned by createFeature().

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 and location) where the Feature will be created.
   *  Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  The ID of the feature to create.
   */
  // const featureId = 'abc123'
  /**
   *  The Feature resource to create.
   */
  // const resource = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

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

    // Run request
    const [operation] = await gkehubClient.createFeature(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateFeature();

(async) checkDeleteFeatureProgress(name) → {Promise}

Check the status of the long running operation returned by deleteFeature().

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 Feature resource name in the format
   *  `projects/* /locations/* /features/*`.
   */
  // const name = 'abc123'
  /**
   *  If set to true, the delete will ignore any outstanding resources for
   *  this Feature (that is, `FeatureState.has_resources` is set to true). These
   *  resources will NOT be cleaned up or modified in any way.
   */
  // const force = true
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

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

    // Run request
    const [operation] = await gkehubClient.deleteFeature(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteFeature();

(async) checkUpdateFeatureProgress(name) → {Promise}

Check the status of the long running operation returned by updateFeature().

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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 Feature resource name in the format
   *  `projects/* /locations/* /features/*`.
   */
  // const name = 'abc123'
  /**
   *  Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Only fields specified in update_mask are updated.
   *  If you specify a field in the update_mask but don't specify its value here
   *  that field will be deleted.
   *  If you are updating a map field, set the value of a key to null or empty
   *  string to delete the key from the map. It's not possible to update a key's
   *  value to the empty string.
   *  If you specify the update_mask to be a special path "*", fully replaces all
   *  user-modifiable fields to match `resource`.
   */
  // const resource = {}
  /**
   *  Optional. A request ID to identify requests. Specify a unique request ID
   *  so that if you must retry your request, the server will know to ignore
   *  the request if it has already been completed. The server will guarantee
   *  that for at least 60 minutes after the first request.
   *  For example, consider a situation where you make an initial request and
   *  the request times out. If you make the request again with the same request
   *  ID, the server can check if original operation with the same request ID
   *  was received, and if so, will ignore the second request. This prevents
   *  clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is
   *  not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

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

    // Run request
    const [operation] = await gkehubClient.updateFeature(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateFeature();

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.

featurePath(project, location, feature) → {string}

Return a fully-qualified feature resource name string.

Parameters:
Name Type Description
project string
location string
feature 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.

listFeaturesAsync(request, optionsopt) → {Object}

Equivalent to listFeatures, 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 and location) where the Features will be listed. Specified in the format projects/* /locations/*.

pageSize number

When requesting a 'page' of resources, page_size specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

pageToken string

Token returned by previous call to ListFeatures which specifies the position in the list from where to continue listing the resources.

filter string

Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Examples:

- Feature with the name "servicemesh" in project "foo-proj":

    name = "projects/foo-proj/locations/global/features/servicemesh"

- Features that have a label called `foo`:

    labels.foo:*

- Features that have a label called `foo` whose value is `bar`:

    labels.foo = bar
orderBy string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

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 Feature. 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 and location) where the Features will be listed.
   *  Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  When requesting a 'page' of resources, `page_size` specifies number of
   *  resources to return. If unspecified or set to 0, all resources will
   *  be returned.
   */
  // const pageSize = 1234
  /**
   *  Token returned by previous call to `ListFeatures` which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'
  /**
   *  Lists Features that match the filter expression, following the syntax
   *  outlined in https://google.aip.dev/160.
   *  Examples:
   *    - Feature with the name "servicemesh" in project "foo-proj":
   *        name = "projects/foo-proj/locations/global/features/servicemesh"
   *    - Features that have a label called `foo`:
   *        labels.foo:*
   *    - Features that have a label called `foo` whose value is `bar`:
   *        labels.foo = bar
   */
  // const filter = 'abc123'
  /**
   *  One or more fields to compare and use to sort the output.
   *  See https://google.aip.dev/132#ordering.
   */
  // const orderBy = 'abc123'

  // Imports the Gkehub library
  const {GkeHubClient} = require('@google-cloud/gke-hub').v1alpha;

  // Instantiates a client
  const gkehubClient = new GkeHubClient();

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

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

  callListFeatures();

listFeaturesStream(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 and location) where the Features will be listed. Specified in the format projects/* /locations/*.

pageSize number

When requesting a 'page' of resources, page_size specifies number of resources to return. If unspecified or set to 0, all resources will be returned.

pageToken string

Token returned by previous call to ListFeatures which specifies the position in the list from where to continue listing the resources.

filter string

Lists Features that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Examples:

- Feature with the name "servicemesh" in project "foo-proj":

    name = "projects/foo-proj/locations/global/features/servicemesh"

- Features that have a label called `foo`:

    labels.foo:*

- Features that have a label called `foo` whose value is `bar`:

    labels.foo = bar
orderBy string

One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

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

matchFeatureFromFeatureName(featureName) → {string}

Parse the feature from Feature resource.

Parameters:
Name Type Description
featureName string

A fully-qualified path representing Feature resource.

Returns:
Type Description
string

A string representing the feature.

matchLocationFromFeatureName(featureName) → {string}

Parse the location from Feature resource.

Parameters:
Name Type Description
featureName string

A fully-qualified path representing Feature resource.

Returns:
Type Description
string

A string representing the location.

matchProjectFromFeatureName(featureName) → {string}

Parse the project from Feature resource.

Parameters:
Name Type Description
featureName string

A fully-qualified path representing Feature resource.

Returns:
Type Description
string

A string representing the project.