Class v1.GkeHubClient (6.4.0)

6.4.0 (latest) 6.1.0 6.0.1 5.0.0 4.5.0 4.4.0 4.2.0 3.4.0 3.3.1 3.2.2 2.2.0 2.1.0 2.0.0 1.4.0 1.3.0 1.2.1 1.1.4

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 available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions.

**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. v1

Package

@google-cloud/gke-hub

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of GkeHubClient.

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

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.

universeDomain

get universeDomain(): string;

warn

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

Methods

checkCreateFeatureProgress(name)

checkCreateFeatureProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Feature, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.Feature, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. 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 = {}
  /**
   *  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').v1;

  // 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();

checkCreateFleetProgress(name)

checkCreateFleetProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Fleet, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.Fleet, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the Fleet will be
   *  created. Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The fleet to create.
   */
  // const fleet = {}

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

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

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

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

  callCreateFleet();

checkCreateMembershipBindingProgress(name)

checkCreateMembershipBindingProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.MembershipBinding, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.MembershipBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the MembershipBinding
   *  will be created. Specified in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The MembershipBinding to create.
   */
  // const membershipBinding = {}
  /**
   *  Required. The ID to use for the MembershipBinding.
   */
  // const membershipBindingId = 'abc123'

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

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

  async function callCreateMembershipBinding() {
    // Construct request
    const request = {
      parent,
      membershipBinding,
      membershipBindingId,
    };

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

  callCreateMembershipBinding();

checkCreateMembershipProgress(name)

checkCreateMembershipProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Membership, protos.google.cloud.gkehub.v1.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.v1.Membership, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  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 = {}
  /**
   *  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').v1;

  // 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();

checkCreateMembershipRBACRoleBindingProgress(name)

checkCreateMembershipRBACRoleBindingProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.RBACRoleBinding, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.RBACRoleBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the RBACRoleBinding will
   *  be created. Specified in the format `projects/* /locations/* /memberships/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_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 rbacrolebindingId = 'abc123'
  /**
   *  Required. The rbacrolebindings to create.
   */
  // const rbacrolebinding = {}

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

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

  async function callCreateMembershipRBACRoleBinding() {
    // Construct request
    const request = {
      parent,
      rbacrolebindingId,
      rbacrolebinding,
    };

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

  callCreateMembershipRBACRoleBinding();

checkCreateScopeNamespaceProgress(name)

checkCreateScopeNamespaceProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Namespace, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.Namespace, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the Namespace will be
   *  created. Specified in the format `projects/* /locations/* /scopes/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the Namespace. `namespace_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 scopeNamespaceId = 'abc123'
  /**
   *  Required. The fleet namespace to create.
   */
  // const scopeNamespace = {}

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

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

  async function callCreateScopeNamespace() {
    // Construct request
    const request = {
      parent,
      scopeNamespaceId,
      scopeNamespace,
    };

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

  callCreateScopeNamespace();

checkCreateScopeProgress(name)

checkCreateScopeProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Scope, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.Scope, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the Scope will be
   *  created. Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the Scope. `scope_id` must be a
   *  ????
   */
  // const scopeId = 'abc123'
  /**
   *  Required. The Scope to create.
   */
  // const scope = {}

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

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

  async function callCreateScope() {
    // Construct request
    const request = {
      parent,
      scopeId,
      scope,
    };

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

  callCreateScope();

checkCreateScopeRBACRoleBindingProgress(name)

checkCreateScopeRBACRoleBindingProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.RBACRoleBinding, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.RBACRoleBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the RBACRoleBinding will
   *  be created. Specified in the format `projects/* /locations/* /scopes/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_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 rbacrolebindingId = 'abc123'
  /**
   *  Required. The rbacrolebindings to create.
   */
  // const rbacrolebinding = {}

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

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

  async function callCreateScopeRBACRoleBinding() {
    // Construct request
    const request = {
      parent,
      rbacrolebindingId,
      rbacrolebinding,
    };

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

  callCreateScopeRBACRoleBinding();

checkDeleteFeatureProgress(name)

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

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

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.v1.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 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.
   */
  /**
   *  Required. 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').v1;

  // 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();

checkDeleteFleetProgress(name)

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

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

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.v1.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 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.
   */
  /**
   *  Required. The Fleet resource name in the format
   *  `projects/* /locations/* /fleets/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteFleet();

checkDeleteMembershipBindingProgress(name)

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

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

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.v1.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 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.
   */
  /**
   *  Required. The MembershipBinding resource name in the format
   *  `projects/* /locations/* /memberships/* /bindings/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteMembershipBinding();

checkDeleteMembershipProgress(name)

checkDeleteMembershipProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkehub.v1.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.v1.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 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.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'
  /**
   *  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'
  /**
   *  Optional. If set to true, any subresource from this Membership will also be
   *  deleted. Otherwise, the request will only work if the Membership has no
   *  subresource.
   */
  // const force = true

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

  // 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();

checkDeleteMembershipRBACRoleBindingProgress(name)

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

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

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.v1.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 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.
   */
  /**
   *  Required. The RBACRoleBinding resource name in the format
   *  `projects/* /locations/* /memberships/* /rbacrolebindings/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteMembershipRBACRoleBinding();

checkDeleteScopeNamespaceProgress(name)

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

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

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.v1.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 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.
   */
  /**
   *  Required. The Namespace resource name in the format
   *  `projects/* /locations/* /scopes/* /namespaces/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteScopeNamespace();

checkDeleteScopeProgress(name)

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

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

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.v1.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 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.
   */
  /**
   *  Required. The Scope resource name in the format
   *  `projects/* /locations/* /scopes/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteScope();

checkDeleteScopeRBACRoleBindingProgress(name)

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

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

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.v1.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 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.
   */
  /**
   *  Required. The RBACRoleBinding resource name in the format
   *  `projects/* /locations/* /scopes/* /rbacrolebindings/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteScopeRBACRoleBinding();

checkUpdateFeatureProgress(name)

checkUpdateFeatureProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Feature, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.Feature, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. 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 = {}
  /**
   *  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').v1;

  // 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();

checkUpdateFleetProgress(name)

checkUpdateFleetProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Fleet, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.Fleet, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The Fleet to update.
   *  The `name` field of the Fleet object identifies which fleet will be
   *  updated.
   */
  // const fleet = {}
  /**
   *  Required. The fields to be updated;
   */
  // const updateMask = {}

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

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

  async function callUpdateFleet() {
    // Construct request
    const request = {
      fleet,
      updateMask,
    };

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

  callUpdateFleet();

checkUpdateMembershipBindingProgress(name)

checkUpdateMembershipBindingProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.MembershipBinding, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.MembershipBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The MembershipBinding object with fields updated.
   */
  // const membershipBinding = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateMembershipBinding() {
    // Construct request
    const request = {
      membershipBinding,
      updateMask,
    };

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

  callUpdateMembershipBinding();

checkUpdateMembershipProgress(name)

checkUpdateMembershipProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Membership, protos.google.cloud.gkehub.v1.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.v1.Membership, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  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 = {}
  /**
   *  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').v1;

  // 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();

checkUpdateMembershipRBACRoleBindingProgress(name)

checkUpdateMembershipRBACRoleBindingProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.RBACRoleBinding, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.RBACRoleBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. A rbacrolebinding with fields updated. The 'name' field in this
   *  rbacrolebinding is used to identify the resource to update.
   */
  // const rbacrolebinding = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateMembershipRBACRoleBinding() {
    // Construct request
    const request = {
      rbacrolebinding,
      updateMask,
    };

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

  callUpdateMembershipRBACRoleBinding();

checkUpdateScopeNamespaceProgress(name)

checkUpdateScopeNamespaceProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Namespace, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.Namespace, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. A namespace with fields updated. The 'name' field in this
   *  namespace is used to identify the resource to update. Given 'updated'
   *  prefix to follow go/proto-best-practices-checkers#keyword_conflict
   */
  // const scopeNamespace = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateScopeNamespace() {
    // Construct request
    const request = {
      scopeNamespace,
      updateMask,
    };

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

  callUpdateScopeNamespace();

checkUpdateScopeProgress(name)

checkUpdateScopeProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.Scope, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.Scope, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. A Scope with fields updated. The 'name' field in this
   *  namespace is used to identify the resource to update.
   */
  // const scope = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateScope() {
    // Construct request
    const request = {
      scope,
      updateMask,
    };

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

  callUpdateScope();

checkUpdateScopeRBACRoleBindingProgress(name)

checkUpdateScopeRBACRoleBindingProgress(name: string): Promise<LROperation<protos.google.cloud.gkehub.v1.RBACRoleBinding, protos.google.cloud.gkehub.v1.OperationMetadata>>;

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

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

Returns
Type	Description
Promise<LROperation<protos.google.cloud.gkehub.v1.RBACRoleBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. A rbacrolebinding with fields updated. The 'name' field in this
   *  rbacrolebinding is used to identify the resource to update.
   */
  // const rbacrolebinding = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateScopeRBACRoleBinding() {
    // Construct request
    const request = {
      rbacrolebinding,
      updateMask,
    };

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

  callUpdateScopeRBACRoleBinding();

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.

createFeature(request, options)

createFeature(request?: protos.google.cloud.gkehub.v1.ICreateFeatureRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Adds a new Feature.

Parameters
Name	Description
request	ICreateFeatureRequest 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.v1.IFeature, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. 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 = {}
  /**
   *  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').v1;

  // 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();

createFeature(request, options, callback)

createFeature(request: protos.google.cloud.gkehub.v1.ICreateFeatureRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFeature(request, callback)

createFeature(request: protos.google.cloud.gkehub.v1.ICreateFeatureRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFeatureRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFleet(request, options)

createFleet(request?: protos.google.cloud.gkehub.v1.ICreateFleetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a fleet.

Parameters
Name	Description
request	ICreateFleetRequest 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.v1.IFleet, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the Fleet will be
   *  created. Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The fleet to create.
   */
  // const fleet = {}

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

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

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

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

  callCreateFleet();

createFleet(request, options, callback)

createFleet(request: protos.google.cloud.gkehub.v1.ICreateFleetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFleetRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createFleet(request, callback)

createFleet(request: protos.google.cloud.gkehub.v1.ICreateFleetRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateFleetRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createMembership(request, options)

createMembership(request?: protos.google.cloud.gkehub.v1.ICreateMembershipRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.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	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.v1.IMembership, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  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 = {}
  /**
   *  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').v1;

  // 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.v1.ICreateMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

createMembership(request, callback)

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

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

Returns
Type	Description
void

createMembershipBinding(request, options)

createMembershipBinding(request?: protos.google.cloud.gkehub.v1.ICreateMembershipBindingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a MembershipBinding.

Parameters
Name	Description
request	ICreateMembershipBindingRequest 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.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the MembershipBinding
   *  will be created. Specified in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The MembershipBinding to create.
   */
  // const membershipBinding = {}
  /**
   *  Required. The ID to use for the MembershipBinding.
   */
  // const membershipBindingId = 'abc123'

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

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

  async function callCreateMembershipBinding() {
    // Construct request
    const request = {
      parent,
      membershipBinding,
      membershipBindingId,
    };

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

  callCreateMembershipBinding();

createMembershipBinding(request, options, callback)

createMembershipBinding(request: protos.google.cloud.gkehub.v1.ICreateMembershipBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateMembershipBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createMembershipBinding(request, callback)

createMembershipBinding(request: protos.google.cloud.gkehub.v1.ICreateMembershipBindingRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateMembershipBindingRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createMembershipRBACRoleBinding(request, options)

createMembershipRBACRoleBinding(request?: protos.google.cloud.gkehub.v1.ICreateMembershipRBACRoleBindingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a Membership RBACRoleBinding.

Parameters
Name	Description
request	ICreateMembershipRBACRoleBindingRequest 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.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the RBACRoleBinding will
   *  be created. Specified in the format `projects/* /locations/* /memberships/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_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 rbacrolebindingId = 'abc123'
  /**
   *  Required. The rbacrolebindings to create.
   */
  // const rbacrolebinding = {}

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

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

  async function callCreateMembershipRBACRoleBinding() {
    // Construct request
    const request = {
      parent,
      rbacrolebindingId,
      rbacrolebinding,
    };

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

  callCreateMembershipRBACRoleBinding();

createMembershipRBACRoleBinding(request, options, callback)

createMembershipRBACRoleBinding(request: protos.google.cloud.gkehub.v1.ICreateMembershipRBACRoleBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateMembershipRBACRoleBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createMembershipRBACRoleBinding(request, callback)

createMembershipRBACRoleBinding(request: protos.google.cloud.gkehub.v1.ICreateMembershipRBACRoleBindingRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateMembershipRBACRoleBindingRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createScope(request, options)

createScope(request?: protos.google.cloud.gkehub.v1.ICreateScopeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a Scope.

Parameters
Name	Description
request	ICreateScopeRequest 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.v1.IScope, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the Scope will be
   *  created. Specified in the format `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the Scope. `scope_id` must be a
   *  ????
   */
  // const scopeId = 'abc123'
  /**
   *  Required. The Scope to create.
   */
  // const scope = {}

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

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

  async function callCreateScope() {
    // Construct request
    const request = {
      parent,
      scopeId,
      scope,
    };

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

  callCreateScope();

createScope(request, options, callback)

createScope(request: protos.google.cloud.gkehub.v1.ICreateScopeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateScopeRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createScope(request, callback)

createScope(request: protos.google.cloud.gkehub.v1.ICreateScopeRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateScopeRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createScopeNamespace(request, options)

createScopeNamespace(request?: protos.google.cloud.gkehub.v1.ICreateScopeNamespaceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a fleet namespace.

Parameters
Name	Description
request	ICreateScopeNamespaceRequest 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.v1.INamespace, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the Namespace will be
   *  created. Specified in the format `projects/* /locations/* /scopes/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the Namespace. `namespace_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 scopeNamespaceId = 'abc123'
  /**
   *  Required. The fleet namespace to create.
   */
  // const scopeNamespace = {}

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

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

  async function callCreateScopeNamespace() {
    // Construct request
    const request = {
      parent,
      scopeNamespaceId,
      scopeNamespace,
    };

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

  callCreateScopeNamespace();

createScopeNamespace(request, options, callback)

createScopeNamespace(request: protos.google.cloud.gkehub.v1.ICreateScopeNamespaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateScopeNamespaceRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createScopeNamespace(request, callback)

createScopeNamespace(request: protos.google.cloud.gkehub.v1.ICreateScopeNamespaceRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateScopeNamespaceRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createScopeRBACRoleBinding(request, options)

createScopeRBACRoleBinding(request?: protos.google.cloud.gkehub.v1.ICreateScopeRBACRoleBindingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a Scope RBACRoleBinding.

Parameters
Name	Description
request	ICreateScopeRBACRoleBindingRequest 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.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The parent (project and location) where the RBACRoleBinding will
   *  be created. Specified in the format `projects/* /locations/* /scopes/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_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 rbacrolebindingId = 'abc123'
  /**
   *  Required. The rbacrolebindings to create.
   */
  // const rbacrolebinding = {}

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

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

  async function callCreateScopeRBACRoleBinding() {
    // Construct request
    const request = {
      parent,
      rbacrolebindingId,
      rbacrolebinding,
    };

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

  callCreateScopeRBACRoleBinding();

createScopeRBACRoleBinding(request, options, callback)

createScopeRBACRoleBinding(request: protos.google.cloud.gkehub.v1.ICreateScopeRBACRoleBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateScopeRBACRoleBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

createScopeRBACRoleBinding(request, callback)

createScopeRBACRoleBinding(request: protos.google.cloud.gkehub.v1.ICreateScopeRBACRoleBindingRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	ICreateScopeRBACRoleBindingRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFeature(request, options)

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

Removes a Feature.

Parameters
Name	Description
request	IDeleteFeatureRequest 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.v1.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 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.
   */
  /**
   *  Required. 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').v1;

  // 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();

deleteFeature(request, options, callback)

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

Parameters
Name	Description
request	IDeleteFeatureRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFeature(request, callback)

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

Parameters
Name	Description
request	IDeleteFeatureRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFleet(request, options)

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

Removes a Fleet. There must be no memberships remaining in the Fleet.

Parameters
Name	Description
request	IDeleteFleetRequest 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.v1.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 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.
   */
  /**
   *  Required. The Fleet resource name in the format
   *  `projects/* /locations/* /fleets/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteFleet();

deleteFleet(request, options, callback)

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

Parameters
Name	Description
request	IDeleteFleetRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteFleet(request, callback)

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

Parameters
Name	Description
request	IDeleteFleetRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteMembership(request, options)

deleteMembership(request?: protos.google.cloud.gkehub.v1.IDeleteMembershipRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.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	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.v1.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 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.
   */
  /**
   *  Required. The Membership resource name in the format
   *  `projects/* /locations/* /memberships/*`.
   */
  // const name = 'abc123'
  /**
   *  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'
  /**
   *  Optional. If set to true, any subresource from this Membership will also be
   *  deleted. Otherwise, the request will only work if the Membership has no
   *  subresource.
   */
  // const force = true

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

  // 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.v1.IDeleteMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

deleteMembership(request, callback)

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

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

Returns
Type	Description
void

deleteMembershipBinding(request, options)

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

Deletes a MembershipBinding.

Parameters
Name	Description
request	IDeleteMembershipBindingRequest 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.v1.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 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.
   */
  /**
   *  Required. The MembershipBinding resource name in the format
   *  `projects/* /locations/* /memberships/* /bindings/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteMembershipBinding();

deleteMembershipBinding(request, options, callback)

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

Parameters
Name	Description
request	IDeleteMembershipBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteMembershipBinding(request, callback)

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

Parameters
Name	Description
request	IDeleteMembershipBindingRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteMembershipRBACRoleBinding(request, options)

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

Deletes a Membership RBACRoleBinding.

Parameters
Name	Description
request	IDeleteMembershipRBACRoleBindingRequest 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.v1.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 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.
   */
  /**
   *  Required. The RBACRoleBinding resource name in the format
   *  `projects/* /locations/* /memberships/* /rbacrolebindings/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteMembershipRBACRoleBinding();

deleteMembershipRBACRoleBinding(request, options, callback)

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

Parameters
Name	Description
request	IDeleteMembershipRBACRoleBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteMembershipRBACRoleBinding(request, callback)

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

Parameters
Name	Description
request	IDeleteMembershipRBACRoleBindingRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteScope(request, options)

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

Deletes a Scope.

Parameters
Name	Description
request	IDeleteScopeRequest 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.v1.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 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.
   */
  /**
   *  Required. The Scope resource name in the format
   *  `projects/* /locations/* /scopes/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteScope();

deleteScope(request, options, callback)

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

Parameters
Name	Description
request	IDeleteScopeRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteScope(request, callback)

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

Parameters
Name	Description
request	IDeleteScopeRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteScopeNamespace(request, options)

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

Deletes a fleet namespace.

Parameters
Name	Description
request	IDeleteScopeNamespaceRequest 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.v1.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 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.
   */
  /**
   *  Required. The Namespace resource name in the format
   *  `projects/* /locations/* /scopes/* /namespaces/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteScopeNamespace();

deleteScopeNamespace(request, options, callback)

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

Parameters
Name	Description
request	IDeleteScopeNamespaceRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteScopeNamespace(request, callback)

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

Parameters
Name	Description
request	IDeleteScopeNamespaceRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteScopeRBACRoleBinding(request, options)

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

Deletes a Scope RBACRoleBinding.

Parameters
Name	Description
request	IDeleteScopeRBACRoleBindingRequest 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.v1.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 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.
   */
  /**
   *  Required. The RBACRoleBinding resource name in the format
   *  `projects/* /locations/* /scopes/* /rbacrolebindings/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteScopeRBACRoleBinding();

deleteScopeRBACRoleBinding(request, options, callback)

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

Parameters
Name	Description
request	IDeleteScopeRBACRoleBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

deleteScopeRBACRoleBinding(request, callback)

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

Parameters
Name	Description
request	IDeleteScopeRBACRoleBindingRequest
callback	Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

featurePath(project, location, feature)

featurePath(project: string, location: string, feature: string): string;

Return a fully-qualified feature resource name string.

Parameters
Name	Description
project	string
location	string
feature	string

Returns
Type	Description
string	{string} Resource name string.

generateConnectManifest(request, options)

generateConnectManifest(request?: protos.google.cloud.gkehub.v1.IGenerateConnectManifestRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IGenerateConnectManifestResponse,
        protos.google.cloud.gkehub.v1.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	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.v1.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  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').v1;

  // 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.v1.IGenerateConnectManifestRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1.IGenerateConnectManifestRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

generateConnectManifest(request, callback)

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

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

Returns
Type	Description
void

generateMembershipRBACRoleBindingYAML(request, options)

generateMembershipRBACRoleBindingYAML(request?: protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLResponse,
        protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest | undefined,
        {} | undefined
    ]>;

Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLResponse, protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateMembershipRBACRoleBindingYAMLResponse. 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.
   */
  /**
   *  Required. The parent (project and location) where the RBACRoleBinding will
   *  be created. Specified in the format `projects/* /locations/* /memberships/*`.
   */
  // const parent = 'abc123'
  /**
   *  Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_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 rbacrolebindingId = 'abc123'
  /**
   *  Required. The rbacrolebindings to generate the YAML for.
   */
  // const rbacrolebinding = {}

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

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

  async function callGenerateMembershipRBACRoleBindingYAML() {
    // Construct request
    const request = {
      parent,
      rbacrolebindingId,
      rbacrolebinding,
    };

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

  callGenerateMembershipRBACRoleBindingYAML();

generateMembershipRBACRoleBindingYAML(request, options, callback)

generateMembershipRBACRoleBindingYAML(request: protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLResponse, protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGenerateMembershipRBACRoleBindingYAMLRequest
options	CallOptions
callback	Callback<protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLResponse, protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

generateMembershipRBACRoleBindingYAML(request, callback)

generateMembershipRBACRoleBindingYAML(request: protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest, callback: Callback<protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLResponse, protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGenerateMembershipRBACRoleBindingYAMLRequest
callback	Callback<protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLResponse, protos.google.cloud.gkehub.v1.IGenerateMembershipRBACRoleBindingYAMLRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeature(request, options)

getFeature(request?: protos.google.cloud.gkehub.v1.IGetFeatureRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IFeature,
        protos.google.cloud.gkehub.v1.IGetFeatureRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Feature.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IGetFeatureRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Feature. 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.
   */
  /**
   *  Required. The Feature resource name in the format
   *  `projects/* /locations/* /features/*`
   */
  // const name = 'abc123'
  /**
   *  Optional. If set to true, the response will return partial results when
   *  some regions are unreachable and the unreachable field in Feature proto
   *  will be populated. If set to false, the request will fail when some regions
   *  are unreachable.
   */
  // const returnPartialSuccess = true

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

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

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

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

  callGetFeature();

getFeature(request, options, callback)

getFeature(request: protos.google.cloud.gkehub.v1.IGetFeatureRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IGetFeatureRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureRequest
options	CallOptions
callback	Callback<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IGetFeatureRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFeature(request, callback)

getFeature(request: protos.google.cloud.gkehub.v1.IGetFeatureRequest, callback: Callback<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IGetFeatureRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFeatureRequest
callback	Callback<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IGetFeatureRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFleet(request, options)

getFleet(request?: protos.google.cloud.gkehub.v1.IGetFleetRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IFleet,
        protos.google.cloud.gkehub.v1.IGetFleetRequest | undefined,
        {} | undefined
    ]>;

Returns the details of a fleet.

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

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

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

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

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

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

  callGetFleet();

getFleet(request, options, callback)

getFleet(request: protos.google.cloud.gkehub.v1.IGetFleetRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IGetFleetRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFleetRequest
options	CallOptions
callback	Callback<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IGetFleetRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getFleet(request, callback)

getFleet(request: protos.google.cloud.gkehub.v1.IGetFleetRequest, callback: Callback<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IGetFleetRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetFleetRequest
callback	Callback<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IGetFleetRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getMembership(request, options)

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

Gets the details of a Membership.

Parameters
Name	Description
request	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.v1.IMembership, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  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').v1;

  // 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.v1.IGetMembershipRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.IGetMembershipRequest | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

getMembership(request, callback)

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

Parameters
Name	Description
request	IGetMembershipRequest
callback	Callback<protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.IGetMembershipRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getMembershipBinding(request, options)

getMembershipBinding(request?: protos.google.cloud.gkehub.v1.IGetMembershipBindingRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IMembershipBinding,
        protos.google.cloud.gkehub.v1.IGetMembershipBindingRequest | undefined,
        {} | undefined
    ]>;

Returns the details of a MembershipBinding.

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

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

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

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

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

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

  callGetMembershipBinding();

getMembershipBinding(request, options, callback)

getMembershipBinding(request: protos.google.cloud.gkehub.v1.IGetMembershipBindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IGetMembershipBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetMembershipBindingRequest
options	CallOptions
callback	Callback<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IGetMembershipBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getMembershipBinding(request, callback)

getMembershipBinding(request: protos.google.cloud.gkehub.v1.IGetMembershipBindingRequest, callback: Callback<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IGetMembershipBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetMembershipBindingRequest
callback	Callback<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IGetMembershipBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getMembershipRBACRoleBinding(request, options)

getMembershipRBACRoleBinding(request?: protos.google.cloud.gkehub.v1.IGetMembershipRBACRoleBindingRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IRBACRoleBinding,
        protos.google.cloud.gkehub.v1.IGetMembershipRBACRoleBindingRequest | undefined,
        {} | undefined
    ]>;

Returns the details of a Membership RBACRoleBinding.

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

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

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

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

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

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

  callGetMembershipRBACRoleBinding();

getMembershipRBACRoleBinding(request, options, callback)

getMembershipRBACRoleBinding(request: protos.google.cloud.gkehub.v1.IGetMembershipRBACRoleBindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetMembershipRBACRoleBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetMembershipRBACRoleBindingRequest
options	CallOptions
callback	Callback<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetMembershipRBACRoleBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getMembershipRBACRoleBinding(request, callback)

getMembershipRBACRoleBinding(request: protos.google.cloud.gkehub.v1.IGetMembershipRBACRoleBindingRequest, callback: Callback<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetMembershipRBACRoleBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetMembershipRBACRoleBindingRequest
callback	Callback<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetMembershipRBACRoleBindingRequest | 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

getScope(request, options)

getScope(request?: protos.google.cloud.gkehub.v1.IGetScopeRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IScope,
        protos.google.cloud.gkehub.v1.IGetScopeRequest | undefined,
        {} | undefined
    ]>;

Returns the details of a Scope.

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

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

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

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

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

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

  callGetScope();

getScope(request, options, callback)

getScope(request: protos.google.cloud.gkehub.v1.IGetScopeRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IGetScopeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetScopeRequest
options	CallOptions
callback	Callback<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IGetScopeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getScope(request, callback)

getScope(request: protos.google.cloud.gkehub.v1.IGetScopeRequest, callback: Callback<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IGetScopeRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetScopeRequest
callback	Callback<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IGetScopeRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getScopeNamespace(request, options)

getScopeNamespace(request?: protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.INamespace,
        protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest | undefined,
        {} | undefined
    ]>;

Returns the details of a fleet namespace.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing Namespace. 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.
   */
  /**
   *  Required. The Namespace resource name in the format
   *  `projects/* /locations/* /scopes/* /namespaces/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetScopeNamespace();

getScopeNamespace(request, options, callback)

getScopeNamespace(request: protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetScopeNamespaceRequest
options	CallOptions
callback	Callback<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getScopeNamespace(request, callback)

getScopeNamespace(request: protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest, callback: Callback<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetScopeNamespaceRequest
callback	Callback<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IGetScopeNamespaceRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getScopeRBACRoleBinding(request, options)

getScopeRBACRoleBinding(request?: protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IRBACRoleBinding,
        protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest | undefined,
        {} | undefined
    ]>;

Returns the details of a Scope RBACRoleBinding.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest | undefined, {} | undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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.
   */
  /**
   *  Required. The RBACRoleBinding resource name in the format
   *  `projects/* /locations/* /scopes/* /rbacrolebindings/*`.
   */
  // const name = 'abc123'

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

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

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

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

  callGetScopeRBACRoleBinding();

getScopeRBACRoleBinding(request, options, callback)

getScopeRBACRoleBinding(request: protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetScopeRBACRoleBindingRequest
options	CallOptions
callback	Callback<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getScopeRBACRoleBinding(request, callback)

getScopeRBACRoleBinding(request: protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest, callback: Callback<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetScopeRBACRoleBindingRequest
callback	Callback<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IGetScopeRBACRoleBindingRequest | null | undefined, {} | null | 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.

listBoundMemberships(request, options)

listBoundMemberships(request?: protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IMembership[],
        protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest | null,
        protos.google.cloud.gkehub.v1.IListBoundMembershipsResponse
    ]>;

Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IMembership[], protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest | null, protos.google.cloud.gkehub.v1.IListBoundMembershipsResponse ]>	{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 listBoundMembershipsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listBoundMemberships(request, options, callback)

listBoundMemberships(request: protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, protos.google.cloud.gkehub.v1.IListBoundMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembership>): void;

Parameters
Name	Description
request	IListBoundMembershipsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, protos.google.cloud.gkehub.v1.IListBoundMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembership>

Returns
Type	Description
void

listBoundMemberships(request, callback)

listBoundMemberships(request: protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, protos.google.cloud.gkehub.v1.IListBoundMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembership>): void;

Parameters
Name	Description
request	IListBoundMembershipsRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, protos.google.cloud.gkehub.v1.IListBoundMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembership>

Returns
Type	Description
void

listBoundMembershipsAsync(request, options)

listBoundMembershipsAsync(request?: protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.IMembership>;

Equivalent to listBoundMemberships, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.IMembership>	{Object} An iterable Object that allows async iteration. 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 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.
   */
  /**
   *  Required. Name of the Scope, in the format
   *  `projects/* /locations/global/scopes/*`, to which the Memberships are bound.
   */
  // const scopeName = 'abc123'
  /**
   *  Optional. Lists Memberships that match the filter expression, following the
   *  syntax outlined in https://google.aip.dev/160. Currently, filtering
   *  can be done only based on Memberships's `name`, `labels`, `create_time`,
   *  `update_time`, and `unique_id`.
   */
  // const filter = '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. Pagination is currently not supported; therefore, setting
   *  this field does not have any impact for now.
   */
  // const pageSize = 1234
  /**
   *  Optional. Token returned by previous call to `ListBoundMemberships` which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'

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

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

  async function callListBoundMemberships() {
    // Construct request
    const request = {
      scopeName,
    };

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

  callListBoundMemberships();

listBoundMembershipsStream(request, options)

listBoundMembershipsStream(request?: protos.google.cloud.gkehub.v1.IListBoundMembershipsRequest, options?: CallOptions): Transform;

Equivalent to listBoundMemberships, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListBoundMembershipsRequest 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 listBoundMembershipsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeatures(request, options)

listFeatures(request?: protos.google.cloud.gkehub.v1.IListFeaturesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IFeature[],
        protos.google.cloud.gkehub.v1.IListFeaturesRequest | null,
        protos.google.cloud.gkehub.v1.IListFeaturesResponse
    ]>;

Lists Features in a given project and location.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IFeature[], protos.google.cloud.gkehub.v1.IListFeaturesRequest | null, protos.google.cloud.gkehub.v1.IListFeaturesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Feature. 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 listFeaturesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFeatures(request, options, callback)

listFeatures(request: protos.google.cloud.gkehub.v1.IListFeaturesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListFeaturesRequest, protos.google.cloud.gkehub.v1.IListFeaturesResponse | null | undefined, protos.google.cloud.gkehub.v1.IFeature>): void;

Parameters
Name	Description
request	IListFeaturesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListFeaturesRequest, protos.google.cloud.gkehub.v1.IListFeaturesResponse | null | undefined, protos.google.cloud.gkehub.v1.IFeature>

Returns
Type	Description
void

listFeatures(request, callback)

listFeatures(request: protos.google.cloud.gkehub.v1.IListFeaturesRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListFeaturesRequest, protos.google.cloud.gkehub.v1.IListFeaturesResponse | null | undefined, protos.google.cloud.gkehub.v1.IFeature>): void;

Parameters
Name	Description
request	IListFeaturesRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListFeaturesRequest, protos.google.cloud.gkehub.v1.IListFeaturesResponse | null | undefined, protos.google.cloud.gkehub.v1.IFeature>

Returns
Type	Description
void

listFeaturesAsync(request, options)

listFeaturesAsync(request?: protos.google.cloud.gkehub.v1.IListFeaturesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.IFeature>;

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	Description
request	IListFeaturesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.IFeature>	{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.
   */
  /**
   *  Required. 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'
  /**
   *  Optional. If set to true, the response will return partial results when
   *  some regions are unreachable and the unreachable field in Feature proto
   *  will be populated. If set to false, the request will fail when some regions
   *  are unreachable.
   */
  // const returnPartialSuccess = true

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

  // 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, options)

listFeaturesStream(request?: protos.google.cloud.gkehub.v1.IListFeaturesRequest, options?: CallOptions): Transform;

Equivalent to listFeatures, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListFeaturesRequest 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 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.

listFleets(request, options)

listFleets(request?: protos.google.cloud.gkehub.v1.IListFleetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IFleet[],
        protos.google.cloud.gkehub.v1.IListFleetsRequest | null,
        protos.google.cloud.gkehub.v1.IListFleetsResponse
    ]>;

Returns all fleets within an organization or a project that the caller has access to.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IFleet[], protos.google.cloud.gkehub.v1.IListFleetsRequest | null, protos.google.cloud.gkehub.v1.IListFleetsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Fleet. 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 listFleetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listFleets(request, options, callback)

listFleets(request: protos.google.cloud.gkehub.v1.IListFleetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListFleetsRequest, protos.google.cloud.gkehub.v1.IListFleetsResponse | null | undefined, protos.google.cloud.gkehub.v1.IFleet>): void;

Parameters
Name	Description
request	IListFleetsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListFleetsRequest, protos.google.cloud.gkehub.v1.IListFleetsResponse | null | undefined, protos.google.cloud.gkehub.v1.IFleet>

Returns
Type	Description
void

listFleets(request, callback)

listFleets(request: protos.google.cloud.gkehub.v1.IListFleetsRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListFleetsRequest, protos.google.cloud.gkehub.v1.IListFleetsResponse | null | undefined, protos.google.cloud.gkehub.v1.IFleet>): void;

Parameters
Name	Description
request	IListFleetsRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListFleetsRequest, protos.google.cloud.gkehub.v1.IListFleetsResponse | null | undefined, protos.google.cloud.gkehub.v1.IFleet>

Returns
Type	Description
void

listFleetsAsync(request, options)

listFleetsAsync(request?: protos.google.cloud.gkehub.v1.IListFleetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.IFleet>;

Equivalent to listFleets, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.IFleet>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Fleet. 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.
   */
  /**
   *  Required. The organization or project to list for Fleets under, in the
   *  format `organizations/* /locations/*` or `projects/* /locations/*`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. A page token, received from a previous `ListFleets` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListFleets` must match
   *  the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. The maximum number of fleets to return. The service may return
   *  fewer than this value. If unspecified, at most 200 fleets will be returned.
   *  The maximum value is 1000; values above 1000 will be coerced to 1000.
   */
  // const pageSize = 1234

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

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

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

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

  callListFleets();

listFleetsStream(request, options)

listFleetsStream(request?: protos.google.cloud.gkehub.v1.IListFleetsRequest, options?: CallOptions): Transform;

Equivalent to listFleets, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListFleetsRequest 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 Fleet 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 listFleetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMembershipBindings(request, options)

listMembershipBindings(request?: protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IMembershipBinding[],
        protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest | null,
        protos.google.cloud.gkehub.v1.IListMembershipBindingsResponse
    ]>;

Lists MembershipBindings.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IMembershipBinding[], protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest | null, protos.google.cloud.gkehub.v1.IListMembershipBindingsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of MembershipBinding. 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 listMembershipBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMembershipBindings(request, options, callback)

listMembershipBindings(request: protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, protos.google.cloud.gkehub.v1.IListMembershipBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembershipBinding>): void;

Parameters
Name	Description
request	IListMembershipBindingsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, protos.google.cloud.gkehub.v1.IListMembershipBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembershipBinding>

Returns
Type	Description
void

listMembershipBindings(request, callback)

listMembershipBindings(request: protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, protos.google.cloud.gkehub.v1.IListMembershipBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembershipBinding>): void;

Parameters
Name	Description
request	IListMembershipBindingsRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, protos.google.cloud.gkehub.v1.IListMembershipBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembershipBinding>

Returns
Type	Description
void

listMembershipBindingsAsync(request, options)

listMembershipBindingsAsync(request?: protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.IMembershipBinding>;

Equivalent to listMembershipBindings, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.IMembershipBinding>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing MembershipBinding. 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.
   */
  /**
   *  Required. The parent Membership for which the MembershipBindings will be
   *  listed. Specified in the format `projects/* /locations/* /memberships/*`.
   */
  // 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 `ListMembershipBindings` which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Lists MembershipBindings that match the filter expression,
   *  following the syntax outlined in https://google.aip.dev/160.
   */
  // const filter = 'abc123'

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

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

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

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

  callListMembershipBindings();

listMembershipBindingsStream(request, options)

listMembershipBindingsStream(request?: protos.google.cloud.gkehub.v1.IListMembershipBindingsRequest, options?: CallOptions): Transform;

Equivalent to listMembershipBindings, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListMembershipBindingsRequest 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 MembershipBinding 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 listMembershipBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMembershipRBACRoleBindings(request, options)

listMembershipRBACRoleBindings(request?: protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IRBACRoleBinding[],
        protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest | null,
        protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsResponse
    ]>;

Lists all Membership RBACRoleBindings.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IRBACRoleBinding[], protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest | null, protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listMembershipRBACRoleBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMembershipRBACRoleBindings(request, options, callback)

listMembershipRBACRoleBindings(request: protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IRBACRoleBinding>): void;

Parameters
Name	Description
request	IListMembershipRBACRoleBindingsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IRBACRoleBinding>

Returns
Type	Description
void

listMembershipRBACRoleBindings(request, callback)

listMembershipRBACRoleBindings(request: protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IRBACRoleBinding>): void;

Parameters
Name	Description
request	IListMembershipRBACRoleBindingsRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IRBACRoleBinding>

Returns
Type	Description
void

listMembershipRBACRoleBindingsAsync(request, options)

listMembershipRBACRoleBindingsAsync(request?: protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.IRBACRoleBinding>;

Equivalent to listMembershipRBACRoleBindings, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.IRBACRoleBinding>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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.
   */
  /**
   *  Required. The parent (project and location) where the Features will be
   *  listed. Specified in the format `projects/* /locations/* /memberships/*`.
   */
  // 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
   *  `ListMembershipRBACRoleBindings` which specifies the position in the list
   *  from where to continue listing the resources.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListMembershipRBACRoleBindings();

listMembershipRBACRoleBindingsStream(request, options)

listMembershipRBACRoleBindingsStream(request?: protos.google.cloud.gkehub.v1.IListMembershipRBACRoleBindingsRequest, options?: CallOptions): Transform;

Equivalent to listMembershipRBACRoleBindings, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListMembershipRBACRoleBindingsRequest 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 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 listMembershipRBACRoleBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listMemberships(request, options)

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

Lists Memberships in a given project and location.

Parameters
Name	Description
request	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.v1.IMembership[], protos.google.cloud.gkehub.v1.IListMembershipsRequest | null, protos.google.cloud.gkehub.v1.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 for more details and examples.

listMemberships(request, options, callback)

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

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

Returns
Type	Description
void

listMemberships(request, callback)

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

Parameters
Name	Description
request	IListMembershipsRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListMembershipsRequest, protos.google.cloud.gkehub.v1.IListMembershipsResponse | null | undefined, protos.google.cloud.gkehub.v1.IMembership>

Returns
Type	Description
void

listMembershipsAsync(request, options)

listMembershipsAsync(request?: protos.google.cloud.gkehub.v1.IListMembershipsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.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	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.v1.IMembership>	{Object} An iterable Object that allows async iteration. 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 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.
   */
  /**
   *  Required. The parent (project and location) where the Memberships will be
   *  listed. Specified in the format `projects/* /locations/*`.
   *  `projects/* /locations/-` list memberships in all the regions.
   */
  // 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').v1;

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

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

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

  callListMemberships();

listMembershipsStream(request, options)

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

Equivalent to listMemberships, but returns a NodeJS Stream object.

Parameters
Name	Description
request	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 for more details and examples.

listPermittedScopes(request, options)

listPermittedScopes(request?: protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IScope[],
        protos.google.cloud.gkehub.v1.IListPermittedScopesRequest | null,
        protos.google.cloud.gkehub.v1.IListPermittedScopesResponse
    ]>;

Lists permitted Scopes.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IScope[], protos.google.cloud.gkehub.v1.IListPermittedScopesRequest | null, protos.google.cloud.gkehub.v1.IListPermittedScopesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Scope. 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 listPermittedScopesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPermittedScopes(request, options, callback)

listPermittedScopes(request: protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, protos.google.cloud.gkehub.v1.IListPermittedScopesResponse | null | undefined, protos.google.cloud.gkehub.v1.IScope>): void;

Parameters
Name	Description
request	IListPermittedScopesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, protos.google.cloud.gkehub.v1.IListPermittedScopesResponse | null | undefined, protos.google.cloud.gkehub.v1.IScope>

Returns
Type	Description
void

listPermittedScopes(request, callback)

listPermittedScopes(request: protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, protos.google.cloud.gkehub.v1.IListPermittedScopesResponse | null | undefined, protos.google.cloud.gkehub.v1.IScope>): void;

Parameters
Name	Description
request	IListPermittedScopesRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, protos.google.cloud.gkehub.v1.IListPermittedScopesResponse | null | undefined, protos.google.cloud.gkehub.v1.IScope>

Returns
Type	Description
void

listPermittedScopesAsync(request, options)

listPermittedScopesAsync(request?: protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.IScope>;

Equivalent to listPermittedScopes, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.IScope>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Scope. 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.
   */
  /**
   *  Required. The parent (project and location) where the Scope 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 `ListPermittedScopes` which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListPermittedScopes();

listPermittedScopesStream(request, options)

listPermittedScopesStream(request?: protos.google.cloud.gkehub.v1.IListPermittedScopesRequest, options?: CallOptions): Transform;

Equivalent to listPermittedScopes, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListPermittedScopesRequest 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 Scope 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 listPermittedScopesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listScopeNamespaces(request, options)

listScopeNamespaces(request?: protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.INamespace[],
        protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest | null,
        protos.google.cloud.gkehub.v1.IListScopeNamespacesResponse
    ]>;

Lists fleet namespaces.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.INamespace[], protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest | null, protos.google.cloud.gkehub.v1.IListScopeNamespacesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Namespace. 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 listScopeNamespacesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listScopeNamespaces(request, options, callback)

listScopeNamespaces(request: protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, protos.google.cloud.gkehub.v1.IListScopeNamespacesResponse | null | undefined, protos.google.cloud.gkehub.v1.INamespace>): void;

Parameters
Name	Description
request	IListScopeNamespacesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, protos.google.cloud.gkehub.v1.IListScopeNamespacesResponse | null | undefined, protos.google.cloud.gkehub.v1.INamespace>

Returns
Type	Description
void

listScopeNamespaces(request, callback)

listScopeNamespaces(request: protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, protos.google.cloud.gkehub.v1.IListScopeNamespacesResponse | null | undefined, protos.google.cloud.gkehub.v1.INamespace>): void;

Parameters
Name	Description
request	IListScopeNamespacesRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, protos.google.cloud.gkehub.v1.IListScopeNamespacesResponse | null | undefined, protos.google.cloud.gkehub.v1.INamespace>

Returns
Type	Description
void

listScopeNamespacesAsync(request, options)

listScopeNamespacesAsync(request?: protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.INamespace>;

Equivalent to listScopeNamespaces, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.INamespace>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Namespace. 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.
   */
  /**
   *  Required. The parent (project and location) where the Features will be
   *  listed. Specified in the format `projects/* /locations/* /scopes/*`.
   */
  // 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 `ListFeatures` which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListScopeNamespaces();

listScopeNamespacesStream(request, options)

listScopeNamespacesStream(request?: protos.google.cloud.gkehub.v1.IListScopeNamespacesRequest, options?: CallOptions): Transform;

Equivalent to listScopeNamespaces, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListScopeNamespacesRequest 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 Namespace 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 listScopeNamespacesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listScopeRBACRoleBindings(request, options)

listScopeRBACRoleBindings(request?: protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IRBACRoleBinding[],
        protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest | null,
        protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsResponse
    ]>;

Lists all Scope RBACRoleBindings.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IRBACRoleBinding[], protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest | null, protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listScopeRBACRoleBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listScopeRBACRoleBindings(request, options, callback)

listScopeRBACRoleBindings(request: protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IRBACRoleBinding>): void;

Parameters
Name	Description
request	IListScopeRBACRoleBindingsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IRBACRoleBinding>

Returns
Type	Description
void

listScopeRBACRoleBindings(request, callback)

listScopeRBACRoleBindings(request: protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IRBACRoleBinding>): void;

Parameters
Name	Description
request	IListScopeRBACRoleBindingsRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsResponse | null | undefined, protos.google.cloud.gkehub.v1.IRBACRoleBinding>

Returns
Type	Description
void

listScopeRBACRoleBindingsAsync(request, options)

listScopeRBACRoleBindingsAsync(request?: protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.IRBACRoleBinding>;

Equivalent to listScopeRBACRoleBindings, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.IRBACRoleBinding>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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.
   */
  /**
   *  Required. The parent (project and location) where the Features will be
   *  listed. Specified in the format `projects/* /locations/* /scopes/*`.
   */
  // 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 `ListScopeRBACRoleBindings`
   *  which specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListScopeRBACRoleBindings();

listScopeRBACRoleBindingsStream(request, options)

listScopeRBACRoleBindingsStream(request?: protos.google.cloud.gkehub.v1.IListScopeRBACRoleBindingsRequest, options?: CallOptions): Transform;

Equivalent to listScopeRBACRoleBindings, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListScopeRBACRoleBindingsRequest 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 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 listScopeRBACRoleBindingsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listScopes(request, options)

listScopes(request?: protos.google.cloud.gkehub.v1.IListScopesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1.IScope[],
        protos.google.cloud.gkehub.v1.IListScopesRequest | null,
        protos.google.cloud.gkehub.v1.IListScopesResponse
    ]>;

Lists Scopes.

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

Returns
Type	Description
Promise<[ protos.google.cloud.gkehub.v1.IScope[], protos.google.cloud.gkehub.v1.IListScopesRequest | null, protos.google.cloud.gkehub.v1.IListScopesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of Scope. 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 listScopesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listScopes(request, options, callback)

listScopes(request: protos.google.cloud.gkehub.v1.IListScopesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListScopesRequest, protos.google.cloud.gkehub.v1.IListScopesResponse | null | undefined, protos.google.cloud.gkehub.v1.IScope>): void;

Parameters
Name	Description
request	IListScopesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListScopesRequest, protos.google.cloud.gkehub.v1.IListScopesResponse | null | undefined, protos.google.cloud.gkehub.v1.IScope>

Returns
Type	Description
void

listScopes(request, callback)

listScopes(request: protos.google.cloud.gkehub.v1.IListScopesRequest, callback: PaginationCallback<protos.google.cloud.gkehub.v1.IListScopesRequest, protos.google.cloud.gkehub.v1.IListScopesResponse | null | undefined, protos.google.cloud.gkehub.v1.IScope>): void;

Parameters
Name	Description
request	IListScopesRequest
callback	PaginationCallback<protos.google.cloud.gkehub.v1.IListScopesRequest, protos.google.cloud.gkehub.v1.IListScopesResponse | null | undefined, protos.google.cloud.gkehub.v1.IScope>

Returns
Type	Description
void

listScopesAsync(request, options)

listScopesAsync(request?: protos.google.cloud.gkehub.v1.IListScopesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1.IScope>;

Equivalent to listScopes, but returns an iterable object.

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

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

Returns
Type	Description
AsyncIterable<protos.google.cloud.gkehub.v1.IScope>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Scope. 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.
   */
  /**
   *  Required. The parent (project and location) where the Scope 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 `ListScopes` which
   *  specifies the position in the list from where to continue listing the
   *  resources.
   */
  // const pageToken = 'abc123'

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

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

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

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

  callListScopes();

listScopesStream(request, options)

listScopesStream(request?: protos.google.cloud.gkehub.v1.IListScopesRequest, options?: CallOptions): Transform;

Equivalent to listScopes, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListScopesRequest 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 Scope 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 listScopesAsync() method described below for async iteration which you can stop as needed. Please see the documentation 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.

matchFeatureFromFeatureName(featureName)

matchFeatureFromFeatureName(featureName: string): string | number;

Parse the feature from Feature resource.

Parameter
Name	Description
featureName	string A fully-qualified path representing Feature resource.

Returns
Type	Description
string | number	{string} A string representing the feature.

matchFleetFromOrganizationLocationFleetName(organizationLocationFleetName)

matchFleetFromOrganizationLocationFleetName(organizationLocationFleetName: string): string | number;

Parse the fleet from OrganizationLocationFleet resource.

Parameter
Name	Description
organizationLocationFleetName	string A fully-qualified path representing organization_location_fleet resource.

Returns
Type	Description
string | number	{string} A string representing the fleet.

matchFleetFromProjectLocationFleetName(projectLocationFleetName)

matchFleetFromProjectLocationFleetName(projectLocationFleetName: string): string | number;

Parse the fleet from ProjectLocationFleet resource.

Parameter
Name	Description
projectLocationFleetName	string A fully-qualified path representing project_location_fleet resource.

Returns
Type	Description
string | number	{string} A string representing the fleet.

matchLocationFromFeatureName(featureName)

matchLocationFromFeatureName(featureName: string): string | number;

Parse the location from Feature resource.

Parameter
Name	Description
featureName	string A fully-qualified path representing Feature resource.

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

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.

matchLocationFromMembershipBindingName(membershipBindingName)

matchLocationFromMembershipBindingName(membershipBindingName: string): string | number;

Parse the location from MembershipBinding resource.

Parameter
Name	Description
membershipBindingName	string A fully-qualified path representing MembershipBinding 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.

matchLocationFromNamespaceName(namespaceName)

matchLocationFromNamespaceName(namespaceName: string): string | number;

Parse the location from Namespace resource.

Parameter
Name	Description
namespaceName	string A fully-qualified path representing Namespace resource.

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

matchLocationFromOrganizationLocationFleetName(organizationLocationFleetName)

matchLocationFromOrganizationLocationFleetName(organizationLocationFleetName: string): string | number;

Parse the location from OrganizationLocationFleet resource.

Parameter
Name	Description
organizationLocationFleetName	string A fully-qualified path representing organization_location_fleet resource.

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

matchLocationFromProjectLocationFleetName(projectLocationFleetName)

matchLocationFromProjectLocationFleetName(projectLocationFleetName: string): string | number;

Parse the location from ProjectLocationFleet resource.

Parameter
Name	Description
projectLocationFleetName	string A fully-qualified path representing project_location_fleet resource.

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

matchLocationFromProjectLocationMembershipRbacrolebindingName(projectLocationMembershipRbacrolebindingName)

matchLocationFromProjectLocationMembershipRbacrolebindingName(projectLocationMembershipRbacrolebindingName: string): string | number;

Parse the location from ProjectLocationMembershipRbacrolebinding resource.

Parameter
Name	Description
projectLocationMembershipRbacrolebindingName	string A fully-qualified path representing project_location_membership_rbacrolebinding resource.

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

matchLocationFromProjectLocationScopeRbacrolebindingName(projectLocationScopeRbacrolebindingName)

matchLocationFromProjectLocationScopeRbacrolebindingName(projectLocationScopeRbacrolebindingName: string): string | number;

Parse the location from ProjectLocationScopeRbacrolebinding resource.

Parameter
Name	Description
projectLocationScopeRbacrolebindingName	string A fully-qualified path representing project_location_scope_rbacrolebinding resource.

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

matchLocationFromScopeName(scopeName)

matchLocationFromScopeName(scopeName: string): string | number;

Parse the location from Scope resource.

Parameter
Name	Description
scopeName	string A fully-qualified path representing Scope resource.

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

matchMembershipbindingFromMembershipBindingName(membershipBindingName)

matchMembershipbindingFromMembershipBindingName(membershipBindingName: string): string | number;

Parse the membershipbinding from MembershipBinding resource.

Parameter
Name	Description
membershipBindingName	string A fully-qualified path representing MembershipBinding resource.

Returns
Type	Description
string | number	{string} A string representing the membershipbinding.

matchMembershipFromMembershipBindingName(membershipBindingName)

matchMembershipFromMembershipBindingName(membershipBindingName: string): string | number;

Parse the membership from MembershipBinding resource.

Parameter
Name	Description
membershipBindingName	string A fully-qualified path representing MembershipBinding resource.

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

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.

matchMembershipFromProjectLocationMembershipRbacrolebindingName(projectLocationMembershipRbacrolebindingName)

matchMembershipFromProjectLocationMembershipRbacrolebindingName(projectLocationMembershipRbacrolebindingName: string): string | number;

Parse the membership from ProjectLocationMembershipRbacrolebinding resource.

Parameter
Name	Description
projectLocationMembershipRbacrolebindingName	string A fully-qualified path representing project_location_membership_rbacrolebinding resource.

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

matchNamespaceFromNamespaceName(namespaceName)

matchNamespaceFromNamespaceName(namespaceName: string): string | number;

Parse the namespace from Namespace resource.

Parameter
Name	Description
namespaceName	string A fully-qualified path representing Namespace resource.

Returns
Type	Description
string | number	{string} A string representing the namespace.

matchOrganizationFromOrganizationLocationFleetName(organizationLocationFleetName)

matchOrganizationFromOrganizationLocationFleetName(organizationLocationFleetName: string): string | number;

Parse the organization from OrganizationLocationFleet resource.

Parameter
Name	Description
organizationLocationFleetName	string A fully-qualified path representing organization_location_fleet resource.

Returns
Type	Description
string | number	{string} A string representing the organization.

matchProjectFromFeatureName(featureName)

matchProjectFromFeatureName(featureName: string): string | number;

Parse the project from Feature resource.

Parameter
Name	Description
featureName	string A fully-qualified path representing Feature resource.

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

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.

matchProjectFromMembershipBindingName(membershipBindingName)

matchProjectFromMembershipBindingName(membershipBindingName: string): string | number;

Parse the project from MembershipBinding resource.

Parameter
Name	Description
membershipBindingName	string A fully-qualified path representing MembershipBinding 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.

matchProjectFromNamespaceName(namespaceName)

matchProjectFromNamespaceName(namespaceName: string): string | number;

Parse the project from Namespace resource.

Parameter
Name	Description
namespaceName	string A fully-qualified path representing Namespace resource.

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

matchProjectFromProjectLocationFleetName(projectLocationFleetName)

matchProjectFromProjectLocationFleetName(projectLocationFleetName: string): string | number;

Parse the project from ProjectLocationFleet resource.

Parameter
Name	Description
projectLocationFleetName	string A fully-qualified path representing project_location_fleet resource.

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

matchProjectFromProjectLocationMembershipRbacrolebindingName(projectLocationMembershipRbacrolebindingName)

matchProjectFromProjectLocationMembershipRbacrolebindingName(projectLocationMembershipRbacrolebindingName: string): string | number;

Parse the project from ProjectLocationMembershipRbacrolebinding resource.

Parameter
Name	Description
projectLocationMembershipRbacrolebindingName	string A fully-qualified path representing project_location_membership_rbacrolebinding resource.

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

matchProjectFromProjectLocationScopeRbacrolebindingName(projectLocationScopeRbacrolebindingName)

matchProjectFromProjectLocationScopeRbacrolebindingName(projectLocationScopeRbacrolebindingName: string): string | number;

Parse the project from ProjectLocationScopeRbacrolebinding resource.

Parameter
Name	Description
projectLocationScopeRbacrolebindingName	string A fully-qualified path representing project_location_scope_rbacrolebinding 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.

matchProjectFromScopeName(scopeName)

matchProjectFromScopeName(scopeName: string): string | number;

Parse the project from Scope resource.

Parameter
Name	Description
scopeName	string A fully-qualified path representing Scope resource.

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

matchRbacrolebindingFromProjectLocationMembershipRbacrolebindingName(projectLocationMembershipRbacrolebindingName)

matchRbacrolebindingFromProjectLocationMembershipRbacrolebindingName(projectLocationMembershipRbacrolebindingName: string): string | number;

Parse the rbacrolebinding from ProjectLocationMembershipRbacrolebinding resource.

Parameter
Name	Description
projectLocationMembershipRbacrolebindingName	string A fully-qualified path representing project_location_membership_rbacrolebinding resource.

Returns
Type	Description
string | number	{string} A string representing the rbacrolebinding.

matchRbacrolebindingFromProjectLocationScopeRbacrolebindingName(projectLocationScopeRbacrolebindingName)

matchRbacrolebindingFromProjectLocationScopeRbacrolebindingName(projectLocationScopeRbacrolebindingName: string): string | number;

Parse the rbacrolebinding from ProjectLocationScopeRbacrolebinding resource.

Parameter
Name	Description
projectLocationScopeRbacrolebindingName	string A fully-qualified path representing project_location_scope_rbacrolebinding resource.

Returns
Type	Description
string | number	{string} A string representing the rbacrolebinding.

matchScopeFromNamespaceName(namespaceName)

matchScopeFromNamespaceName(namespaceName: string): string | number;

Parse the scope from Namespace resource.

Parameter
Name	Description
namespaceName	string A fully-qualified path representing Namespace resource.

Returns
Type	Description
string | number	{string} A string representing the scope.

matchScopeFromProjectLocationScopeRbacrolebindingName(projectLocationScopeRbacrolebindingName)

matchScopeFromProjectLocationScopeRbacrolebindingName(projectLocationScopeRbacrolebindingName: string): string | number;

Parse the scope from ProjectLocationScopeRbacrolebinding resource.

Parameter
Name	Description
projectLocationScopeRbacrolebindingName	string A fully-qualified path representing project_location_scope_rbacrolebinding resource.

Returns
Type	Description
string | number	{string} A string representing the scope.

matchScopeFromScopeName(scopeName)

matchScopeFromScopeName(scopeName: string): string | number;

Parse the scope from Scope resource.

Parameter
Name	Description
scopeName	string A fully-qualified path representing Scope resource.

Returns
Type	Description
string | number	{string} A string representing the scope.

membershipBindingPath(project, location, membership, membershipbinding)

membershipBindingPath(project: string, location: string, membership: string, membershipbinding: string): string;

Return a fully-qualified membershipBinding resource name string.

Parameters
Name	Description
project	string
location	string
membership	string
membershipbinding	string

Returns
Type	Description
string	{string} Resource name string.

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.

namespacePath(project, location, scope, namespace)

namespacePath(project: string, location: string, scope: string, namespace: string): string;

Return a fully-qualified namespace resource name string.

Parameters
Name	Description
project	string
location	string
scope	string
namespace	string

Returns
Type	Description
string	{string} Resource name string.

organizationLocationFleetPath(organization, location, fleet)

organizationLocationFleetPath(organization: string, location: string, fleet: string): string;

Return a fully-qualified organizationLocationFleet resource name string.

Parameters
Name	Description
organization	string
location	string
fleet	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationFleetPath(project, location, fleet)

projectLocationFleetPath(project: string, location: string, fleet: string): string;

Return a fully-qualified projectLocationFleet resource name string.

Parameters
Name	Description
project	string
location	string
fleet	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationMembershipRbacrolebindingPath(project, location, membership, rbacrolebinding)

projectLocationMembershipRbacrolebindingPath(project: string, location: string, membership: string, rbacrolebinding: string): string;

Return a fully-qualified projectLocationMembershipRbacrolebinding resource name string.

Parameters
Name	Description
project	string
location	string
membership	string
rbacrolebinding	string

Returns
Type	Description
string	{string} Resource name string.

projectLocationScopeRbacrolebindingPath(project, location, scope, rbacrolebinding)

projectLocationScopeRbacrolebindingPath(project: string, location: string, scope: string, rbacrolebinding: string): string;

Return a fully-qualified projectLocationScopeRbacrolebinding resource name string.

Parameters
Name	Description
project	string
location	string
scope	string
rbacrolebinding	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.

scopePath(project, location, scope)

scopePath(project: string, location: string, scope: string): string;

Return a fully-qualified scope resource name string.

Parameters
Name	Description
project	string
location	string
scope	string

Returns
Type	Description
string	{string} Resource name string.

updateFeature(request, options)

updateFeature(request?: protos.google.cloud.gkehub.v1.IUpdateFeatureRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates an existing Feature.

Parameters
Name	Description
request	IUpdateFeatureRequest 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.v1.IFeature, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. 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 = {}
  /**
   *  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').v1;

  // 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();

updateFeature(request, options, callback)

updateFeature(request: protos.google.cloud.gkehub.v1.IUpdateFeatureRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateFeatureRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateFeature(request, callback)

updateFeature(request: protos.google.cloud.gkehub.v1.IUpdateFeatureRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateFeatureRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateFleet(request, options)

updateFleet(request?: protos.google.cloud.gkehub.v1.IUpdateFleetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a fleet.

Parameters
Name	Description
request	IUpdateFleetRequest 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.v1.IFleet, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The Fleet to update.
   *  The `name` field of the Fleet object identifies which fleet will be
   *  updated.
   */
  // const fleet = {}
  /**
   *  Required. The fields to be updated;
   */
  // const updateMask = {}

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

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

  async function callUpdateFleet() {
    // Construct request
    const request = {
      fleet,
      updateMask,
    };

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

  callUpdateFleet();

updateFleet(request, options, callback)

updateFleet(request: protos.google.cloud.gkehub.v1.IUpdateFleetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateFleetRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateFleet(request, callback)

updateFleet(request: protos.google.cloud.gkehub.v1.IUpdateFleetRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateFleetRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IFleet, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateMembership(request, options)

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

Updates an existing Membership.

Parameters
Name	Description
request	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.v1.IMembership, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  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 = {}
  /**
   *  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').v1;

  // 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.v1.IUpdateMembershipRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

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

Returns
Type	Description
void

updateMembership(request, callback)

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

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

Returns
Type	Description
void

updateMembershipBinding(request, options)

updateMembershipBinding(request?: protos.google.cloud.gkehub.v1.IUpdateMembershipBindingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a MembershipBinding.

Parameters
Name	Description
request	IUpdateMembershipBindingRequest 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.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. The MembershipBinding object with fields updated.
   */
  // const membershipBinding = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateMembershipBinding() {
    // Construct request
    const request = {
      membershipBinding,
      updateMask,
    };

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

  callUpdateMembershipBinding();

updateMembershipBinding(request, options, callback)

updateMembershipBinding(request: protos.google.cloud.gkehub.v1.IUpdateMembershipBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateMembershipBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateMembershipBinding(request, callback)

updateMembershipBinding(request: protos.google.cloud.gkehub.v1.IUpdateMembershipBindingRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateMembershipBindingRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IMembershipBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateMembershipRBACRoleBinding(request, options)

updateMembershipRBACRoleBinding(request?: protos.google.cloud.gkehub.v1.IUpdateMembershipRBACRoleBindingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a Membership RBACRoleBinding.

Parameters
Name	Description
request	IUpdateMembershipRBACRoleBindingRequest 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.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. A rbacrolebinding with fields updated. The 'name' field in this
   *  rbacrolebinding is used to identify the resource to update.
   */
  // const rbacrolebinding = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateMembershipRBACRoleBinding() {
    // Construct request
    const request = {
      rbacrolebinding,
      updateMask,
    };

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

  callUpdateMembershipRBACRoleBinding();

updateMembershipRBACRoleBinding(request, options, callback)

updateMembershipRBACRoleBinding(request: protos.google.cloud.gkehub.v1.IUpdateMembershipRBACRoleBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateMembershipRBACRoleBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateMembershipRBACRoleBinding(request, callback)

updateMembershipRBACRoleBinding(request: protos.google.cloud.gkehub.v1.IUpdateMembershipRBACRoleBindingRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateMembershipRBACRoleBindingRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateScope(request, options)

updateScope(request?: protos.google.cloud.gkehub.v1.IUpdateScopeRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a scopes.

Parameters
Name	Description
request	IUpdateScopeRequest 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.v1.IScope, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. A Scope with fields updated. The 'name' field in this
   *  namespace is used to identify the resource to update.
   */
  // const scope = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateScope() {
    // Construct request
    const request = {
      scope,
      updateMask,
    };

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

  callUpdateScope();

updateScope(request, options, callback)

updateScope(request: protos.google.cloud.gkehub.v1.IUpdateScopeRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateScopeRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateScope(request, callback)

updateScope(request: protos.google.cloud.gkehub.v1.IUpdateScopeRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateScopeRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IScope, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateScopeNamespace(request, options)

updateScopeNamespace(request?: protos.google.cloud.gkehub.v1.IUpdateScopeNamespaceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a fleet namespace.

Parameters
Name	Description
request	IUpdateScopeNamespaceRequest 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.v1.INamespace, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. A namespace with fields updated. The 'name' field in this
   *  namespace is used to identify the resource to update. Given 'updated'
   *  prefix to follow go/proto-best-practices-checkers#keyword_conflict
   */
  // const scopeNamespace = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateScopeNamespace() {
    // Construct request
    const request = {
      scopeNamespace,
      updateMask,
    };

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

  callUpdateScopeNamespace();

updateScopeNamespace(request, options, callback)

updateScopeNamespace(request: protos.google.cloud.gkehub.v1.IUpdateScopeNamespaceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateScopeNamespaceRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateScopeNamespace(request, callback)

updateScopeNamespace(request: protos.google.cloud.gkehub.v1.IUpdateScopeNamespaceRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateScopeNamespaceRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.INamespace, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateScopeRBACRoleBinding(request, options)

updateScopeRBACRoleBinding(request?: protos.google.cloud.gkehub.v1.IUpdateScopeRBACRoleBindingRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates a Scope RBACRoleBinding.

Parameters
Name	Description
request	IUpdateScopeRBACRoleBindingRequest 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.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.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 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.
   */
  /**
   *  Required. A rbacrolebinding with fields updated. The 'name' field in this
   *  rbacrolebinding is used to identify the resource to update.
   */
  // const rbacrolebinding = {}
  /**
   *  Required. The fields to be updated.
   */
  // const updateMask = {}

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

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

  async function callUpdateScopeRBACRoleBinding() {
    // Construct request
    const request = {
      rbacrolebinding,
      updateMask,
    };

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

  callUpdateScopeRBACRoleBinding();

updateScopeRBACRoleBinding(request, options, callback)

updateScopeRBACRoleBinding(request: protos.google.cloud.gkehub.v1.IUpdateScopeRBACRoleBindingRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateScopeRBACRoleBindingRequest
options	CallOptions
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateScopeRBACRoleBinding(request, callback)

updateScopeRBACRoleBinding(request: protos.google.cloud.gkehub.v1.IUpdateScopeRBACRoleBindingRequest, callback: Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateScopeRBACRoleBindingRequest
callback	Callback<LROperation<protos.google.cloud.gkehub.v1.IRBACRoleBinding, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>

Returns
Type	Description
void