The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.
The GKE Hub service operates on the following resources:
* Membership * Feature
GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones . Feature is only available in global region while membership is global region and all the regions.
**Membership management may be non-trivial:** it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources. v1
Package
@google-cloud/gke-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 fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new GkeHubClient({fallback: true}, gax); ```
Properties
apiEndpoint
get
apiEndpoint
()
:
string
;
The DNS address for this API service.
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath.
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
gkeHubStub
gkeHubStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
universeDomain
get
universeDomain
()
:
string
;
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
checkCreateFeatureProgress(name)
checkCreateFeatureProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
Feature
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createFeature()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
< protos.google.cloud.gkehub.v1.Feature
, protos.google.cloud.gkehub.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent (project and location) where the Feature will be created.
* Specified in the format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* The ID of the feature to create.
*/
// const featureId = 'abc123'
/**
* The Feature resource to create.
*/
// const resource = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callCreateFeature
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
createFeature
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateFeature
();
checkCreateMembershipProgress(name)
checkCreateMembershipProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
Membership
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createMembership()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
< protos.google.cloud.gkehub.v1.Membership
, protos.google.cloud.gkehub.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent (project and location) where the Memberships will be
* created. Specified in the format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. Client chosen ID for the membership. `membership_id` must be a
* valid RFC 1123 compliant DNS label:
* 1. At most 63 characters in length
* 2. It must consist of lower case alphanumeric characters or `-`
* 3. It must start and end with an alphanumeric character
* Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`,
* with a maximum length of 63 characters.
*/
// const membershipId = 'abc123'
/**
* Required. The membership to create.
*/
// const resource = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callCreateMembership
()
{
// Construct request
const
request
=
{
parent
,
membershipId
,
resource
,
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
createMembership
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateMembership
();
checkDeleteFeatureProgress(name)
checkDeleteFeatureProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteFeature()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.cloud.gkehub.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Feature resource name in the format
* `projects/* /locations/* /features/*`.
*/
// const name = 'abc123'
/**
* If set to true, the delete will ignore any outstanding resources for
* this Feature (that is, `FeatureState.has_resources` is set to true). These
* resources will NOT be cleaned up or modified in any way.
*/
// const force = true
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callDeleteFeature
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
deleteFeature
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteFeature
();
checkDeleteMembershipProgress(name)
checkDeleteMembershipProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteMembership()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.cloud.gkehub.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Membership resource name in the format
* `projects/* /locations/* /memberships/*`.
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. If set to true, any subresource from this Membership will also be
* deleted. Otherwise, the request will only work if the Membership has no
* subresource.
*/
// const force = true
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callDeleteMembership
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
deleteMembership
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteMembership
();
checkUpdateFeatureProgress(name)
checkUpdateFeatureProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
Feature
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateFeature()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
< protos.google.cloud.gkehub.v1.Feature
, protos.google.cloud.gkehub.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Feature resource name in the format
* `projects/* /locations/* /features/*`.
*/
// const name = 'abc123'
/**
* Mask of fields to update.
*/
// const updateMask = {}
/**
* Only fields specified in update_mask are updated.
* If you specify a field in the update_mask but don't specify its value here
* that field will be deleted.
* If you are updating a map field, set the value of a key to null or empty
* string to delete the key from the map. It's not possible to update a key's
* value to the empty string.
* If you specify the update_mask to be a special path "*", fully replaces all
* user-modifiable fields to match `resource`.
*/
// const resource = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callUpdateFeature
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
updateFeature
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateFeature
();
checkUpdateMembershipProgress(name)
checkUpdateMembershipProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
Membership
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateMembership()
.
Parameter
Name
Description
name
string
The operation name that will be passed.
Returns
Type
Description
Promise
< LROperation
< protos.google.cloud.gkehub.v1.Membership
, protos.google.cloud.gkehub.v1.OperationMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Membership resource name in the format
* `projects/* /locations/* /memberships/*`.
*/
// const name = 'abc123'
/**
* Required. Mask of fields to update.
*/
// const updateMask = {}
/**
* Required. Only fields specified in update_mask are updated.
* If you specify a field in the update_mask but don't specify its value here
* that field will be deleted.
* If you are updating a map field, set the value of a key to null or empty
* string to delete the key from the map. It's not possible to update a key's
* value to the empty string.
* If you specify the update_mask to be a special path "*", fully replaces all
* user-modifiable fields to match `resource`.
*/
// const resource = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callUpdateMembership
()
{
// Construct request
const
request
=
{
name
,
updateMask
,
resource
,
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
updateMembership
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateMembership
();
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns
Type
Description
Promise
<void>
{Promise} A promise that resolves when the client is closed.
createFeature(request, options)
createFeature
(
request
?:
protos
.
google
.
cloud
.
gkehub
.
v1
.
ICreateFeatureRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
IFeature
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Adds a new Feature.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ LROperation
< protos.google.cloud.gkehub.v1.IFeature
, protos.google.cloud.gkehub.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent (project and location) where the Feature will be created.
* Specified in the format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* The ID of the feature to create.
*/
// const featureId = 'abc123'
/**
* The Feature resource to create.
*/
// const resource = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callCreateFeature
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
createFeature
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateFeature
();
createFeature(request, options, callback)
createFeature
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
ICreateFeatureRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
IFeature
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
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
]>;
Creates a new Membership.
**This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster .
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ LROperation
< protos.google.cloud.gkehub.v1.IMembership
, protos.google.cloud.gkehub.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent (project and location) where the Memberships will be
* created. Specified in the format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* Required. Client chosen ID for the membership. `membership_id` must be a
* valid RFC 1123 compliant DNS label:
* 1. At most 63 characters in length
* 2. It must consist of lower case alphanumeric characters or `-`
* 3. It must start and end with an alphanumeric character
* Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`,
* with a maximum length of 63 characters.
*/
// const membershipId = 'abc123'
/**
* Required. The membership to create.
*/
// const resource = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callCreateMembership
()
{
// Construct request
const
request
=
{
parent
,
membershipId
,
resource
,
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
createMembership
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callCreateMembership
();
createMembership(request, options, callback)
createMembership
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
ICreateMembershipRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
IMembership
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
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
]>;
Removes a Feature.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.gkehub.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Feature resource name in the format
* `projects/* /locations/* /features/*`.
*/
// const name = 'abc123'
/**
* If set to true, the delete will ignore any outstanding resources for
* this Feature (that is, `FeatureState.has_resources` is set to true). These
* resources will NOT be cleaned up or modified in any way.
*/
// const force = true
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callDeleteFeature
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
deleteFeature
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteFeature
();
deleteFeature(request, options, callback)
deleteFeature
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IDeleteFeatureRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.gkehub.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
deleteMembership(request, options)
deleteMembership
(
request
?:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IDeleteMembershipRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Removes a Membership.
**This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster .
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.gkehub.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Membership resource name in the format
* `projects/* /locations/* /memberships/*`.
*/
// const name = 'abc123'
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
/**
* Optional. If set to true, any subresource from this Membership will also be
* deleted. Otherwise, the request will only work if the Membership has no
* subresource.
*/
// const force = true
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callDeleteMembership
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
deleteMembership
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteMembership
();
deleteMembership(request, options, callback)
deleteMembership
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IDeleteMembershipRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.gkehub.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
featurePath(project, location, feature)
featurePath
(
project
:
string
,
location
:
string
,
feature
:
string
)
:
string
;
Return a fully-qualified feature resource name string.
Parameters
Name
Description
project
string
location
string
feature
string
Returns
Type
Description
string
{string} Resource name string.
generateConnectManifest(request, options)
generateConnectManifest
(
request
?:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGenerateConnectManifestRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGenerateConnectManifestResponse
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGenerateConnectManifestRequest
|
undefined
,
{}
|
undefined
]>;
Generates the manifest for deployment of the GKE connect agent.
**This method is used internally by Google-provided libraries.** Most clients should not need to call this method directly.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.gkehub.v1.IGenerateConnectManifestResponse
, protos.google.cloud.gkehub.v1.IGenerateConnectManifestRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateConnectManifestResponse . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Membership resource name the Agent will associate with, in
* the format `projects/* /locations/* /memberships/*`.
*/
// const name = 'abc123'
/**
* Optional. Namespace for GKE Connect agent resources. Defaults to
* `gke-connect`.
* The Connect Agent is authorized automatically when run in the default
* namespace. Otherwise, explicit authorization must be granted with an
* additional IAM binding.
*/
// const namespace = 'abc123'
/**
* Optional. URI of a proxy if connectivity from the agent to
* gkeconnect.googleapis.com requires the use of a proxy. Format must be in
* the form `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol
* supported by the proxy. This will direct the connect agent's outbound
* traffic through a HTTP(S) proxy.
*/
// const proxy = Buffer.from('string')
/**
* Optional. The Connect agent version to use. Defaults to the most current
* version.
*/
// const version = 'abc123'
/**
* Optional. If true, generate the resources for upgrade only. Some resources
* generated only for installation (e.g. secrets) will be excluded.
*/
// const isUpgrade = true
/**
* Optional. The registry to fetch the connect agent image from. Defaults to
* gcr.io/gkeconnect.
*/
// const registry = 'abc123'
/**
* Optional. The image pull secret content for the registry, if not public.
*/
// const imagePullSecretContent = Buffer.from('string')
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callGenerateConnectManifest
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
gkehubClient
.
generateConnectManifest
(
request
);
console
.
log
(
response
);
}
callGenerateConnectManifest
();
generateConnectManifest(request, options, callback)
generateConnectManifest
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGenerateConnectManifestRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
gkehub
.
v1
.
IGenerateConnectManifestResponse
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGenerateConnectManifestRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
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
]>;
Gets details of a single Feature.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.gkehub.v1.IFeature
, protos.google.cloud.gkehub.v1.IGetFeatureRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Feature . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Feature resource name in the format
* `projects/* /locations/* /features/*`
*/
// const name = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callGetFeature
()
{
// Construct request
const
request
=
{
};
// Run request
const
response
=
await
gkehubClient
.
getFeature
(
request
);
console
.
log
(
response
);
}
callGetFeature
();
getFeature(request, options, callback)
getFeature
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGetFeatureRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
gkehub
.
v1
.
IFeature
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGetFeatureRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
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
]>;
Gets the details of a Membership.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.gkehub.v1.IMembership
, protos.google.cloud.gkehub.v1.IGetMembershipRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Membership . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Membership resource name in the format
* `projects/* /locations/* /memberships/*`.
*/
// const name = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callGetMembership
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
gkehubClient
.
getMembership
(
request
);
console
.
log
(
response
);
}
callGetMembership
();
getMembership(request, options, callback)
getMembership
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGetMembershipRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
gkehub
.
v1
.
IMembership
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IGetMembershipRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
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
]>;
Lists Features in a given project and location.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.gkehub.v1.IFeature
[], protos.google.cloud.gkehub.v1.IListFeaturesRequest
| null, protos.google.cloud.gkehub.v1.IListFeaturesResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Feature
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listFeaturesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listFeatures(request, options, callback)
listFeatures
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListFeaturesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
gkehub
.
v1
.
IListFeaturesRequest
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListFeaturesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IFeature
> )
:
void
;
Parameters
Name
Description
request
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
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
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.gkehub.v1.IFeature
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Feature . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent (project and location) where the Features will be listed.
* Specified in the format `projects/* /locations/*`.
*/
// const parent = 'abc123'
/**
* When requesting a 'page' of resources, `page_size` specifies number of
* resources to return. If unspecified or set to 0, all resources will
* be returned.
*/
// const pageSize = 1234
/**
* Token returned by previous call to `ListFeatures` which
* specifies the position in the list from where to continue listing the
* resources.
*/
// const pageToken = 'abc123'
/**
* Lists Features that match the filter expression, following the syntax
* outlined in https://google.aip.dev/160.
* Examples:
* - Feature with the name "servicemesh" in project "foo-proj":
* name = "projects/foo-proj/locations/global/features/servicemesh"
* - Features that have a label called `foo`:
* labels.foo:*
* - Features that have a label called `foo` whose value is `bar`:
* labels.foo = bar
*/
// const filter = 'abc123'
/**
* One or more fields to compare and use to sort the output.
* See https://google.aip.dev/132#ordering.
*/
// const orderBy = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callListFeatures
()
{
// Construct request
const
request
=
{
};
// Run request
const
iterable
=
gkehubClient
.
listFeaturesAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListFeatures
();
listFeaturesStream(request, options)
listFeaturesStream
(
request
?:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListFeaturesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listFeatures
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing Feature
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listFeaturesAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listMemberships(request, options)
listMemberships
(
request
?:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListMembershipsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
gkehub
.
v1
.
IMembership
[],
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListMembershipsRequest
|
null
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListMembershipsResponse
]>;
Lists Memberships in a given project and location.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.gkehub.v1.IMembership
[], protos.google.cloud.gkehub.v1.IListMembershipsRequest
| null, protos.google.cloud.gkehub.v1.IListMembershipsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Membership
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listMembershipsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listMemberships(request, options, callback)
listMemberships
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListMembershipsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
gkehub
.
v1
.
IListMembershipsRequest
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListMembershipsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IMembership
> )
:
void
;
Parameters
Name
Description
request
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
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
options
Returns
Type
Description
AsyncIterable
< protos.google.cloud.gkehub.v1.IMembership
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Membership . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent (project and location) where the Memberships will be
* listed. Specified in the format `projects/* /locations/*`.
* `projects/* /locations/-` list memberships in all the regions.
*/
// const parent = 'abc123'
/**
* Optional. When requesting a 'page' of resources, `page_size` specifies
* number of resources to return. If unspecified or set to 0, all resources
* will be returned.
*/
// const pageSize = 1234
/**
* Optional. Token returned by previous call to `ListMemberships` which
* specifies the position in the list from where to continue listing the
* resources.
*/
// const pageToken = 'abc123'
/**
* Optional. Lists Memberships that match the filter expression, following the
* syntax outlined in https://google.aip.dev/160.
* Examples:
* - Name is `bar` in project `foo-proj` and location `global`:
* name = "projects/foo-proj/locations/global/membership/bar"
* - Memberships that have a label called `foo`:
* labels.foo:*
* - Memberships that have a label called `foo` whose value is `bar`:
* labels.foo = bar
* - Memberships in the CREATING state:
* state = CREATING
*/
// const filter = 'abc123'
/**
* Optional. One or more fields to compare and use to sort the output.
* See https://google.aip.dev/132#ordering.
*/
// const orderBy = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callListMemberships
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
gkehubClient
.
listMembershipsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListMemberships
();
listMembershipsStream(request, options)
listMembershipsStream
(
request
?:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IListMembershipsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listMemberships
, but returns a NodeJS Stream object.
Parameters
Name
Description
request
options
Returns
Type
Description
Transform
{Stream} An object stream which emits an object representing Membership
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listMembershipsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
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
]>;
Updates an existing Feature.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ LROperation
< protos.google.cloud.gkehub.v1.IFeature
, protos.google.cloud.gkehub.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Feature resource name in the format
* `projects/* /locations/* /features/*`.
*/
// const name = 'abc123'
/**
* Mask of fields to update.
*/
// const updateMask = {}
/**
* Only fields specified in update_mask are updated.
* If you specify a field in the update_mask but don't specify its value here
* that field will be deleted.
* If you are updating a map field, set the value of a key to null or empty
* string to delete the key from the map. It's not possible to update a key's
* value to the empty string.
* If you specify the update_mask to be a special path "*", fully replaces all
* user-modifiable fields to match `resource`.
*/
// const resource = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callUpdateFeature
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
updateFeature
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateFeature
();
updateFeature(request, options, callback)
updateFeature
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IUpdateFeatureRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
IFeature
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
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
]>;
Updates an existing Membership.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ LROperation
< protos.google.cloud.gkehub.v1.IMembership
, protos.google.cloud.gkehub.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Membership resource name in the format
* `projects/* /locations/* /memberships/*`.
*/
// const name = 'abc123'
/**
* Required. Mask of fields to update.
*/
// const updateMask = {}
/**
* Required. Only fields specified in update_mask are updated.
* If you specify a field in the update_mask but don't specify its value here
* that field will be deleted.
* If you are updating a map field, set the value of a key to null or empty
* string to delete the key from the map. It's not possible to update a key's
* value to the empty string.
* If you specify the update_mask to be a special path "*", fully replaces all
* user-modifiable fields to match `resource`.
*/
// const resource = {}
/**
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Gkehub library
const
{
GkeHubClient
}
=
require
(
' @google-cloud/gke-hub
'
).
v1
;
// Instantiates a client
const
gkehubClient
=
new
GkeHubClient
();
async
function
callUpdateMembership
()
{
// Construct request
const
request
=
{
name
,
updateMask
,
resource
,
};
// Run request
const
[
operation
]
=
await
gkehubClient
.
updateMembership
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callUpdateMembership
();
updateMembership(request, options, callback)
updateMembership
(
request
:
protos
.
google
.
cloud
.
gkehub
.
v1
.
IUpdateMembershipRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
gkehub
.
v1
.
IMembership
,
protos
.
google
.
cloud
.
gkehub
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
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
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
