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-hubConstructors
(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 gax.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: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
gkeHubStub
gkeHubStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
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.
/**
* 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.
*/
/**
* 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 = {}
/**
* 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
'
).
v1alpha
;
// 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
();
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.
/**
* 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.
*/
/**
* 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
'
).
v1alpha
;
// 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
();
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.
/**
* 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.
*/
/**
* 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 = {}
/**
* 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
'
).
v1alpha
;
// 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
();
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
]>;
Adds a new Feature.
Parameters
Name
Description
request
protos. google.cloud.gkehub.v1alpha.ICreateFeatureRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.gkehub.v1alpha.IFeature
, protos. google.cloud.gkehub.v1alpha.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* 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 = {}
/**
* 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
'
).
v1alpha
;
// 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
.
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
]>;
Removes a Feature.
Parameters
Name
Description
request
protos. google.cloud.gkehub.v1alpha.IDeleteFeatureRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.gkehub.v1alpha.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* 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
'
).
v1alpha
;
// 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
.
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
]>;
Gets details of a single Feature.
Parameters
Name
Description
request
protos. google.cloud.gkehub.v1alpha.IGetFeatureRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.gkehub.v1alpha.IFeature
,
protos. google.cloud.gkehub.v1alpha.IGetFeatureRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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.
*/
/**
* The Feature resource name in the format
* `projects/* /locations/* /features/*`
*/
// const name = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1alpha
;
// 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
.
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
]>;
Lists Features in a given project and location.
Parameters
Name
Description
request
protos. google.cloud.gkehub.v1alpha.IListFeaturesRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[
protos. google.cloud.gkehub.v1alpha.IFeature
[],
protos. google.cloud.gkehub.v1alpha.IListFeaturesRequest
| null,
protos. google.cloud.gkehub.v1alpha.IListFeaturesResponse
]>
{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 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.
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
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 . 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.
/**
* 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.
*/
/**
* 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'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1alpha
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callListFeatures
()
{
// Construct request
const
request
=
{
};
// Run request
const
iterable
=
await
gkehubClient
.
listFeaturesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListFeatures
();
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
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 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
]>;
Updates an existing Feature.
Parameters
Name
Description
request
protos. google.cloud.gkehub.v1alpha.IUpdateFeatureRequest
The request object that will be sent.
options
Returns
Type
Description
Promise
<[ LROperation
<protos. google.cloud.gkehub.v1alpha.IFeature
, protos. google.cloud.gkehub.v1alpha.IOperationMetadata
>,
protos. google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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.
*/
/**
* 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 = {}
/**
* 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
'
).
v1alpha
;
// 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
.
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
