Package com.google.cloud.gkehub.v1 (1.29.0)

A client to GKE Hub

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

GkeHubClient

Service Description: The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

Membership
Feature

GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions.

**Membership management may be non-trivial:** it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

Sample for GkeHubClient:


 // 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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
   MembershipName name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]");
   Membership response = gkeHubClient.getMembership(name);
 }

Classes

Authority

Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity

Protobuf type google.cloud.gkehub.v1.Authority

Authority.Builder

Protobuf type google.cloud.gkehub.v1.Authority

CommonFeatureSpec

CommonFeatureSpec contains Hub-wide configuration information

Protobuf type google.cloud.gkehub.v1.CommonFeatureSpec

CommonFeatureSpec.Builder

CommonFeatureSpec contains Hub-wide configuration information

Protobuf type google.cloud.gkehub.v1.CommonFeatureSpec

CommonFeatureState

CommonFeatureState contains Hub-wide Feature status information.

Protobuf type google.cloud.gkehub.v1.CommonFeatureState

CommonFeatureState.Builder

CommonFeatureState contains Hub-wide Feature status information.

Protobuf type google.cloud.gkehub.v1.CommonFeatureState

ConnectAgentResource

ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.

Protobuf type google.cloud.gkehub.v1.ConnectAgentResource

ConnectAgentResource.Builder

ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.

Protobuf type google.cloud.gkehub.v1.ConnectAgentResource

CreateFeatureRequest

Request message for the GkeHub.CreateFeature method.

Protobuf type google.cloud.gkehub.v1.CreateFeatureRequest

CreateFeatureRequest.Builder

Request message for the GkeHub.CreateFeature method.

Protobuf type google.cloud.gkehub.v1.CreateFeatureRequest

CreateMembershipRequest

Request message for the GkeHub.CreateMembership method.

Protobuf type google.cloud.gkehub.v1.CreateMembershipRequest

CreateMembershipRequest.Builder

Request message for the GkeHub.CreateMembership method.

Protobuf type google.cloud.gkehub.v1.CreateMembershipRequest

DeleteFeatureRequest

Request message for GkeHub.DeleteFeature method.

Protobuf type google.cloud.gkehub.v1.DeleteFeatureRequest

DeleteFeatureRequest.Builder

Request message for GkeHub.DeleteFeature method.

Protobuf type google.cloud.gkehub.v1.DeleteFeatureRequest

DeleteMembershipRequest

Request message for GkeHub.DeleteMembership method.

Protobuf type google.cloud.gkehub.v1.DeleteMembershipRequest

DeleteMembershipRequest.Builder

Request message for GkeHub.DeleteMembership method.

Protobuf type google.cloud.gkehub.v1.DeleteMembershipRequest

Feature

Feature represents the settings and status of any Hub Feature.

Protobuf type google.cloud.gkehub.v1.Feature

Feature.Builder

Feature represents the settings and status of any Hub Feature.

Protobuf type google.cloud.gkehub.v1.Feature

FeatureName

FeatureName.Builder

Builder for projects/{project}/locations/{location}/features/{feature}.

FeatureProto

FeatureResourceState

FeatureResourceState describes the state of a Feature resource in the GkeHub API. See FeatureState for the "running state" of the Feature in the Hub and across Memberships.

Protobuf type google.cloud.gkehub.v1.FeatureResourceState

FeatureResourceState.Builder

FeatureResourceState describes the state of a Feature resource in the GkeHub API. See FeatureState for the "running state" of the Feature in the Hub and across Memberships.

Protobuf type google.cloud.gkehub.v1.FeatureResourceState

FeatureState

FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context.

Protobuf type google.cloud.gkehub.v1.FeatureState

FeatureState.Builder

FeatureState describes the high-level state of a Feature. It may be used to describe a Feature's state at the environ-level, or per-membershop, depending on the context.

Protobuf type google.cloud.gkehub.v1.FeatureState

GenerateConnectManifestRequest

Request message for GkeHub.GenerateConnectManifest method. .

Protobuf type google.cloud.gkehub.v1.GenerateConnectManifestRequest

GenerateConnectManifestRequest.Builder

Request message for GkeHub.GenerateConnectManifest method. .

Protobuf type google.cloud.gkehub.v1.GenerateConnectManifestRequest

GenerateConnectManifestResponse

GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

Protobuf type google.cloud.gkehub.v1.GenerateConnectManifestResponse

GenerateConnectManifestResponse.Builder

GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.

Protobuf type google.cloud.gkehub.v1.GenerateConnectManifestResponse

GetFeatureRequest

Request message for GkeHub.GetFeature method.

Protobuf type google.cloud.gkehub.v1.GetFeatureRequest

GetFeatureRequest.Builder

Request message for GkeHub.GetFeature method.

Protobuf type google.cloud.gkehub.v1.GetFeatureRequest

GetMembershipRequest

Request message for GkeHub.GetMembership method.

Protobuf type google.cloud.gkehub.v1.GetMembershipRequest

GetMembershipRequest.Builder

Request message for GkeHub.GetMembership method.

Protobuf type google.cloud.gkehub.v1.GetMembershipRequest

GkeCluster

GkeCluster contains information specific to GKE clusters.

Protobuf type google.cloud.gkehub.v1.GkeCluster

GkeCluster.Builder

GkeCluster contains information specific to GKE clusters.

Protobuf type google.cloud.gkehub.v1.GkeCluster

GkeHubClient

Service Description: The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters.

The GKE Hub service operates on the following resources:

Membership
Feature

**Membership management may be non-trivial:** it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

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 (GkeHubClient gkeHubClient = GkeHubClient.create()) {
   MembershipName name = MembershipName.of("[PROJECT]", "[LOCATION]", "[MEMBERSHIP]");
   Membership response = gkeHubClient.getMembership(name);
 }

Note: close() needs to be called on the GkeHubClient 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 GkeHubSettings 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
 GkeHubSettings gkeHubSettings =
     GkeHubSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GkeHubClient gkeHubClient = GkeHubClient.create(gkeHubSettings);

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
 GkeHubSettings gkeHubSettings = GkeHubSettings.newBuilder().setEndpoint(myEndpoint).build();
 GkeHubClient gkeHubClient = GkeHubClient.create(gkeHubSettings);

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
 GkeHubSettings gkeHubSettings = GkeHubSettings.newHttpJsonBuilder().build();
 GkeHubClient gkeHubClient = GkeHubClient.create(gkeHubSettings);

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

GkeHubClient.ListFeaturesFixedSizeCollection

GkeHubClient.ListFeaturesPage

GkeHubClient.ListFeaturesPagedResponse

GkeHubClient.ListMembershipsFixedSizeCollection

GkeHubClient.ListMembershipsPage

GkeHubClient.ListMembershipsPagedResponse

GkeHubGrpc

The GKE Hub service handles the registration of many Kubernetes clusters to Google Cloud, and the management of multi-cluster features over those clusters. The GKE Hub service operates on the following resources:

Membership
Feature GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions. Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

GkeHubGrpc.GkeHubBlockingStub

A stub to allow clients to do synchronous rpc calls to service GkeHub.

Membership
Feature GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions. Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

GkeHubGrpc.GkeHubFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service GkeHub.

Membership
Feature GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions. Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

GkeHubGrpc.GkeHubImplBase

Base class for the server implementation of the service GkeHub.

Membership
Feature GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions. Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

GkeHubGrpc.GkeHubStub

A stub to allow clients to do asynchronous rpc calls to service GkeHub.

Membership
Feature GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions. Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

GkeHubSettings

Settings class to configure an instance of GkeHubClient.

The default instance has everything set to sensible defaults:

The default service address (gkehub.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getMembership to 30 seconds:


 // 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
 GkeHubSettings.Builder gkeHubSettingsBuilder = GkeHubSettings.newBuilder();
 gkeHubSettingsBuilder
     .getMembershipSettings()
     .setRetrySettings(
         gkeHubSettingsBuilder
             .getMembershipSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 GkeHubSettings gkeHubSettings = gkeHubSettingsBuilder.build();

Membership
Feature GKE Hub is currently available in the global region and all regions in https://cloud.google.com/compute/docs/regions-zones. Feature is only available in global region while membership is global region and all the regions. Membership management may be non-trivial: it is recommended to use one of the Google-provided client libraries or tools where possible when working with Membership resources.

Package com.google.cloud.gkehub.v1 (1.29.0)

GkeHubClient

Classes

Interfaces

Enums