Class v1alpha2.GkeHubClient (2.1.0)

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, represented with the resource.

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

Package

@google-cloud/gke-hub

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of GkeHubClient.

Parameter

Name	Description
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;

gkeHubStub

gkeHubStub?: Promise<{
        [name: string]: Function;
    }>;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

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

checkCreateMembershipProgress(name)

checkCreateMembershipProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1alpha2.Membership, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1alpha2.Membership, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent (project and location) where the Memberships will be created.
   *  Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the membership. `membership_id` must be a valid RFC
   *  1123 compliant DNS label:
   *    1. At most 63 characters in length
   *    2. It must consist of lower case alphanumeric characters or `-`
   *    3. It must start and end with an alphanumeric character
   *  Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`,
   *  with a maximum length of 63 characters.
   */
  // const membershipId = 'abc123'
  /**
   *  Required. The membership to create.
   */
  // const resource = {}

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

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

  async function callCreateMembership() {
    // Construct request
    const request = {
      parent,
      membershipId,
      resource,
    };

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

  callCreateMembership();

checkDeleteMembershipProgress(name)

checkDeleteMembershipProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'

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

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

  async function callDeleteMembership() {
    // Construct request
    const request = {
      name,
    };

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

  callDeleteMembership();

checkUpdateMembershipProgress(name)

checkUpdateMembershipProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1alpha2.Membership, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1alpha2.Membership, protos.google.cloud.gkehub.v1alpha2.OperationMetadata>>	{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. 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 = {}

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

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

  async function callUpdateMembership() {
    // Construct request
    const request = {
      name,
      updateMask,
      resource,
    };

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

  callUpdateMembership();

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.

createMembership(request, options)

createMembership(request?: protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Membership.

**This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent (project and location) where the Memberships will be created.
   *  Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the membership. `membership_id` must be a valid RFC
   *  1123 compliant DNS label:
   *    1. At most 63 characters in length
   *    2. It must consist of lower case alphanumeric characters or `-`
   *    3. It must start and end with an alphanumeric character
   *  Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`,
   *  with a maximum length of 63 characters.
   */
  // const membershipId = 'abc123'
  /**
   *  Required. The membership to create.
   */
  // const resource = {}

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

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

  async function callCreateMembership() {
    // Construct request
    const request = {
      parent,
      membershipId,
      resource,
    };

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

  callCreateMembership();

createMembership(request, options, callback)

createMembership(request: protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createMembership(request, callback)

createMembership(request: protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.ICreateMembershipRequest`
callback	`Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteMembership(request, options)

deleteMembership(request?: protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Removes a Membership.

**This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'

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

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

  async function callDeleteMembership() {
    // Construct request
    const request = {
      name,
    };

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

  callDeleteMembership();

deleteMembership(request, options, callback)

deleteMembership(request: protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteMembership(request, callback)

deleteMembership(request: protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IDeleteMembershipRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

generateConnectManifest(request, options)

generateConnectManifest(request?: protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse,
        (protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest | undefined),
        {} | undefined
    ]>;

Generates the manifest for deployment of the GKE connect agent.

**This method is used internally by Google-provided libraries.** Most clients should not need to call this method directly.

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse, (protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest \| undefined), {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [GenerateConnectManifestResponse]. 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.
   */
  /**
   *  Required. The Membership resource name the Agent will associate with, in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'
  /**
   *  Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`.
   *  The Connect Agent is authorized automatically when run in the default
   *  namespace. Otherwise, explicit authorization must be granted with an
   *  additional IAM binding.
   */
  // const namespace = 'abc123'
  /**
   *  Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com
   *  requires the use of a proxy. Format must be in the form
   *  `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol
   *  supported by the proxy. This will direct the connect agent's outbound
   *  traffic through a HTTP(S) proxy.
   */
  // const proxy = 'Buffer.from('string')'
  /**
   *  Optional. The Connect agent version to use. Defaults to the most current version.
   */
  // const version = 'abc123'
  /**
   *  Optional. If true, generate the resources for upgrade only. Some resources
   *  generated only for installation (e.g. secrets) will be excluded.
   */
  // const isUpgrade = true
  /**
   *  Optional. The registry to fetch the connect agent image from. Defaults to
   *  gcr.io/gkeconnect.
   */
  // const registry = 'abc123'
  /**
   *  Optional. The image pull secret content for the registry, if not public.
   */
  // const imagePullSecretContent = 'Buffer.from('string')'

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

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

  async function callGenerateConnectManifest() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await gkehubClient.generateConnectManifest(request);
    console.log(response);
  }

  callGenerateConnectManifest();

generateConnectManifest(request, options, callback)

generateConnectManifest(request: protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

generateConnectManifest(request, callback)

generateConnectManifest(request: protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest`
callback	`Callback<protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1alpha2.IGenerateConnectManifestRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getMembership(request, options)

getMembership(request?: protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha2.IMembership,
        protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest | undefined,
        {} | undefined
    ]>;

Gets the details of a Membership.

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Membership]. 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.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'

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

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

  async function callGetMembership() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await gkehubClient.getMembership(request);
    console.log(response);
  }

  callGetMembership();

getMembership(request, options, callback)

getMembership(request: protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getMembership(request, callback)

getMembership(request: protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest`
callback	`Callback<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IGetMembershipRequest \| 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.

initializeHub(request, options)

initializeHub(request?: protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse,
        protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest | undefined,
        {} | undefined
    ]>;

Initializes the Hub in this project, which includes creating the default Hub Service Account and the Hub Workload Identity Pool. Initialization is optional, and happens automatically when the first Membership is created.

InitializeHub should be called when the first Membership cannot be registered without these resources. A common example is granting the Hub Service Account access to another project, which requires the account to exist first.

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse, protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [InitializeHubResponse]. 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.
   */
  /**
   *  Required. The Hub to initialize, in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const project = 'my-project'

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

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

  async function callInitializeHub() {
    // Construct request
    const request = {
      project,
    };

    // Run request
    const response = await gkehubClient.initializeHub(request);
    console.log(response);
  }

  callInitializeHub();

initializeHub(request, options, callback)

initializeHub(request: protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse, protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse, protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

initializeHub(request, callback)

initializeHub(request: protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest, callback: Callback<protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse, protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest`
callback	`Callback<protos.google.cloud.gkehub.v1alpha2.IInitializeHubResponse, protos.google.cloud.gkehub.v1alpha2.IInitializeHubRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

listMemberships(request, options)

listMemberships(request?: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha2.IMembership[],
        protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest | null,
        protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse
    ]>;

Lists Memberships in a given project and location.

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[ protos.google.cloud.gkehub.v1alpha2.IMembership[], protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest | null, protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Membership]. 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 listMembershipsAsync() 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.

listMemberships(request, options, callback)

listMemberships(request: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1alpha2.IMembership>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse \| null \| undefined, protos.google.cloud.gkehub.v1alpha2.IMembership>`

Returns

Type	Description
void

listMemberships(request, callback)

listMemberships(request: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1alpha2.IMembership>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest`
callback	`PaginationCallback<protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, protos.google.cloud.gkehub.v1alpha2.IListMembershipsResponse \| null \| undefined, protos.google.cloud.gkehub.v1alpha2.IMembership>`

Returns

Type	Description
void

listMembershipsAsync(request, options)

listMembershipsAsync(request?: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1alpha2.IMembership>;

Equivalent to listMemberships, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.gkehub.v1alpha2.IMembership>

{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 [Membership]. 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.
   */
  /**
   *  Required. The parent (project and location) where the Memberships will be listed.
   *  Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. 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
  /**
   *  Optional. Token returned by previous call to `ListMemberships` which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Lists Memberships that match the filter expression, following the syntax
   *  outlined in https://google.aip.dev/160.
   *  Examples:
   *    - Name is `bar` in project `foo-proj` and location `global`:
   *        name = "projects/foo-proj/locations/global/membership/bar"
   *    - Memberships that have a label called `foo`:
   *        labels.foo:*
   *    - Memberships that have a label called `foo` whose value is `bar`:
   *        labels.foo = bar
   *    - Memberships in the CREATING state:
   *        state = CREATING
   */
  // const filter = 'abc123'
  /**
   *  Optional. 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').v1alpha2;

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

  async function callListMemberships() {
    // Construct request
    const request = {
      parent,
    };

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

  callListMemberships();

listMembershipsStream(request, options)

listMembershipsStream(request?: protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IListMembershipsRequest` 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 [Membership] 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 listMembershipsAsync() 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.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromMembershipName(membershipName)

matchLocationFromMembershipName(membershipName: string): string | number;

Parse the location from Membership resource.

Parameter

Name	Description
membershipName	`string` A fully-qualified path representing Membership resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchMembershipFromMembershipName(membershipName)

matchMembershipFromMembershipName(membershipName: string): string | number;

Parse the membership from Membership resource.

Parameter

Name	Description
membershipName	`string` A fully-qualified path representing Membership resource.

Returns

Type	Description
string \| number	{string} A string representing the membership.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromMembershipName(membershipName)

matchProjectFromMembershipName(membershipName: string): string | number;

Parse the project from Membership resource.

Parameter

Name	Description
membershipName	`string` A fully-qualified path representing Membership resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

membershipPath(project, location, membership)

membershipPath(project: string, location: string, membership: string): string;

Return a fully-qualified membership resource name string.

Parameters

Name	Description
project	`string`
location	`string`
membership	`string`

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

updateMembership(request, options)

updateMembership(request?: protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates an existing Membership.

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'
  /**
   *  Required. Mask of fields to update.
   */
  // const updateMask = {}
  /**
   *  Required. 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 = {}

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

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

  async function callUpdateMembership() {
    // Construct request
    const request = {
      name,
      updateMask,
      resource,
    };

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

  callUpdateMembership();

updateMembership(request, options, callback)

updateMembership(request: protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateMembership(request, callback)

updateMembership(request: protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha2.IUpdateMembershipRequest`
callback	`Callback<LROperation<protos.google.cloud.gkehub.v1alpha2.IMembership, protos.google.cloud.gkehub.v1alpha2.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void