Package com.google.cloud.gkemulticloud.v1 (0.5.0)

A client to Anthos Multi-Cloud API

The interfaces provided are listed below, along with usage samples.

AwsClustersClient

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

Sample for AwsClustersClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
   AwsClusterName name = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
   AwsCluster response = awsClustersClient.getAwsCluster(name);
 }

AzureClustersClient

Service Description: The AzureClusters API provides a single centrally managed service to create and manage Anthos clusters that run on Azure infrastructure.

Sample for AzureClustersClient:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AzureClustersClient azureClustersClient = AzureClustersClient.create()) {
   AzureClientName name = AzureClientName.of("[PROJECT]", "[LOCATION]", "[AZURE_CLIENT]");
   AzureClient response = azureClustersClient.getAzureClient(name);
 }

Classes

AwsAuthorization

Configuration related to the cluster RBAC settings.

Protobuf type google.cloud.gkemulticloud.v1.AwsAuthorization

AwsAuthorization.Builder

Configuration related to the cluster RBAC settings.

Protobuf type google.cloud.gkemulticloud.v1.AwsAuthorization

AwsCluster

An Anthos cluster running on AWS.

Protobuf type google.cloud.gkemulticloud.v1.AwsCluster

AwsCluster.Builder

An Anthos cluster running on AWS.

Protobuf type google.cloud.gkemulticloud.v1.AwsCluster

AwsClusterName.Builder

Builder for projects/{project}/locations/{location}/awsClusters/{aws_cluster}.

AwsClusterNetworking

ClusterNetworking defines cluster-wide networking configuration. Anthos clusters on AWS run on a single VPC. This includes control plane replicas and node pool nodes.

Protobuf type google.cloud.gkemulticloud.v1.AwsClusterNetworking

AwsClusterNetworking.Builder

ClusterNetworking defines cluster-wide networking configuration. Anthos clusters on AWS run on a single VPC. This includes control plane replicas and node pool nodes.

Protobuf type google.cloud.gkemulticloud.v1.AwsClusterNetworking

AwsClusterUser

Identities of a user-type subject for AWS clusters.

Protobuf type google.cloud.gkemulticloud.v1.AwsClusterUser

AwsClusterUser.Builder

Identities of a user-type subject for AWS clusters.

Protobuf type google.cloud.gkemulticloud.v1.AwsClusterUser

AwsClustersClient

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (AwsClustersClient awsClustersClient = AwsClustersClient.create()) {
   AwsClusterName name = AwsClusterName.of("[PROJECT]", "[LOCATION]", "[AWS_CLUSTER]");
   AwsCluster response = awsClustersClient.getAwsCluster(name);
 }

Note: close() needs to be called on the AwsClustersClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AwsClustersSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AwsClustersSettings awsClustersSettings =
     AwsClustersSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AwsClustersClient awsClustersClient = AwsClustersClient.create(awsClustersSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AwsClustersSettings awsClustersSettings =
     AwsClustersSettings.newBuilder().setEndpoint(myEndpoint).build();
 AwsClustersClient awsClustersClient = AwsClustersClient.create(awsClustersSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 AwsClustersSettings awsClustersSettings = AwsClustersSettings.newHttpJsonBuilder().build();
 AwsClustersClient awsClustersClient = AwsClustersClient.create(awsClustersSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

AwsClustersClient.ListAwsClustersFixedSizeCollection

AwsClustersClient.ListAwsClustersPage

AwsClustersClient.ListAwsClustersPagedResponse