- 1.48.0 (latest)
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.6
- 1.2.1
- 1.1.0
- 1.0.1
- 0.5.4
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 only available in the global region.
**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()) {
String name = "name3373707";
Feature response = gkeHubClient.getFeature(name);
}
Classes
CommonFeatureSpec
CommonFeatureSpec contains Hub-wide configuration information
Protobuf type google.cloud.gkehub.v1beta.CommonFeatureSpec
CommonFeatureSpec.Builder
CommonFeatureSpec contains Hub-wide configuration information
Protobuf type google.cloud.gkehub.v1beta.CommonFeatureSpec
CommonFeatureState
CommonFeatureState contains Hub-wide Feature status information.
Protobuf type google.cloud.gkehub.v1beta.CommonFeatureState
CommonFeatureState.Builder
CommonFeatureState contains Hub-wide Feature status information.
Protobuf type google.cloud.gkehub.v1beta.CommonFeatureState
CreateFeatureRequest
Request message for the GkeHub.CreateFeature
method.
Protobuf type google.cloud.gkehub.v1beta.CreateFeatureRequest
CreateFeatureRequest.Builder
Request message for the GkeHub.CreateFeature
method.
Protobuf type google.cloud.gkehub.v1beta.CreateFeatureRequest
DeleteFeatureRequest
Request message for GkeHub.DeleteFeature
method.
Protobuf type google.cloud.gkehub.v1beta.DeleteFeatureRequest
DeleteFeatureRequest.Builder
Request message for GkeHub.DeleteFeature
method.
Protobuf type google.cloud.gkehub.v1beta.DeleteFeatureRequest
Feature
Feature represents the settings and status of any Hub Feature.
Protobuf type google.cloud.gkehub.v1beta.Feature
Feature.Builder
Feature represents the settings and status of any Hub Feature.
Protobuf type google.cloud.gkehub.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.FeatureState
GetFeatureRequest
Request message for GkeHub.GetFeature
method.
Protobuf type google.cloud.gkehub.v1beta.GetFeatureRequest
GetFeatureRequest.Builder
Request message for GkeHub.GetFeature
method.
Protobuf type google.cloud.gkehub.v1beta.GetFeatureRequest
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 only available in the global region.
**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()) {
String name = "name3373707";
Feature response = gkeHubClient.getFeature(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
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 only available in the global region. 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.
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 only available in the global region. 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.
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 only available in the global region. 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.
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 only available in the global region. 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.
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 only available in the global region. 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 getFeature 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
.getFeatureSettings()
.setRetrySettings(
gkeHubSettingsBuilder
.getFeatureSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
GkeHubSettings gkeHubSettings = gkeHubSettingsBuilder.build();
GkeHubSettings.Builder
Builder for GkeHubSettings.
ListFeaturesRequest
Request message for GkeHub.ListFeatures
method.
Protobuf type google.cloud.gkehub.v1beta.ListFeaturesRequest
ListFeaturesRequest.Builder
Request message for GkeHub.ListFeatures
method.
Protobuf type google.cloud.gkehub.v1beta.ListFeaturesRequest
ListFeaturesResponse
Response message for the GkeHub.ListFeatures
method.
Protobuf type google.cloud.gkehub.v1beta.ListFeaturesResponse
ListFeaturesResponse.Builder
Response message for the GkeHub.ListFeatures
method.
Protobuf type google.cloud.gkehub.v1beta.ListFeaturesResponse
MembershipFeatureSpec
MembershipFeatureSpec contains configuration information for a single Membership.
Protobuf type google.cloud.gkehub.v1beta.MembershipFeatureSpec
MembershipFeatureSpec.Builder
MembershipFeatureSpec contains configuration information for a single Membership.
Protobuf type google.cloud.gkehub.v1beta.MembershipFeatureSpec
MembershipFeatureState
MembershipFeatureState contains Feature status information for a single Membership.
Protobuf type google.cloud.gkehub.v1beta.MembershipFeatureState
MembershipFeatureState.Builder
MembershipFeatureState contains Feature status information for a single Membership.
Protobuf type google.cloud.gkehub.v1beta.MembershipFeatureState
OperationMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.gkehub.v1beta.OperationMetadata
OperationMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.gkehub.v1beta.OperationMetadata
ServiceProto
UpdateFeatureRequest
Request message for GkeHub.UpdateFeature
method.
Protobuf type google.cloud.gkehub.v1beta.UpdateFeatureRequest
UpdateFeatureRequest.Builder
Request message for GkeHub.UpdateFeature
method.
Protobuf type google.cloud.gkehub.v1beta.UpdateFeatureRequest
Interfaces
CommonFeatureSpecOrBuilder
CommonFeatureStateOrBuilder
CreateFeatureRequestOrBuilder
DeleteFeatureRequestOrBuilder
FeatureOrBuilder
FeatureResourceStateOrBuilder
FeatureStateOrBuilder
GetFeatureRequestOrBuilder
GkeHubGrpc.AsyncService
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 only available in the global region. 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.
ListFeaturesRequestOrBuilder
ListFeaturesResponseOrBuilder
MembershipFeatureSpecOrBuilder
MembershipFeatureStateOrBuilder
OperationMetadataOrBuilder
UpdateFeatureRequestOrBuilder
Enums
CommonFeatureSpec.FeatureSpecCase
FeatureResourceState.State
State describes the lifecycle status of a Feature.
Protobuf enum google.cloud.gkehub.v1beta.FeatureResourceState.State
FeatureState.Code
Code represents a machine-readable, high-level status of the Feature.
Protobuf enum google.cloud.gkehub.v1beta.FeatureState.Code