The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure. v1
Package
@google-cloud/gkemulticloudConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of AwsClustersClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
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;
awsClustersStub
awsClustersStub?: Promise<{
[name: string]: Function;
}>;
descriptors
descriptors: Descriptors;
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
attachedClusterPath(project, location, attachedCluster)
attachedClusterPath(project: string, location: string, attachedCluster: string): string;
Return a fully-qualified attachedCluster resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
attachedCluster |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
attachedServerConfigPath(project, location)
attachedServerConfigPath(project: string, location: string): string;
Return a fully-qualified attachedServerConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
awsClusterPath(project, location, awsCluster)
awsClusterPath(project: string, location: string, awsCluster: string): string;
Return a fully-qualified awsCluster resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
awsCluster |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
awsNodePoolPath(project, location, awsCluster, awsNodePool)
awsNodePoolPath(project: string, location: string, awsCluster: string, awsNodePool: string): string;
Return a fully-qualified awsNodePool resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
awsCluster |
string
|
awsNodePool |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
awsServerConfigPath(project, location)
awsServerConfigPath(project: string, location: string): string;
Return a fully-qualified awsServerConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
azureClientPath(project, location, azureClient)
azureClientPath(project: string, location: string, azureClient: string): string;
Return a fully-qualified azureClient resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
azureClient |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
azureClusterPath(project, location, azureCluster)
azureClusterPath(project: string, location: string, azureCluster: string): string;
Return a fully-qualified azureCluster resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
azureCluster |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
azureNodePoolPath(project, location, azureCluster, azureNodePool)
azureNodePoolPath(project: string, location: string, azureCluster: string, azureNodePool: string): string;
Return a fully-qualified azureNodePool resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
azureCluster |
string
|
azureNodePool |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
azureServerConfigPath(project, location)
azureServerConfigPath(project: string, location: string): string;
Return a fully-qualified azureServerConfig resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkCreateAwsClusterProgress(name)
checkCreateAwsClusterProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;
Check the status of the long running operation returned by createAwsCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsCluster, protos.google.cloud.gkemulticloud.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 location where this
* AwsCluster google.cloud.gkemulticloud.v1.AwsCluster resource will be
* created.
* Location names are formatted as `projects/
checkCreateAwsNodePoolProgress(name)
checkCreateAwsNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;
Check the status of the long running operation returned by createAwsNodePool()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.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 AwsCluster google.cloud.gkemulticloud.v1.AwsCluster
* resource where this node pool will be created.
* `AwsCluster` names are formatted as
* `projects/
checkDeleteAwsClusterProgress(name)
checkDeleteAwsClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteAwsCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.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 resource name the
* AwsCluster google.cloud.gkemulticloud.v1.AwsCluster to delete.
* `AwsCluster` names are formatted as
* `projects/
checkDeleteAwsNodePoolProgress(name)
checkDeleteAwsNodePoolProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;
Check the status of the long running operation returned by deleteAwsNodePool()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.gkemulticloud.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 resource name the
* AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool to delete.
* `AwsNodePool` names are formatted as
* `projects/
checkRollbackAwsNodePoolUpdateProgress(name)
checkRollbackAwsNodePoolUpdateProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;
Check the status of the long running operation returned by rollbackAwsNodePoolUpdate()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.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 name of the
* AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool resource to
* rollback.
* `AwsNodePool` names are formatted as
* `projects/
checkUpdateAwsClusterProgress(name)
checkUpdateAwsClusterProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsCluster, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateAwsCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsCluster, protos.google.cloud.gkemulticloud.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 AwsCluster google.cloud.gkemulticloud.v1.AwsCluster
* resource to update.
*/
// const awsCluster = {}
/**
* If set, only validate the request, but do not actually update the cluster.
*/
// const validateOnly = true
/**
* Required. Mask of fields to update. At least one path must be supplied in
* this field. The elements of the repeated paths field can only include these
* fields from AwsCluster google.cloud.gkemulticloud.v1.AwsCluster:
* * `description`.
* * `annotations`.
* * `control_plane.version`.
* * `authorization.admin_users`.
* * `authorization.admin_groups`.
* * `binary_authorization.evaluation_mode`.
* * `control_plane.aws_services_authentication.role_arn`.
* * `control_plane.aws_services_authentication.role_session_name`.
* * `control_plane.config_encryption.kms_key_arn`.
* * `control_plane.instance_type`.
* * `control_plane.security_group_ids`.
* * `control_plane.proxy_config`.
* * `control_plane.proxy_config.secret_arn`.
* * `control_plane.proxy_config.secret_version`.
* * `control_plane.root_volume.size_gib`.
* * `control_plane.root_volume.volume_type`.
* * `control_plane.root_volume.iops`.
* * `control_plane.root_volume.throughput`.
* * `control_plane.root_volume.kms_key_arn`.
* * `control_plane.ssh_config`.
* * `control_plane.ssh_config.ec2_key_pair`.
* * `control_plane.instance_placement.tenancy`.
* * `control_plane.iam_instance_profile`.
* * `logging_config.component_config.enable_components`.
* * `control_plane.tags`.
* * `monitoring_config.managed_prometheus_config.enabled`.
* * `networking.per_node_pool_sg_rules_disabled`.
*/
// const updateMask = {}
// Imports the Gkemulticloud library
const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;
// Instantiates a client
const gkemulticloudClient = new AwsClustersClient();
async function callUpdateAwsCluster() {
// Construct request
const request = {
awsCluster,
updateMask,
};
// Run request
const [operation] = await gkemulticloudClient.updateAwsCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateAwsCluster();
checkUpdateAwsNodePoolProgress(name)
checkUpdateAwsNodePoolProgress(name: string): Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.v1.OperationMetadata>>;
Check the status of the long running operation returned by updateAwsNodePool()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.gkemulticloud.v1.AwsNodePool, protos.google.cloud.gkemulticloud.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 AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool
* resource to update.
*/
// const awsNodePool = {}
/**
* If set, only validate the request, but don't actually update the node pool.
*/
// const validateOnly = true
/**
* Required. Mask of fields to update. At least one path must be supplied in
* this field. The elements of the repeated paths field can only include these
* fields from AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool:
* * `annotations`.
* * `version`.
* * `autoscaling.min_node_count`.
* * `autoscaling.max_node_count`.
* * `config.config_encryption.kms_key_arn`.
* * `config.security_group_ids`.
* * `config.root_volume.iops`.
* * `config.root_volume.throughput`.
* * `config.root_volume.kms_key_arn`.
* * `config.root_volume.volume_type`.
* * `config.root_volume.size_gib`.
* * `config.proxy_config`.
* * `config.proxy_config.secret_arn`.
* * `config.proxy_config.secret_version`.
* * `config.ssh_config`.
* * `config.ssh_config.ec2_key_pair`.
* * `config.instance_placement.tenancy`.
* * `config.iam_instance_profile`.
* * `config.labels`.
* * `config.tags`.
* * `config.autoscaling_metrics_collection`.
* * `config.autoscaling_metrics_collection.granularity`.
* * `config.autoscaling_metrics_collection.metrics`.
* * `config.instance_type`.
* * `management.auto_repair`.
* * `management`.
* * `update_settings`.
* * `update_settings.surge_settings`.
* * `update_settings.surge_settings.max_surge`.
* * `update_settings.surge_settings.max_unavailable`.
*/
// const updateMask = {}
// Imports the Gkemulticloud library
const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;
// Instantiates a client
const gkemulticloudClient = new AwsClustersClient();
async function callUpdateAwsNodePool() {
// Construct request
const request = {
awsNodePool,
updateMask,
};
// Run request
const [operation] = await gkemulticloudClient.updateAwsNodePool(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateAwsNodePool();
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. |
createAwsCluster(request, options)
createAwsCluster(request?: protos.google.cloud.gkemulticloud.v1.ICreateAwsClusterRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new resource on a given Google Cloud Platform project and region.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
ICreateAwsClusterRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.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 |
/**
* 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 location where this
* AwsCluster google.cloud.gkemulticloud.v1.AwsCluster resource will be
* created.
* Location names are formatted as `projects/
createAwsCluster(request, options, callback)
createAwsCluster(request: protos.google.cloud.gkemulticloud.v1.ICreateAwsClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateAwsClusterRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createAwsCluster(request, callback)
createAwsCluster(request: protos.google.cloud.gkemulticloud.v1.ICreateAwsClusterRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateAwsClusterRequest
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createAwsNodePool(request, options)
createAwsNodePool(request?: protos.google.cloud.gkemulticloud.v1.ICreateAwsNodePoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new , attached to a given .
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
ICreateAwsNodePoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.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 |
/**
* 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 AwsCluster google.cloud.gkemulticloud.v1.AwsCluster
* resource where this node pool will be created.
* `AwsCluster` names are formatted as
* `projects/
createAwsNodePool(request, options, callback)
createAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.ICreateAwsNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateAwsNodePoolRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createAwsNodePool(request, callback)
createAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.ICreateAwsNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateAwsNodePoolRequest
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteAwsCluster(request, options)
deleteAwsCluster(request?: protos.google.cloud.gkemulticloud.v1.IDeleteAwsClusterRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a specific resource.
Fails if the cluster has one or more associated resources.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
IDeleteAwsClusterRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.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 |
/**
* 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 resource name the
* AwsCluster google.cloud.gkemulticloud.v1.AwsCluster to delete.
* `AwsCluster` names are formatted as
* `projects/
deleteAwsCluster(request, options, callback)
deleteAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IDeleteAwsClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteAwsClusterRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteAwsCluster(request, callback)
deleteAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IDeleteAwsClusterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteAwsClusterRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteAwsNodePool(request, options)
deleteAwsNodePool(request?: protos.google.cloud.gkemulticloud.v1.IDeleteAwsNodePoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a specific resource.
If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.
Parameters | |
---|---|
Name | Description |
request |
IDeleteAwsNodePoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.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 |
/**
* 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 resource name the
* AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool to delete.
* `AwsNodePool` names are formatted as
* `projects/
deleteAwsNodePool(request, options, callback)
deleteAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IDeleteAwsNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteAwsNodePoolRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteAwsNodePool(request, callback)
deleteAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IDeleteAwsNodePoolRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteAwsNodePoolRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteOperation(request, options, callback)
deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
generateAwsAccessToken(request, options)
generateAwsAccessToken(request?: protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse,
(protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | undefined),
{} | undefined
]>;
Generates a short-lived access token to authenticate to a given resource.
Parameters | |
---|---|
Name | Description |
request |
IGenerateAwsAccessTokenRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse,
(protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateAwsAccessTokenResponse. 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 name of the
* AwsCluster google.cloud.gkemulticloud.v1.AwsCluster resource to
* authenticate to.
* `AwsCluster` names are formatted as
* `projects/
generateAwsAccessToken(request, options, callback)
generateAwsAccessToken(request: protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGenerateAwsAccessTokenRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
generateAwsAccessToken(request, callback)
generateAwsAccessToken(request: protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGenerateAwsAccessTokenRequest
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsAccessTokenRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
generateAwsClusterAgentToken(request, options)
generateAwsClusterAgentToken(request?: protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenResponse,
(protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest | undefined),
{} | undefined
]>;
Generates an access token for a cluster agent.
Parameters | |
---|---|
Name | Description |
request |
IGenerateAwsClusterAgentTokenRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenResponse,
(protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateAwsClusterAgentTokenResponse. 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.
*/
// const awsCluster = 'abc123'
/**
* Required.
*/
// const subjectToken = 'abc123'
/**
* Required.
*/
// const subjectTokenType = 'abc123'
/**
* Required.
*/
// const version = 'abc123'
/**
* Optional.
*/
// const nodePoolId = 'abc123'
/**
* Optional.
*/
// const grantType = 'abc123'
/**
* Optional.
*/
// const audience = 'abc123'
/**
* Optional.
*/
// const scope = 'abc123'
/**
* Optional.
*/
// const requestedTokenType = 'abc123'
/**
* Optional.
*/
// const options = 'abc123'
// Imports the Gkemulticloud library
const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;
// Instantiates a client
const gkemulticloudClient = new AwsClustersClient();
async function callGenerateAwsClusterAgentToken() {
// Construct request
const request = {
awsCluster,
subjectToken,
subjectTokenType,
version,
};
// Run request
const response = await gkemulticloudClient.generateAwsClusterAgentToken(request);
console.log(response);
}
callGenerateAwsClusterAgentToken();
generateAwsClusterAgentToken(request, options, callback)
generateAwsClusterAgentToken(request: protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGenerateAwsClusterAgentTokenRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
generateAwsClusterAgentToken(request, callback)
generateAwsClusterAgentToken(request: protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGenerateAwsClusterAgentTokenRequest
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenResponse, protos.google.cloud.gkemulticloud.v1.IGenerateAwsClusterAgentTokenRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsCluster(request, options)
getAwsCluster(request?: protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsCluster,
protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | undefined,
{} | undefined
]>;
Describes a specific resource.
Parameters | |
---|---|
Name | Description |
request |
IGetAwsClusterRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsCluster,
protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 name of the
* AwsCluster google.cloud.gkemulticloud.v1.AwsCluster resource to
* describe.
* `AwsCluster` names are formatted as
* `projects/
getAwsCluster(request, options, callback)
getAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsClusterRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsCluster(request, callback)
getAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsClusterRequest
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IGetAwsClusterRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsJsonWebKeys(request, options)
getAwsJsonWebKeys(request?: protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsJsonWebKeys,
(protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest | undefined),
{} | undefined
]>;
Gets the public component of the cluster signing keys in JSON Web Key format.
Parameters | |
---|---|
Name | Description |
request |
IGetAwsJsonWebKeysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsJsonWebKeys,
(protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing AwsJsonWebKeys. 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 AwsCluster, which owns the JsonWebKeys.
* Format:
* projects/{project}/locations/{location}/awsClusters/{cluster}
*/
// const awsCluster = 'abc123'
// Imports the Gkemulticloud library
const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;
// Instantiates a client
const gkemulticloudClient = new AwsClustersClient();
async function callGetAwsJsonWebKeys() {
// Construct request
const request = {
awsCluster,
};
// Run request
const response = await gkemulticloudClient.getAwsJsonWebKeys(request);
console.log(response);
}
callGetAwsJsonWebKeys();
getAwsJsonWebKeys(request, options, callback)
getAwsJsonWebKeys(request: protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsJsonWebKeys, protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsJsonWebKeysRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsJsonWebKeys, protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsJsonWebKeys(request, callback)
getAwsJsonWebKeys(request: protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsJsonWebKeys, protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsJsonWebKeysRequest
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsJsonWebKeys, protos.google.cloud.gkemulticloud.v1.IGetAwsJsonWebKeysRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsNodePool(request, options)
getAwsNodePool(request?: protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsNodePool,
protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | undefined,
{} | undefined
]>;
Describes a specific resource.
Parameters | |
---|---|
Name | Description |
request |
IGetAwsNodePoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsNodePool,
protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 name of the
* AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool resource to
* describe.
* `AwsNodePool` names are formatted as
* `projects/
getAwsNodePool(request, options, callback)
getAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsNodePoolRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsNodePool(request, callback)
getAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsNodePoolRequest
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IGetAwsNodePoolRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsOpenIdConfig(request, options)
getAwsOpenIdConfig(request?: protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsOpenIdConfig,
(protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest | undefined),
{} | undefined
]>;
Gets the OIDC discovery document for the cluster. See the [OpenID Connect Discovery 1.0 specification](https://openid.net/specs/openid-connect-discovery-1_0.html) for details.
Parameters | |
---|---|
Name | Description |
request |
IGetAwsOpenIdConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsOpenIdConfig,
(protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing AwsOpenIdConfig. 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 AwsCluster, which owns the OIDC discovery document.
* Format:
* projects/{project}/locations/{location}/awsClusters/{cluster}
*/
// const awsCluster = 'abc123'
// Imports the Gkemulticloud library
const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;
// Instantiates a client
const gkemulticloudClient = new AwsClustersClient();
async function callGetAwsOpenIdConfig() {
// Construct request
const request = {
awsCluster,
};
// Run request
const response = await gkemulticloudClient.getAwsOpenIdConfig(request);
console.log(response);
}
callGetAwsOpenIdConfig();
getAwsOpenIdConfig(request, options, callback)
getAwsOpenIdConfig(request: protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsOpenIdConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsOpenIdConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsOpenIdConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsOpenIdConfig(request, callback)
getAwsOpenIdConfig(request: protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsOpenIdConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsOpenIdConfigRequest
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsOpenIdConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsOpenIdConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsServerConfig(request, options)
getAwsServerConfig(request?: protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsServerConfig,
(protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | undefined),
{} | undefined
]>;
Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.
Parameters | |
---|---|
Name | Description |
request |
IGetAwsServerConfigRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsServerConfig,
(protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | undefined),
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing AwsServerConfig. 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 name of the
* AwsServerConfig google.cloud.gkemulticloud.v1.AwsServerConfig resource
* to describe.
* `AwsServerConfig` names are formatted as
* `projects/
getAwsServerConfig(request, options, callback)
getAwsServerConfig(request: protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsServerConfigRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getAwsServerConfig(request, callback)
getAwsServerConfig(request: protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest, callback: Callback<protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetAwsServerConfigRequest
|
callback |
Callback<protos.google.cloud.gkemulticloud.v1.IAwsServerConfig, protos.google.cloud.gkemulticloud.v1.IGetAwsServerConfigRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getOperation(request, options, callback)
getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters | |
---|---|
Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>
The function which will be called with the result of the API call. The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
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. |
listAwsClusters(request, options)
listAwsClusters(request?: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsCluster[],
protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest | null,
protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse
]>;
Lists all resources on a given Google Cloud project and region.
Parameters | |
---|---|
Name | Description |
request |
IListAwsClustersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsCluster[],
protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest | null,
protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse
]> |
{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 |
listAwsClusters(request, options, callback)
listAwsClusters(request: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsCluster>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAwsClustersRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsCluster>
|
Returns | |
---|---|
Type | Description |
void |
listAwsClusters(request, callback)
listAwsClusters(request: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsCluster>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAwsClustersRequest
|
callback |
PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, protos.google.cloud.gkemulticloud.v1.IListAwsClustersResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsCluster>
|
Returns | |
---|---|
Type | Description |
void |
listAwsClustersAsync(request, options)
listAwsClustersAsync(request?: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAwsCluster>;
Equivalent to listAwsClusters
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListAwsClustersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAwsCluster> |
{Object} An iterable Object that allows async iteration. 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 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 location which owns this collection of
* AwsCluster google.cloud.gkemulticloud.v1.AwsCluster resources.
* Location names are formatted as `projects/
listAwsClustersStream(request, options)
listAwsClustersStream(request?: protos.google.cloud.gkemulticloud.v1.IListAwsClustersRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListAwsClustersRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform |
{Stream} An object stream which emits an object representing 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 |
listAwsNodePools(request, options)
listAwsNodePools(request?: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, options?: CallOptions): Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsNodePool[],
protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest | null,
protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse
]>;
Lists all resources on a given .
Parameters | |
---|---|
Name | Description |
request |
IListAwsNodePoolsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.gkemulticloud.v1.IAwsNodePool[],
protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest | null,
protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse
]> |
{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 |
listAwsNodePools(request, options, callback)
listAwsNodePools(request: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsNodePool>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAwsNodePoolsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsNodePool>
|
Returns | |
---|---|
Type | Description |
void |
listAwsNodePools(request, callback)
listAwsNodePools(request: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, callback: PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsNodePool>): void;
Parameters | |
---|---|
Name | Description |
request |
IListAwsNodePoolsRequest
|
callback |
PaginationCallback<protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsResponse | null | undefined, protos.google.cloud.gkemulticloud.v1.IAwsNodePool>
|
Returns | |
---|---|
Type | Description |
void |
listAwsNodePoolsAsync(request, options)
listAwsNodePoolsAsync(request?: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAwsNodePool>;
Equivalent to listAwsNodePools
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListAwsNodePoolsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.gkemulticloud.v1.IAwsNodePool> |
{Object} An iterable Object that allows async iteration. 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 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 `AwsCluster` which owns this collection of
* AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool resources.
* `AwsCluster` names are formatted as
* `projects/
listAwsNodePoolsStream(request, options)
listAwsNodePoolsStream(request?: protos.google.cloud.gkemulticloud.v1.IListAwsNodePoolsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListAwsNodePoolsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform |
{Stream} An object stream which emits an object representing 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 |
listOperationsAsync(request, options)
listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters | |
---|---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
options |
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.longrunning.ListOperationsResponse> |
{Object} An iterable Object that conforms to iteration protocols. |
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
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. |
matchAttachedClusterFromAttachedClusterName(attachedClusterName)
matchAttachedClusterFromAttachedClusterName(attachedClusterName: string): string | number;
Parse the attached_cluster from AttachedCluster resource.
Parameter | |
---|---|
Name | Description |
attachedClusterName |
string
A fully-qualified path representing AttachedCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the attached_cluster. |
matchAwsClusterFromAwsClusterName(awsClusterName)
matchAwsClusterFromAwsClusterName(awsClusterName: string): string | number;
Parse the aws_cluster from AwsCluster resource.
Parameter | |
---|---|
Name | Description |
awsClusterName |
string
A fully-qualified path representing AwsCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the aws_cluster. |
matchAwsClusterFromAwsNodePoolName(awsNodePoolName)
matchAwsClusterFromAwsNodePoolName(awsNodePoolName: string): string | number;
Parse the aws_cluster from AwsNodePool resource.
Parameter | |
---|---|
Name | Description |
awsNodePoolName |
string
A fully-qualified path representing AwsNodePool resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the aws_cluster. |
matchAwsNodePoolFromAwsNodePoolName(awsNodePoolName)
matchAwsNodePoolFromAwsNodePoolName(awsNodePoolName: string): string | number;
Parse the aws_node_pool from AwsNodePool resource.
Parameter | |
---|---|
Name | Description |
awsNodePoolName |
string
A fully-qualified path representing AwsNodePool resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the aws_node_pool. |
matchAzureClientFromAzureClientName(azureClientName)
matchAzureClientFromAzureClientName(azureClientName: string): string | number;
Parse the azure_client from AzureClient resource.
Parameter | |
---|---|
Name | Description |
azureClientName |
string
A fully-qualified path representing AzureClient resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the azure_client. |
matchAzureClusterFromAzureClusterName(azureClusterName)
matchAzureClusterFromAzureClusterName(azureClusterName: string): string | number;
Parse the azure_cluster from AzureCluster resource.
Parameter | |
---|---|
Name | Description |
azureClusterName |
string
A fully-qualified path representing AzureCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the azure_cluster. |
matchAzureClusterFromAzureNodePoolName(azureNodePoolName)
matchAzureClusterFromAzureNodePoolName(azureNodePoolName: string): string | number;
Parse the azure_cluster from AzureNodePool resource.
Parameter | |
---|---|
Name | Description |
azureNodePoolName |
string
A fully-qualified path representing AzureNodePool resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the azure_cluster. |
matchAzureNodePoolFromAzureNodePoolName(azureNodePoolName)
matchAzureNodePoolFromAzureNodePoolName(azureNodePoolName: string): string | number;
Parse the azure_node_pool from AzureNodePool resource.
Parameter | |
---|---|
Name | Description |
azureNodePoolName |
string
A fully-qualified path representing AzureNodePool resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the azure_node_pool. |
matchLocationFromAttachedClusterName(attachedClusterName)
matchLocationFromAttachedClusterName(attachedClusterName: string): string | number;
Parse the location from AttachedCluster resource.
Parameter | |
---|---|
Name | Description |
attachedClusterName |
string
A fully-qualified path representing AttachedCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAttachedServerConfigName(attachedServerConfigName)
matchLocationFromAttachedServerConfigName(attachedServerConfigName: string): string | number;
Parse the location from AttachedServerConfig resource.
Parameter | |
---|---|
Name | Description |
attachedServerConfigName |
string
A fully-qualified path representing AttachedServerConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAwsClusterName(awsClusterName)
matchLocationFromAwsClusterName(awsClusterName: string): string | number;
Parse the location from AwsCluster resource.
Parameter | |
---|---|
Name | Description |
awsClusterName |
string
A fully-qualified path representing AwsCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAwsNodePoolName(awsNodePoolName)
matchLocationFromAwsNodePoolName(awsNodePoolName: string): string | number;
Parse the location from AwsNodePool resource.
Parameter | |
---|---|
Name | Description |
awsNodePoolName |
string
A fully-qualified path representing AwsNodePool resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAwsServerConfigName(awsServerConfigName)
matchLocationFromAwsServerConfigName(awsServerConfigName: string): string | number;
Parse the location from AwsServerConfig resource.
Parameter | |
---|---|
Name | Description |
awsServerConfigName |
string
A fully-qualified path representing AwsServerConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAzureClientName(azureClientName)
matchLocationFromAzureClientName(azureClientName: string): string | number;
Parse the location from AzureClient resource.
Parameter | |
---|---|
Name | Description |
azureClientName |
string
A fully-qualified path representing AzureClient resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAzureClusterName(azureClusterName)
matchLocationFromAzureClusterName(azureClusterName: string): string | number;
Parse the location from AzureCluster resource.
Parameter | |
---|---|
Name | Description |
azureClusterName |
string
A fully-qualified path representing AzureCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAzureNodePoolName(azureNodePoolName)
matchLocationFromAzureNodePoolName(azureNodePoolName: string): string | number;
Parse the location from AzureNodePool resource.
Parameter | |
---|---|
Name | Description |
azureNodePoolName |
string
A fully-qualified path representing AzureNodePool resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAzureServerConfigName(azureServerConfigName)
matchLocationFromAzureServerConfigName(azureServerConfigName: string): string | number;
Parse the location from AzureServerConfig resource.
Parameter | |
---|---|
Name | Description |
azureServerConfigName |
string
A fully-qualified path representing AzureServerConfig 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. |
matchProjectFromAttachedClusterName(attachedClusterName)
matchProjectFromAttachedClusterName(attachedClusterName: string): string | number;
Parse the project from AttachedCluster resource.
Parameter | |
---|---|
Name | Description |
attachedClusterName |
string
A fully-qualified path representing AttachedCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAttachedServerConfigName(attachedServerConfigName)
matchProjectFromAttachedServerConfigName(attachedServerConfigName: string): string | number;
Parse the project from AttachedServerConfig resource.
Parameter | |
---|---|
Name | Description |
attachedServerConfigName |
string
A fully-qualified path representing AttachedServerConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAwsClusterName(awsClusterName)
matchProjectFromAwsClusterName(awsClusterName: string): string | number;
Parse the project from AwsCluster resource.
Parameter | |
---|---|
Name | Description |
awsClusterName |
string
A fully-qualified path representing AwsCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAwsNodePoolName(awsNodePoolName)
matchProjectFromAwsNodePoolName(awsNodePoolName: string): string | number;
Parse the project from AwsNodePool resource.
Parameter | |
---|---|
Name | Description |
awsNodePoolName |
string
A fully-qualified path representing AwsNodePool resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAwsServerConfigName(awsServerConfigName)
matchProjectFromAwsServerConfigName(awsServerConfigName: string): string | number;
Parse the project from AwsServerConfig resource.
Parameter | |
---|---|
Name | Description |
awsServerConfigName |
string
A fully-qualified path representing AwsServerConfig resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAzureClientName(azureClientName)
matchProjectFromAzureClientName(azureClientName: string): string | number;
Parse the project from AzureClient resource.
Parameter | |
---|---|
Name | Description |
azureClientName |
string
A fully-qualified path representing AzureClient resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAzureClusterName(azureClusterName)
matchProjectFromAzureClusterName(azureClusterName: string): string | number;
Parse the project from AzureCluster resource.
Parameter | |
---|---|
Name | Description |
azureClusterName |
string
A fully-qualified path representing AzureCluster resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAzureNodePoolName(azureNodePoolName)
matchProjectFromAzureNodePoolName(azureNodePoolName: string): string | number;
Parse the project from AzureNodePool resource.
Parameter | |
---|---|
Name | Description |
azureNodePoolName |
string
A fully-qualified path representing AzureNodePool resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAzureServerConfigName(azureServerConfigName)
matchProjectFromAzureServerConfigName(azureServerConfigName: string): string | number;
Parse the project from AzureServerConfig resource.
Parameter | |
---|---|
Name | Description |
azureServerConfigName |
string
A fully-qualified path representing AzureServerConfig 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. |
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. |
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. |
rollbackAwsNodePoolUpdate(request, options)
rollbackAwsNodePoolUpdate(request?: protos.google.cloud.gkemulticloud.v1.IRollbackAwsNodePoolUpdateRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Rolls back a previously aborted or failed update request. Makes no changes if the last update request successfully finished. If an update request is in progress, you cannot rollback the update. You must first cancel or let it finish unsuccessfully before you can rollback.
Parameters | |
---|---|
Name | Description |
request |
IRollbackAwsNodePoolUpdateRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.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 |
/**
* 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 name of the
* AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool resource to
* rollback.
* `AwsNodePool` names are formatted as
* `projects/
rollbackAwsNodePoolUpdate(request, options, callback)
rollbackAwsNodePoolUpdate(request: protos.google.cloud.gkemulticloud.v1.IRollbackAwsNodePoolUpdateRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRollbackAwsNodePoolUpdateRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
rollbackAwsNodePoolUpdate(request, callback)
rollbackAwsNodePoolUpdate(request: protos.google.cloud.gkemulticloud.v1.IRollbackAwsNodePoolUpdateRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IRollbackAwsNodePoolUpdateRequest
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateAwsCluster(request, options)
updateAwsCluster(request?: protos.google.cloud.gkemulticloud.v1.IUpdateAwsClusterRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates an .
Parameters | |
---|---|
Name | Description |
request |
IUpdateAwsClusterRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.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 |
/**
* 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 AwsCluster google.cloud.gkemulticloud.v1.AwsCluster
* resource to update.
*/
// const awsCluster = {}
/**
* If set, only validate the request, but do not actually update the cluster.
*/
// const validateOnly = true
/**
* Required. Mask of fields to update. At least one path must be supplied in
* this field. The elements of the repeated paths field can only include these
* fields from AwsCluster google.cloud.gkemulticloud.v1.AwsCluster:
* * `description`.
* * `annotations`.
* * `control_plane.version`.
* * `authorization.admin_users`.
* * `authorization.admin_groups`.
* * `binary_authorization.evaluation_mode`.
* * `control_plane.aws_services_authentication.role_arn`.
* * `control_plane.aws_services_authentication.role_session_name`.
* * `control_plane.config_encryption.kms_key_arn`.
* * `control_plane.instance_type`.
* * `control_plane.security_group_ids`.
* * `control_plane.proxy_config`.
* * `control_plane.proxy_config.secret_arn`.
* * `control_plane.proxy_config.secret_version`.
* * `control_plane.root_volume.size_gib`.
* * `control_plane.root_volume.volume_type`.
* * `control_plane.root_volume.iops`.
* * `control_plane.root_volume.throughput`.
* * `control_plane.root_volume.kms_key_arn`.
* * `control_plane.ssh_config`.
* * `control_plane.ssh_config.ec2_key_pair`.
* * `control_plane.instance_placement.tenancy`.
* * `control_plane.iam_instance_profile`.
* * `logging_config.component_config.enable_components`.
* * `control_plane.tags`.
* * `monitoring_config.managed_prometheus_config.enabled`.
* * `networking.per_node_pool_sg_rules_disabled`.
*/
// const updateMask = {}
// Imports the Gkemulticloud library
const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;
// Instantiates a client
const gkemulticloudClient = new AwsClustersClient();
async function callUpdateAwsCluster() {
// Construct request
const request = {
awsCluster,
updateMask,
};
// Run request
const [operation] = await gkemulticloudClient.updateAwsCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateAwsCluster();
updateAwsCluster(request, options, callback)
updateAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IUpdateAwsClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateAwsClusterRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateAwsCluster(request, callback)
updateAwsCluster(request: protos.google.cloud.gkemulticloud.v1.IUpdateAwsClusterRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateAwsClusterRequest
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsCluster, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateAwsNodePool(request, options)
updateAwsNodePool(request?: protos.google.cloud.gkemulticloud.v1.IUpdateAwsNodePoolRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Updates an .
Parameters | |
---|---|
Name | Description |
request |
IUpdateAwsNodePoolRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.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 |
/**
* 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 AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool
* resource to update.
*/
// const awsNodePool = {}
/**
* If set, only validate the request, but don't actually update the node pool.
*/
// const validateOnly = true
/**
* Required. Mask of fields to update. At least one path must be supplied in
* this field. The elements of the repeated paths field can only include these
* fields from AwsNodePool google.cloud.gkemulticloud.v1.AwsNodePool:
* * `annotations`.
* * `version`.
* * `autoscaling.min_node_count`.
* * `autoscaling.max_node_count`.
* * `config.config_encryption.kms_key_arn`.
* * `config.security_group_ids`.
* * `config.root_volume.iops`.
* * `config.root_volume.throughput`.
* * `config.root_volume.kms_key_arn`.
* * `config.root_volume.volume_type`.
* * `config.root_volume.size_gib`.
* * `config.proxy_config`.
* * `config.proxy_config.secret_arn`.
* * `config.proxy_config.secret_version`.
* * `config.ssh_config`.
* * `config.ssh_config.ec2_key_pair`.
* * `config.instance_placement.tenancy`.
* * `config.iam_instance_profile`.
* * `config.labels`.
* * `config.tags`.
* * `config.autoscaling_metrics_collection`.
* * `config.autoscaling_metrics_collection.granularity`.
* * `config.autoscaling_metrics_collection.metrics`.
* * `config.instance_type`.
* * `management.auto_repair`.
* * `management`.
* * `update_settings`.
* * `update_settings.surge_settings`.
* * `update_settings.surge_settings.max_surge`.
* * `update_settings.surge_settings.max_unavailable`.
*/
// const updateMask = {}
// Imports the Gkemulticloud library
const {AwsClustersClient} = require('@google-cloud/gkemulticloud').v1;
// Instantiates a client
const gkemulticloudClient = new AwsClustersClient();
async function callUpdateAwsNodePool() {
// Construct request
const request = {
awsNodePool,
updateMask,
};
// Run request
const [operation] = await gkemulticloudClient.updateAwsNodePool(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateAwsNodePool();
updateAwsNodePool(request, options, callback)
updateAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IUpdateAwsNodePoolRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateAwsNodePoolRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
updateAwsNodePool(request, callback)
updateAwsNodePool(request: protos.google.cloud.gkemulticloud.v1.IUpdateAwsNodePoolRequest, callback: Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IUpdateAwsNodePoolRequest
|
callback |
Callback<LROperation<protos.google.cloud.gkemulticloud.v1.IAwsNodePool, protos.google.cloud.gkemulticloud.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |