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. v1alpha
Package
@google-cloud/gke-hub!
Constructors
(constructor)(opts)
constructor(opts?:ClientOptions);
Construct an instance of GkeHubClient.
Parameter
Name
Description
opts
ClientOptions
Properties
apiEndpoint
staticgetapiEndpoint():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
staticgetport():number;
The port for this API service.
Property Value
Type
Description
number
scopes
staticgetscopes():string[];
The scopes needed to make gRPC calls for every method defined in this service.
{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.
{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.
{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.
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.
{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.
{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 usinglistFeaturesAsync()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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
