Class v1alpha.GkeHubClient (1.2.1)

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

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.v1alpha.Feature, protos.google.cloud.gkehub.v1alpha.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.v1alpha.Feature, protos.google.cloud.gkehub.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.Feature, protos.google.cloud.gkehub.v1alpha.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.v1alpha.Feature, protos.google.cloud.gkehub.v1alpha.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.v1alpha.ICreateFeatureRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.gkehub.v1alpha.IFeature, protos.google.cloud.gkehub.v1alpha.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.ICreateFeatureRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkehub.v1alpha.IFeature, protos.google.cloud.gkehub.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

createFeature(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

createFeature(request, callback)

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

Parameters

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

Returns

Type	Description
void

deleteFeature(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.IDeleteFeatureRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

deleteFeature(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

deleteFeature(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.IDeleteFeatureRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkehub.v1alpha.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.

getFeature(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.IGetFeatureRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.gkehub.v1alpha.IFeature, protos.google.cloud.gkehub.v1alpha.IGetFeatureRequest \| undefined, {} \| undefined ]>

getFeature(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

getFeature(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.IGetFeatureRequest`
callback	`Callback<protos.google.cloud.gkehub.v1alpha.IFeature, protos.google.cloud.gkehub.v1alpha.IGetFeatureRequest \| 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.v1alpha.IListFeaturesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.gkehub.v1alpha.IFeature[],
        protos.google.cloud.gkehub.v1alpha.IListFeaturesRequest | null,
        protos.google.cloud.gkehub.v1alpha.IListFeaturesResponse
    ]>;

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.IListFeaturesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.cloud.gkehub.v1alpha.IFeature[], protos.google.cloud.gkehub.v1alpha.IListFeaturesRequest \| null, protos.google.cloud.gkehub.v1alpha.IListFeaturesResponse ]>

listFeatures(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

listFeatures(request, callback)

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.IListFeaturesRequest`
callback	`PaginationCallback<protos.google.cloud.gkehub.v1alpha.IListFeaturesRequest, protos.google.cloud.gkehub.v1alpha.IListFeaturesResponse \| null \| undefined, protos.google.cloud.gkehub.v1alpha.IFeature>`

Returns

Type	Description
void

listFeaturesAsync(request, options)

listFeaturesAsync(request?: protos.google.cloud.gkehub.v1alpha.IListFeaturesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkehub.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.IListFeaturesRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.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.

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.

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.

updateFeature(request, options)

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

Parameters

Name	Description
request	`protos.google.cloud.gkehub.v1alpha.IUpdateFeatureRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.cloud.gkehub.v1alpha.IFeature, protos.google.cloud.gkehub.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

updateFeature(request, options, callback)

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

Parameters

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

Returns

Type	Description
void

updateFeature(request, callback)

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

Parameters

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

Returns

Type	Description
void