Anthos Multi-Cloud V1 API - Class Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client (v0.11.0)

Reference documentation and code samples for the Anthos Multi-Cloud V1 API class Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.

REST client for the AwsClusters service.

The AwsClusters API provides a single centrally managed service to create and manage Anthos clusters that run on AWS infrastructure.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the AwsClusters Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all AwsClusters clients
::Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the AwsClusters Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_aws_cluster

def create_aws_cluster(request, options = nil) -> ::Gapic::Operation
def create_aws_cluster(parent: nil, aws_cluster: nil, aws_cluster_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new AwsCluster 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.

Overloads 
def create_aws_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_aws_cluster via a request object, either of type CreateAwsClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::CreateAwsClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_aws_cluster(parent: nil, aws_cluster: nil, aws_cluster_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_aws_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location where this AwsCluster resource will be created.

    Location names are formatted as projects/<project-id>/locations/<region>.

    See Resource Names for more details on Google Cloud resource names.

  • aws_cluster (::Google::Cloud::GkeMultiCloud::V1::AwsCluster, ::Hash) — Required. The specification of the AwsCluster to create.
  • aws_cluster_id (::String) — Required. A client provided ID the resource. Must be unique within the parent resource.

    The provided ID will be part of the AwsCluster resource name formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

    Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually create the cluster.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::CreateAwsClusterRequest.new

# Call the create_aws_cluster method.
result = client.create_aws_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#create_aws_node_pool

def create_aws_node_pool(request, options = nil) -> ::Gapic::Operation
def create_aws_node_pool(parent: nil, aws_node_pool: nil, aws_node_pool_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new AwsNodePool, attached to a given AwsCluster.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Overloads 
def create_aws_node_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_aws_node_pool via a request object, either of type CreateAwsNodePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::CreateAwsNodePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def create_aws_node_pool(parent: nil, aws_node_pool: nil, aws_node_pool_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_aws_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The AwsCluster resource where this node pool will be created.

    AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

    See Resource Names for more details on Google Cloud resource names.

  • aws_node_pool (::Google::Cloud::GkeMultiCloud::V1::AwsNodePool, ::Hash) — Required. The specification of the AwsNodePool to create.
  • aws_node_pool_id (::String) — Required. A client provided ID the resource. Must be unique within the parent resource.

    The provided ID will be part of the AwsNodePool resource name formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

    Valid characters are /[a-z][0-9]-/. Cannot be longer than 63 characters.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually create the node pool.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::CreateAwsNodePoolRequest.new

# Call the create_aws_node_pool method.
result = client.create_aws_node_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_aws_cluster

def delete_aws_cluster(request, options = nil) -> ::Gapic::Operation
def delete_aws_cluster(name: nil, validate_only: nil, allow_missing: nil, ignore_errors: nil, etag: nil) -> ::Gapic::Operation

Deletes a specific AwsCluster resource.

Fails if the cluster has one or more associated AwsNodePool resources.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Overloads 
def delete_aws_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_aws_cluster via a request object, either of type DeleteAwsClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::DeleteAwsClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_aws_cluster(name: nil, validate_only: nil, allow_missing: nil, ignore_errors: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_aws_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The resource name the AwsCluster to delete.

    AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

    See Resource Names for more details on Google Cloud Platform resource names.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually delete the resource.
  • allow_missing (::Boolean) — If set to true, and the AwsCluster resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

    Useful for idempotent deletion.

  • ignore_errors (::Boolean) — Optional. If set to true, the deletion of AwsCluster resource will succeed even if errors occur during deleting in cluster resources. Using this parameter may result in orphaned resources in the cluster.
  • etag (::String) — The current etag of the AwsCluster.

    Allows clients to perform deletions through optimistic concurrency control.

    If the provided etag does not match the current etag of the cluster, the request will fail and an ABORTED error will be returned.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::DeleteAwsClusterRequest.new

# Call the delete_aws_cluster method.
result = client.delete_aws_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#delete_aws_node_pool

def delete_aws_node_pool(request, options = nil) -> ::Gapic::Operation
def delete_aws_node_pool(name: nil, validate_only: nil, allow_missing: nil, ignore_errors: nil, etag: nil) -> ::Gapic::Operation

Deletes a specific AwsNodePool resource.

If successful, the response contains a newly created Operation resource that can be described to track the status of the operation.

Overloads 
def delete_aws_node_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_aws_node_pool via a request object, either of type DeleteAwsNodePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::DeleteAwsNodePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def delete_aws_node_pool(name: nil, validate_only: nil, allow_missing: nil, ignore_errors: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_aws_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The resource name the AwsNodePool to delete.

    AwsNodePool names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

    See Resource Names for more details on Google Cloud resource names.

  • validate_only (::Boolean) — If set, only validate the request, but do not actually delete the node pool.
  • allow_missing (::Boolean) — If set to true, and the AwsNodePool resource is not found, the request will succeed but no action will be taken on the server and a completed Operation will be returned.

    Useful for idempotent deletion.

  • ignore_errors (::Boolean) — Optional. If set to true, the deletion of AwsNodePool resource will succeed even if errors occur during deleting in node pool resources. Using this parameter may result in orphaned resources in the node pool.
  • etag (::String) — The current ETag of the AwsNodePool.

    Allows clients to perform deletions through optimistic concurrency control.

    If the provided ETag does not match the current etag of the node pool, the request will fail and an ABORTED error will be returned.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::DeleteAwsNodePoolRequest.new

# Call the delete_aws_node_pool method.
result = client.delete_aws_node_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#generate_aws_access_token

def generate_aws_access_token(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAwsAccessTokenResponse
def generate_aws_access_token(aws_cluster: nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAwsAccessTokenResponse

Generates a short-lived access token to authenticate to a given AwsCluster resource.

Overloads 
def generate_aws_access_token(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAwsAccessTokenResponse
Pass arguments to generate_aws_access_token via a request object, either of type GenerateAwsAccessTokenRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GenerateAwsAccessTokenRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def generate_aws_access_token(aws_cluster: nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAwsAccessTokenResponse
Pass arguments to generate_aws_access_token via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • aws_cluster (::String) — Required. The name of the AwsCluster resource to authenticate to.

    AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

    See Resource Names for more details on Google Cloud resource names.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GenerateAwsAccessTokenRequest.new

# Call the generate_aws_access_token method.
result = client.generate_aws_access_token request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::GenerateAwsAccessTokenResponse.
p result

#generate_aws_cluster_agent_token

def generate_aws_cluster_agent_token(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAwsClusterAgentTokenResponse
def generate_aws_cluster_agent_token(aws_cluster: nil, subject_token: nil, subject_token_type: nil, version: nil, node_pool_id: nil, grant_type: nil, audience: nil, scope: nil, requested_token_type: nil, options: nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAwsClusterAgentTokenResponse

Generates an access token for a cluster agent.

Overloads 
def generate_aws_cluster_agent_token(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAwsClusterAgentTokenResponse
Pass arguments to generate_aws_cluster_agent_token via a request object, either of type GenerateAwsClusterAgentTokenRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GenerateAwsClusterAgentTokenRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def generate_aws_cluster_agent_token(aws_cluster: nil, subject_token: nil, subject_token_type: nil, version: nil, node_pool_id: nil, grant_type: nil, audience: nil, scope: nil, requested_token_type: nil, options: nil) -> ::Google::Cloud::GkeMultiCloud::V1::GenerateAwsClusterAgentTokenResponse
Pass arguments to generate_aws_cluster_agent_token via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • aws_cluster (::String) — Required.
  • subject_token (::String) — Required.
  • subject_token_type (::String) — Required.
  • version (::String) — Required.
  • node_pool_id (::String) — Optional.
  • grant_type (::String) — Optional.
  • audience (::String) — Optional.
  • scope (::String) — Optional.
  • requested_token_type (::String) — Optional.
  • options (::String) — Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GenerateAwsClusterAgentTokenRequest.new

# Call the generate_aws_cluster_agent_token method.
result = client.generate_aws_cluster_agent_token request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::GenerateAwsClusterAgentTokenResponse.
p result

#get_aws_cluster

def get_aws_cluster(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsCluster
def get_aws_cluster(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsCluster

Describes a specific AwsCluster resource.

Overloads 
def get_aws_cluster(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsCluster
Pass arguments to get_aws_cluster via a request object, either of type GetAwsClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAwsClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_aws_cluster(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsCluster
Pass arguments to get_aws_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the AwsCluster resource to describe.

    AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

    See Resource Names for more details on Google Cloud Platform resource names.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAwsClusterRequest.new

# Call the get_aws_cluster method.
result = client.get_aws_cluster request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AwsCluster.
p result

#get_aws_json_web_keys

def get_aws_json_web_keys(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsJsonWebKeys
def get_aws_json_web_keys(aws_cluster: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsJsonWebKeys

Gets the public component of the cluster signing keys in JSON Web Key format.

Overloads 
def get_aws_json_web_keys(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsJsonWebKeys
Pass arguments to get_aws_json_web_keys via a request object, either of type GetAwsJsonWebKeysRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAwsJsonWebKeysRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_aws_json_web_keys(aws_cluster: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsJsonWebKeys
Pass arguments to get_aws_json_web_keys via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • aws_cluster (::String) — Required. The AwsCluster, which owns the JsonWebKeys. Format: projects/{project}/locations/{location}/awsClusters/{cluster}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAwsJsonWebKeysRequest.new

# Call the get_aws_json_web_keys method.
result = client.get_aws_json_web_keys request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AwsJsonWebKeys.
p result

#get_aws_node_pool

def get_aws_node_pool(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodePool
def get_aws_node_pool(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodePool

Describes a specific AwsNodePool resource.

Overloads 
def get_aws_node_pool(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodePool
Pass arguments to get_aws_node_pool via a request object, either of type GetAwsNodePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAwsNodePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_aws_node_pool(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsNodePool
Pass arguments to get_aws_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the AwsNodePool resource to describe.

    AwsNodePool names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

    See Resource Names for more details on Google Cloud resource names.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAwsNodePoolRequest.new

# Call the get_aws_node_pool method.
result = client.get_aws_node_pool request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AwsNodePool.
p result

#get_aws_open_id_config

def get_aws_open_id_config(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsOpenIdConfig
def get_aws_open_id_config(aws_cluster: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsOpenIdConfig

Gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.

Overloads 
def get_aws_open_id_config(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsOpenIdConfig
Pass arguments to get_aws_open_id_config via a request object, either of type GetAwsOpenIdConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAwsOpenIdConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_aws_open_id_config(aws_cluster: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsOpenIdConfig
Pass arguments to get_aws_open_id_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • aws_cluster (::String) — Required. The AwsCluster, which owns the OIDC discovery document. Format: projects/{project}/locations/{location}/awsClusters/{cluster}
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAwsOpenIdConfigRequest.new

# Call the get_aws_open_id_config method.
result = client.get_aws_open_id_config request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AwsOpenIdConfig.
p result

#get_aws_server_config

def get_aws_server_config(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsServerConfig
def get_aws_server_config(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsServerConfig

Returns information, such as supported AWS regions and Kubernetes versions, on a given Google Cloud location.

Overloads 
def get_aws_server_config(request, options = nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsServerConfig
Pass arguments to get_aws_server_config via a request object, either of type GetAwsServerConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::GetAwsServerConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def get_aws_server_config(name: nil) -> ::Google::Cloud::GkeMultiCloud::V1::AwsServerConfig
Pass arguments to get_aws_server_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the AwsServerConfig resource to describe.

    AwsServerConfig names are formatted as projects/<project-id>/locations/<region>/awsServerConfig.

    See Resource Names for more details on Google Cloud resource names.

Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::GetAwsServerConfigRequest.new

# Call the get_aws_server_config method.
result = client.get_aws_server_config request

# The returned object is of type Google::Cloud::GkeMultiCloud::V1::AwsServerConfig.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new AwsClusters REST client object.

Yields
  • (config) — Configure the AwsClusters client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_aws_clusters

def list_aws_clusters(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AwsCluster>
def list_aws_clusters(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AwsCluster>

Lists all AwsCluster resources on a given Google Cloud project and region.

Overloads 
def list_aws_clusters(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AwsCluster>
Pass arguments to list_aws_clusters via a request object, either of type ListAwsClustersRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::ListAwsClustersRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_aws_clusters(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AwsCluster>
Pass arguments to list_aws_clusters via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent location which owns this collection of AwsCluster resources.

    Location names are formatted as projects/<project-id>/locations/<region>.

    See Resource Names for more details on Google Cloud Platform resource names.

  • page_size (::Integer) — The maximum number of items to return.

    If not specified, a default value of 50 will be used by the service. Regardless of the pageSize value, the response can include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.

  • page_token (::String) — The nextPageToken value returned from a previous awsClusters.list request, if any.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::ListAwsClustersRequest.new

# Call the list_aws_clusters method.
result = client.list_aws_clusters request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::GkeMultiCloud::V1::AwsCluster.
  p item
end

#list_aws_node_pools

def list_aws_node_pools(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AwsNodePool>
def list_aws_node_pools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AwsNodePool>

Lists all AwsNodePool resources on a given AwsCluster.

Overloads 
def list_aws_node_pools(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AwsNodePool>
Pass arguments to list_aws_node_pools via a request object, either of type ListAwsNodePoolsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::ListAwsNodePoolsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def list_aws_node_pools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::GkeMultiCloud::V1::AwsNodePool>
Pass arguments to list_aws_node_pools via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent AwsCluster which owns this collection of AwsNodePool resources.

    AwsCluster names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>.

    See Resource Names for more details on Google Cloud resource names.

  • page_size (::Integer) — The maximum number of items to return.

    If not specified, a default value of 50 will be used by the service. Regardless of the pageSize value, the response can include a partial list and a caller should only rely on response's nextPageToken to determine if there are more instances left to be queried.

  • page_token (::String) — The nextPageToken value returned from a previous awsNodePools.list request, if any.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::ListAwsNodePoolsRequest.new

# Call the list_aws_node_pools method.
result = client.list_aws_node_pools request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::GkeMultiCloud::V1::AwsNodePool.
  p item
end

#operations_client

def operations_client() -> ::Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Operations

Get the associated client for long-running operations.

Returns

#rollback_aws_node_pool_update

def rollback_aws_node_pool_update(request, options = nil) -> ::Gapic::Operation
def rollback_aws_node_pool_update(name: nil, respect_pdb: nil) -> ::Gapic::Operation

Rolls back a previously aborted or failed AwsNodePool 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.

Overloads 
def rollback_aws_node_pool_update(request, options = nil) -> ::Gapic::Operation
Pass arguments to rollback_aws_node_pool_update via a request object, either of type RollbackAwsNodePoolUpdateRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::RollbackAwsNodePoolUpdateRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def rollback_aws_node_pool_update(name: nil, respect_pdb: nil) -> ::Gapic::Operation
Pass arguments to rollback_aws_node_pool_update via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the AwsNodePool resource to rollback.

    AwsNodePool names are formatted as projects/<project-id>/locations/<region>/awsClusters/<cluster-id>/awsNodePools/<node-pool-id>.

    See Resource Names for more details on Google Cloud resource names.

  • respect_pdb (::Boolean) — Optional. Option for rollback to ignore the PodDisruptionBudget when draining the node pool nodes. Default value is false.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::RollbackAwsNodePoolUpdateRequest.new

# Call the rollback_aws_node_pool_update method.
result = client.rollback_aws_node_pool_update request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_aws_cluster

def update_aws_cluster(request, options = nil) -> ::Gapic::Operation
def update_aws_cluster(aws_cluster: nil, validate_only: nil, update_mask: nil) -> ::Gapic::Operation

Updates an AwsCluster.

Overloads 
def update_aws_cluster(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_aws_cluster via a request object, either of type UpdateAwsClusterRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::UpdateAwsClusterRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_aws_cluster(aws_cluster: nil, validate_only: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_aws_cluster via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • aws_cluster (::Google::Cloud::GkeMultiCloud::V1::AwsCluster, ::Hash) — Required. The AwsCluster resource to update.
  • validate_only (::Boolean) — If set, only validate the request, but do not actually update the cluster.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) —

    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:

    • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::UpdateAwsClusterRequest.new

# Call the update_aws_cluster method.
result = client.update_aws_cluster request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#update_aws_node_pool

def update_aws_node_pool(request, options = nil) -> ::Gapic::Operation
def update_aws_node_pool(aws_node_pool: nil, validate_only: nil, update_mask: nil) -> ::Gapic::Operation

Updates an AwsNodePool.

Overloads 
def update_aws_node_pool(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_aws_node_pool via a request object, either of type UpdateAwsNodePoolRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::GkeMultiCloud::V1::UpdateAwsNodePoolRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def update_aws_node_pool(aws_node_pool: nil, validate_only: nil, update_mask: nil) -> ::Gapic::Operation
Pass arguments to update_aws_node_pool via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • aws_node_pool (::Google::Cloud::GkeMultiCloud::V1::AwsNodePool, ::Hash) — Required. The AwsNodePool resource to update.
  • validate_only (::Boolean) — If set, only validate the request, but don't actually update the node pool.
  • update_mask (::Google::Protobuf::FieldMask, ::Hash) —

    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:

    • 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

Basic example

require "google/cloud/gke_multi_cloud/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::GkeMultiCloud::V1::AwsClusters::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::GkeMultiCloud::V1::UpdateAwsNodePoolRequest.new

# Call the update_aws_node_pool method.
result = client.update_aws_node_pool request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end