Class v1.GkeHubClient (1.3.0)

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:

* *

GKE Hub is currently only available in the global region.

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

Package

@google-cloud/gke-hub!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of GkeHubClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

gkeHubStub

gkeHubStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.ICreateFeatureRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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 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>
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 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>
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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.ICreateMembershipRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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 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>
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 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>
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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IDeleteFeatureRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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 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>
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 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>
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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IDeleteMembershipRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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 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>
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 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>
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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IGenerateConnectManifestRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.gkehub.v1.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1.IGenerateConnectManifestRequest | undefined, {} | undefined ]>

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 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>
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 protos.google.cloud.gkehub.v1.IGenerateConnectManifestRequest
callback Callback<protos.google.cloud.gkehub.v1.IGenerateConnectManifestResponse, protos.google.cloud.gkehub.v1.IGenerateConnectManifestRequest | 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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IGetFeatureRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IGetFeatureRequest | undefined, {} | undefined ]>

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 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>
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 protos.google.cloud.gkehub.v1.IGetFeatureRequest
callback Callback<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IGetFeatureRequest | 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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IGetMembershipRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.IGetMembershipRequest | undefined, {} | undefined ]>

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 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>
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 protos.google.cloud.gkehub.v1.IGetMembershipRequest
callback Callback<protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.IGetMembershipRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IListFeaturesRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.gkehub.v1.IFeature[], protos.google.cloud.gkehub.v1.IListFeaturesRequest | null, protos.google.cloud.gkehub.v1.IListFeaturesResponse ]>

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 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>
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 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>
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 protos.google.cloud.gkehub.v1.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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listFeaturesStream(request, options)

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

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

Parameters
Name Description
request protos.google.cloud.gkehub.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IListMembershipsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.gkehub.v1.IMembership[], protos.google.cloud.gkehub.v1.IListMembershipsRequest | null, protos.google.cloud.gkehub.v1.IListMembershipsResponse ]>

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 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>
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 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>
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 protos.google.cloud.gkehub.v1.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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Membership]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listMembershipsStream(request, options)

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

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

Parameters
Name Description
request protos.google.cloud.gkehub.v1.IListMembershipsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Membership] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listMembershipsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

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

Return a fully-qualified location resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

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.

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.

matchLocationFromMembershipName(membershipName)

matchLocationFromMembershipName(membershipName: string): string | number;

Parse the location from Membership resource.

Parameter
Name Description
membershipName string

A fully-qualified path representing Membership resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchMembershipFromMembershipName(membershipName)

matchMembershipFromMembershipName(membershipName: string): string | number;

Parse the membership from Membership resource.

Parameter
Name Description
membershipName string

A fully-qualified path representing Membership resource.
Returns
Type Description
string | number

{string} A string representing the membership.

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.

matchProjectFromMembershipName(membershipName)

matchProjectFromMembershipName(membershipName: string): string | number;

Parse the project from Membership resource.

Parameter
Name Description
membershipName string

A fully-qualified path representing Membership resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

membershipPath(project, location, membership)

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

Return a fully-qualified membership resource name string.

Parameters
Name Description
project string
location string
membership string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IUpdateFeatureRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.gkehub.v1.IFeature, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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 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>
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 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>
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
    ]>;
Parameters
Name Description
request protos.google.cloud.gkehub.v1.IUpdateMembershipRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.gkehub.v1.IMembership, protos.google.cloud.gkehub.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

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 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>
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 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>
Returns
Type Description
void