- 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:
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
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
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
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:
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:
GkeHubSettings gkeHubSettings =
GkeHubSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
GkeHubClient gkeHubClient = GkeHubClient.create(gkeHubSettings);
To customize the endpoint:
GkeHubSettings gkeHubSettings = GkeHubSettings.newBuilder().setEndpoint(myEndpoint).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 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
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
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
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
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 getMembership to 30 seconds:
GkeHubSettings.Builder gkeHubSettingsBuilder = GkeHubSettings.newBuilder();
gkeHubSettingsBuilder
.getMembershipSettings()
.setRetrySettings(
gkeHubSettingsBuilder
.getMembershipSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
GkeHubSettings gkeHubSettings = gkeHubSettingsBuilder.build();
GkeHubSettings.Builder
Builder for GkeHubSettings.
KubernetesMetadata
KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.
Protobuf type google.cloud.gkehub.v1.KubernetesMetadata
KubernetesMetadata.Builder
KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.
Protobuf type google.cloud.gkehub.v1.KubernetesMetadata
KubernetesResource
KubernetesResource contains the YAML manifests and configuration for Membership Kubernetes resources in the cluster. After CreateMembership or UpdateMembership, these resources should be re-applied in the cluster.
Protobuf type google.cloud.gkehub.v1.KubernetesResource
KubernetesResource.Builder
KubernetesResource contains the YAML manifests and configuration for Membership Kubernetes resources in the cluster. After CreateMembership or UpdateMembership, these resources should be re-applied in the cluster.
Protobuf type google.cloud.gkehub.v1.KubernetesResource
ListFeaturesRequest
Request message for GkeHub.ListFeatures
method.
Protobuf type google.cloud.gkehub.v1.ListFeaturesRequest
ListFeaturesRequest.Builder
Request message for GkeHub.ListFeatures
method.
Protobuf type google.cloud.gkehub.v1.ListFeaturesRequest
ListFeaturesResponse
Response message for the GkeHub.ListFeatures
method.
Protobuf type google.cloud.gkehub.v1.ListFeaturesResponse
ListFeaturesResponse.Builder
Response message for the GkeHub.ListFeatures
method.
Protobuf type google.cloud.gkehub.v1.ListFeaturesResponse
ListMembershipsRequest
Request message for GkeHub.ListMemberships
method.
Protobuf type google.cloud.gkehub.v1.ListMembershipsRequest
ListMembershipsRequest.Builder
Request message for GkeHub.ListMemberships
method.
Protobuf type google.cloud.gkehub.v1.ListMembershipsRequest
ListMembershipsResponse
Response message for the GkeHub.ListMemberships
method.
Protobuf type google.cloud.gkehub.v1.ListMembershipsResponse
ListMembershipsResponse.Builder
Response message for the GkeHub.ListMemberships
method.
Protobuf type google.cloud.gkehub.v1.ListMembershipsResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
Membership
Membership contains information about a member cluster.
Protobuf type google.cloud.gkehub.v1.Membership
Membership.Builder
Membership contains information about a member cluster.
Protobuf type google.cloud.gkehub.v1.Membership
MembershipEndpoint
MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.
Protobuf type google.cloud.gkehub.v1.MembershipEndpoint
MembershipEndpoint.Builder
MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.
Protobuf type google.cloud.gkehub.v1.MembershipEndpoint
MembershipFeatureSpec
MembershipFeatureSpec contains configuration information for a single Membership.
Protobuf type google.cloud.gkehub.v1.MembershipFeatureSpec
MembershipFeatureSpec.Builder
MembershipFeatureSpec contains configuration information for a single Membership.
Protobuf type google.cloud.gkehub.v1.MembershipFeatureSpec
MembershipFeatureState
MembershipFeatureState contains Feature status information for a single Membership.
Protobuf type google.cloud.gkehub.v1.MembershipFeatureState
MembershipFeatureState.Builder
MembershipFeatureState contains Feature status information for a single Membership.
Protobuf type google.cloud.gkehub.v1.MembershipFeatureState
MembershipName
MembershipName.Builder
Builder for projects/{project}/locations/{location}/memberships/{membership}.
MembershipProto
MembershipState
MembershipState describes the state of a Membership resource.
Protobuf type google.cloud.gkehub.v1.MembershipState
MembershipState.Builder
MembershipState describes the state of a Membership resource.
Protobuf type google.cloud.gkehub.v1.MembershipState
OperationMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.gkehub.v1.OperationMetadata
OperationMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.gkehub.v1.OperationMetadata
ResourceManifest
ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
Protobuf type google.cloud.gkehub.v1.ResourceManifest
ResourceManifest.Builder
ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
Protobuf type google.cloud.gkehub.v1.ResourceManifest
ResourceOptions
ResourceOptions represent options for Kubernetes resource generation.
Protobuf type google.cloud.gkehub.v1.ResourceOptions
ResourceOptions.Builder
ResourceOptions represent options for Kubernetes resource generation.
Protobuf type google.cloud.gkehub.v1.ResourceOptions
ServiceProto
TypeMeta
TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.
Protobuf type google.cloud.gkehub.v1.TypeMeta
TypeMeta.Builder
TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.
Protobuf type google.cloud.gkehub.v1.TypeMeta
UpdateFeatureRequest
Request message for GkeHub.UpdateFeature
method.
Protobuf type google.cloud.gkehub.v1.UpdateFeatureRequest
UpdateFeatureRequest.Builder
Request message for GkeHub.UpdateFeature
method.
Protobuf type google.cloud.gkehub.v1.UpdateFeatureRequest
UpdateMembershipRequest
Request message for GkeHub.UpdateMembership
method.
Protobuf type google.cloud.gkehub.v1.UpdateMembershipRequest
UpdateMembershipRequest.Builder
Request message for GkeHub.UpdateMembership
method.
Protobuf type google.cloud.gkehub.v1.UpdateMembershipRequest
Interfaces
AuthorityOrBuilder
CommonFeatureSpecOrBuilder
CommonFeatureStateOrBuilder
ConnectAgentResourceOrBuilder
CreateFeatureRequestOrBuilder
CreateMembershipRequestOrBuilder
DeleteFeatureRequestOrBuilder
DeleteMembershipRequestOrBuilder
FeatureOrBuilder
FeatureResourceStateOrBuilder
FeatureStateOrBuilder
GenerateConnectManifestRequestOrBuilder
GenerateConnectManifestResponseOrBuilder
GetFeatureRequestOrBuilder
GetMembershipRequestOrBuilder
GkeClusterOrBuilder
KubernetesMetadataOrBuilder
KubernetesResourceOrBuilder
ListFeaturesRequestOrBuilder
ListFeaturesResponseOrBuilder
ListMembershipsRequestOrBuilder
ListMembershipsResponseOrBuilder
MembershipEndpointOrBuilder
MembershipFeatureSpecOrBuilder
MembershipFeatureStateOrBuilder
MembershipOrBuilder
MembershipStateOrBuilder
OperationMetadataOrBuilder
ResourceManifestOrBuilder
ResourceOptionsOrBuilder
TypeMetaOrBuilder
UpdateFeatureRequestOrBuilder
UpdateMembershipRequestOrBuilder
Enums
CommonFeatureSpec.FeatureSpecCase
FeatureResourceState.State
State describes the lifecycle status of a Feature.
Protobuf enum google.cloud.gkehub.v1.FeatureResourceState.State
FeatureState.Code
Code represents a machine-readable, high-level status of the Feature.
Protobuf enum google.cloud.gkehub.v1.FeatureState.Code
Membership.TypeCase
MembershipFeatureSpec.FeatureSpecCase
MembershipFeatureState.FeatureStateCase
MembershipState.Code
Code describes the state of a Membership resource.
Protobuf enum google.cloud.gkehub.v1.MembershipState.Code