A client to GKE Hub API
The interfaces provided are listed below, along with usage samples.
GkeHubMembershipServiceClient
Service Description: The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.
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 GkeHubMembershipServiceClient:
try (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
GkeHubMembershipServiceClient.create()) {
String name = "name3373707";
Membership response = gkeHubMembershipServiceClient.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.v1beta1.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.v1beta1.Authority
ConnectAgent
The information required from end users to use GKE Connect.
Protobuf type google.cloud.gkehub.v1beta1.ConnectAgent
ConnectAgent.Builder
The information required from end users to use GKE Connect.
Protobuf type google.cloud.gkehub.v1beta1.ConnectAgent
ConnectAgentResource
ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.
Protobuf type google.cloud.gkehub.v1beta1.ConnectAgentResource
ConnectAgentResource.Builder
ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.
Protobuf type google.cloud.gkehub.v1beta1.ConnectAgentResource
CreateMembershipRequest
Request message for the GkeHubMembershipService.CreateMembership method.
Protobuf type google.cloud.gkehub.v1beta1.CreateMembershipRequest
CreateMembershipRequest.Builder
Request message for the GkeHubMembershipService.CreateMembership method.
Protobuf type google.cloud.gkehub.v1beta1.CreateMembershipRequest
DeleteMembershipRequest
Request message for GkeHubMembershipService.DeleteMembership method.
Protobuf type google.cloud.gkehub.v1beta1.DeleteMembershipRequest
DeleteMembershipRequest.Builder
Request message for GkeHubMembershipService.DeleteMembership method.
Protobuf type google.cloud.gkehub.v1beta1.DeleteMembershipRequest
GenerateConnectManifestRequest
Request message for GkeHubMembershipService.GenerateConnectManifest
method.
.
Protobuf type google.cloud.gkehub.v1beta1.GenerateConnectManifestRequest
GenerateConnectManifestRequest.Builder
Request message for GkeHubMembershipService.GenerateConnectManifest
method.
.
Protobuf type google.cloud.gkehub.v1beta1.GenerateConnectManifestRequest
GenerateConnectManifestResponse
GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.
Protobuf type google.cloud.gkehub.v1beta1.GenerateConnectManifestResponse
GenerateConnectManifestResponse.Builder
GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.
Protobuf type google.cloud.gkehub.v1beta1.GenerateConnectManifestResponse
GenerateExclusivityManifestRequest
The request to generate the manifests for exclusivity artifacts.
Protobuf type google.cloud.gkehub.v1beta1.GenerateExclusivityManifestRequest
GenerateExclusivityManifestRequest.Builder
The request to generate the manifests for exclusivity artifacts.
Protobuf type google.cloud.gkehub.v1beta1.GenerateExclusivityManifestRequest
GenerateExclusivityManifestResponse
The response of the exclusivity artifacts manifests for the client to apply.
Protobuf type google.cloud.gkehub.v1beta1.GenerateExclusivityManifestResponse
GenerateExclusivityManifestResponse.Builder
The response of the exclusivity artifacts manifests for the client to apply.
Protobuf type google.cloud.gkehub.v1beta1.GenerateExclusivityManifestResponse
GetMembershipRequest
Request message for GkeHubMembershipService.GetMembership method.
Protobuf type google.cloud.gkehub.v1beta1.GetMembershipRequest
GetMembershipRequest.Builder
Request message for GkeHubMembershipService.GetMembership method.
Protobuf type google.cloud.gkehub.v1beta1.GetMembershipRequest
GkeCluster
GkeCluster contains information specific to GKE clusters.
Protobuf type google.cloud.gkehub.v1beta1.GkeCluster
GkeCluster.Builder
GkeCluster contains information specific to GKE clusters.
Protobuf type google.cloud.gkehub.v1beta1.GkeCluster
GkeHubMembershipServiceClient
Service Description: The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.
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 (GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
GkeHubMembershipServiceClient.create()) {
String name = "name3373707";
Membership response = gkeHubMembershipServiceClient.getMembership(name);
}
Note: close() needs to be called on the GkeHubMembershipServiceClient 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 GkeHubMembershipServiceSettings to create(). For example:
To customize credentials:
GkeHubMembershipServiceSettings gkeHubMembershipServiceSettings =
GkeHubMembershipServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
GkeHubMembershipServiceClient.create(gkeHubMembershipServiceSettings);
To customize the endpoint:
GkeHubMembershipServiceSettings gkeHubMembershipServiceSettings =
GkeHubMembershipServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
GkeHubMembershipServiceClient gkeHubMembershipServiceClient =
GkeHubMembershipServiceClient.create(gkeHubMembershipServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
GkeHubMembershipServiceClient.ListMembershipsFixedSizeCollection
GkeHubMembershipServiceClient.ListMembershipsPage
GkeHubMembershipServiceClient.ListMembershipsPagedResponse
GkeHubMembershipServiceGrpc
The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource. 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.
GkeHubMembershipServiceGrpc.GkeHubMembershipServiceBlockingStub
The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource. 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.
GkeHubMembershipServiceGrpc.GkeHubMembershipServiceFutureStub
The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource. 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.
GkeHubMembershipServiceGrpc.GkeHubMembershipServiceImplBase
The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource. 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.
GkeHubMembershipServiceGrpc.GkeHubMembershipServiceStub
The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource. 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.
GkeHubMembershipServiceSettings
Settings class to configure an instance of GkeHubMembershipServiceClient.
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:
GkeHubMembershipServiceSettings.Builder gkeHubMembershipServiceSettingsBuilder =
GkeHubMembershipServiceSettings.newBuilder();
gkeHubMembershipServiceSettingsBuilder
.getMembershipSettings()
.setRetrySettings(
gkeHubMembershipServiceSettingsBuilder
.getMembershipSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
GkeHubMembershipServiceSettings gkeHubMembershipServiceSettings =
gkeHubMembershipServiceSettingsBuilder.build();
GkeHubMembershipServiceSettings.Builder
Builder for GkeHubMembershipServiceSettings.
KubernetesMetadata
KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.
Protobuf type google.cloud.gkehub.v1beta1.KubernetesMetadata
KubernetesMetadata.Builder
KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.
Protobuf type google.cloud.gkehub.v1beta1.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.v1beta1.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.v1beta1.KubernetesResource
ListMembershipsRequest
Request message for GkeHubMembershipService.ListMemberships method.
Protobuf type google.cloud.gkehub.v1beta1.ListMembershipsRequest
ListMembershipsRequest.Builder
Request message for GkeHubMembershipService.ListMemberships method.
Protobuf type google.cloud.gkehub.v1beta1.ListMembershipsRequest
ListMembershipsResponse
Response message for the GkeHubMembershipService.ListMemberships method.
Protobuf type google.cloud.gkehub.v1beta1.ListMembershipsResponse
ListMembershipsResponse.Builder
Response message for the GkeHubMembershipService.ListMemberships method.
Protobuf type google.cloud.gkehub.v1beta1.ListMembershipsResponse
Membership
Membership contains information about a member cluster.
Protobuf type google.cloud.gkehub.v1beta1.Membership
Membership.Builder
Membership contains information about a member cluster.
Protobuf type google.cloud.gkehub.v1beta1.Membership
MembershipEndpoint
MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.
Protobuf type google.cloud.gkehub.v1beta1.MembershipEndpoint
MembershipEndpoint.Builder
MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.
Protobuf type google.cloud.gkehub.v1beta1.MembershipEndpoint
MembershipOuterClass
MembershipState
State of the Membership resource.
Protobuf type google.cloud.gkehub.v1beta1.MembershipState
MembershipState.Builder
State of the Membership resource.
Protobuf type google.cloud.gkehub.v1beta1.MembershipState
MultiCloudCluster
MultiCloudCluster contains information specific to GKE Multi-Cloud clusters.
Protobuf type google.cloud.gkehub.v1beta1.MultiCloudCluster
MultiCloudCluster.Builder
MultiCloudCluster contains information specific to GKE Multi-Cloud clusters.
Protobuf type google.cloud.gkehub.v1beta1.MultiCloudCluster
OnPremCluster
OnPremCluster contains information specific to GKE On-Prem clusters.
Protobuf type google.cloud.gkehub.v1beta1.OnPremCluster
OnPremCluster.Builder
OnPremCluster contains information specific to GKE On-Prem clusters.
Protobuf type google.cloud.gkehub.v1beta1.OnPremCluster
OperationMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.gkehub.v1beta1.OperationMetadata
OperationMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.gkehub.v1beta1.OperationMetadata
ResourceManifest
ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
Protobuf type google.cloud.gkehub.v1beta1.ResourceManifest
ResourceManifest.Builder
ResourceManifest represents a single Kubernetes resource to be applied to the cluster.
Protobuf type google.cloud.gkehub.v1beta1.ResourceManifest
ResourceOptions
ResourceOptions represent options for Kubernetes resource generation.
Protobuf type google.cloud.gkehub.v1beta1.ResourceOptions
ResourceOptions.Builder
ResourceOptions represent options for Kubernetes resource generation.
Protobuf type google.cloud.gkehub.v1beta1.ResourceOptions
TypeMeta
TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.
Protobuf type google.cloud.gkehub.v1beta1.TypeMeta
TypeMeta.Builder
TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.
Protobuf type google.cloud.gkehub.v1beta1.TypeMeta
UpdateMembershipRequest
Request message for GkeHubMembershipService.UpdateMembership method.
Protobuf type google.cloud.gkehub.v1beta1.UpdateMembershipRequest
UpdateMembershipRequest.Builder
Request message for GkeHubMembershipService.UpdateMembership method.
Protobuf type google.cloud.gkehub.v1beta1.UpdateMembershipRequest
ValidateExclusivityRequest
The request to validate the existing state of the membership CR in the cluster.
Protobuf type google.cloud.gkehub.v1beta1.ValidateExclusivityRequest
ValidateExclusivityRequest.Builder
The request to validate the existing state of the membership CR in the cluster.
Protobuf type google.cloud.gkehub.v1beta1.ValidateExclusivityRequest
ValidateExclusivityResponse
The response of exclusivity artifacts validation result status.
Protobuf type google.cloud.gkehub.v1beta1.ValidateExclusivityResponse
ValidateExclusivityResponse.Builder
The response of exclusivity artifacts validation result status.
Protobuf type google.cloud.gkehub.v1beta1.ValidateExclusivityResponse
Interfaces
AuthorityOrBuilder
ConnectAgentOrBuilder
ConnectAgentResourceOrBuilder
CreateMembershipRequestOrBuilder
DeleteMembershipRequestOrBuilder
GenerateConnectManifestRequestOrBuilder
GenerateConnectManifestResponseOrBuilder
GenerateExclusivityManifestRequestOrBuilder
GenerateExclusivityManifestResponseOrBuilder
GetMembershipRequestOrBuilder
GkeClusterOrBuilder
KubernetesMetadataOrBuilder
KubernetesResourceOrBuilder
ListMembershipsRequestOrBuilder
ListMembershipsResponseOrBuilder
MembershipEndpointOrBuilder
MembershipOrBuilder
MembershipStateOrBuilder
MultiCloudClusterOrBuilder
OnPremClusterOrBuilder
OperationMetadataOrBuilder
ResourceManifestOrBuilder
ResourceOptionsOrBuilder
TypeMetaOrBuilder
UpdateMembershipRequestOrBuilder
ValidateExclusivityRequestOrBuilder
ValidateExclusivityResponseOrBuilder
Enums
Membership.InfrastructureType
Specifies the infrastructure type of a Membership. Infrastructure type is used by Hub to control infrastructure-specific behavior, including pricing. Each GKE distribution (on-GCP, on-Prem, on-X,...) will set this field automatically, but Attached Clusters customers should specify a type during registration.
Protobuf enum google.cloud.gkehub.v1beta1.Membership.InfrastructureType
Membership.TypeCase
MembershipEndpoint.TypeCase
MembershipState.Code
Code describes the state of a Membership resource.
Protobuf enum google.cloud.gkehub.v1beta1.MembershipState.Code