Package Classes (1.16.0)

Configuration for Config Sync

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The state of ConfigSync's deployment on a cluster

Errors pertaining to the installation of Config Sync

State information for ConfigSync

CRDState representing the state of a CRD

Specific versioning information pertaining to ConfigSync's Pods

Enum representing the state of an ACM's deployment on a cluster

Model for a config file in the git repo with an associated Sync error

State of Policy Controller installation.

Git repo configuration for a single cluster.

A Kubernetes object's GVK

Configuration for Hierarchy Controller

Deployment state for Hierarchy Controller

State for Hierarchy Controller

Version for Hierarchy Controller

Errors pertaining to the installation of ACM

Anthos Config Management: Configuration for a single cluster. Intended to parallel the ConfigManagement CR.

Whether to automatically manage the Feature.

Anthos Config Management: State for a single cluster.

OCI repo configuration for a single cluster

State information for an ACM's Operator

Configuration for Policy Controller

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State for PolicyControllerState.

The build version of Gatekeeper Policy Controller is using.

An ACM created error representing a problem syncing configurations

State indicating an ACM's progress syncing configurations to a cluster

An enum representing Config Sync's status of syncing configs to a cluster.

Multi-cluster Ingress: The configuration for the MultiClusterIngress feature.

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.

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.

A pager for iterating through list_features requests.

This class thinly wraps an initial ListFeaturesResponse object, and provides an __aiter__ method to iterate through its resources field.

If there are more pages, the __aiter__ method will make additional ListFeatures requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListFeaturesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_features requests.

This class thinly wraps an initial ListFeaturesResponse object, and provides an __iter__ method to iterate through its resources field.

If there are more pages, the __iter__ method will make additional ListFeatures requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListFeaturesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_memberships requests.

This class thinly wraps an initial ListMembershipsResponse object, and provides an __aiter__ method to iterate through its resources field.

If there are more pages, the __aiter__ method will make additional ListMemberships requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_memberships requests.

This class thinly wraps an initial ListMembershipsResponse object, and provides an __iter__ method to iterate through its resources field.

If there are more pages, the __iter__ method will make additional ListMemberships requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

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

CommonFeatureSpec contains Hub-wide configuration information

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CommonFeatureState contains Hub-wide Feature status information.

ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.

Request message for the GkeHub.CreateFeature method.

Request message for the GkeHub.CreateMembership method.

Request message for GkeHub.DeleteFeature method.

Request message for GkeHub.DeleteMembership method.

Feature represents the settings and status of any Hub Feature.

The abstract base class for a message.

The abstract base class for a message.

The abstract base class for a message.

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.

State describes the lifecycle status of a Feature.

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.

Code represents a machine-readable, high-level status of the Feature.

Request message for GkeHub.GenerateConnectManifest method. .

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

Request message for GkeHub.GetFeature method.

Request message for GkeHub.GetMembership method.

GkeCluster contains information specific to GKE clusters.

KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.

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.

Request message for GkeHub.ListFeatures method.

Response message for the GkeHub.ListFeatures method.

Request message for GkeHub.ListMemberships method.

Response message for the GkeHub.ListMemberships method.

Membership contains information about a member cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.

MembershipFeatureSpec contains configuration information for a single Membership.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MembershipFeatureState contains Feature status information for a single Membership.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MembershipState describes the state of a Membership resource.

Code describes the state of a Membership resource.

This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.

Represents the metadata of the long-running operation.

ResourceManifest represents a single Kubernetes resource to be applied to the cluster.

ResourceOptions represent options for Kubernetes resource generation.

TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.

Request message for GkeHub.UpdateFeature method.

Request message for GkeHub.UpdateMembership method.

The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.

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

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.

The GKE Hub MembershipService handles the registration of many Kubernetes clusters to Google Cloud, represented with the Membership resource.

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

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.

A pager for iterating through list_memberships requests.

This class thinly wraps an initial ListMembershipsResponse object, and provides an __aiter__ method to iterate through its resources field.

If there are more pages, the __aiter__ method will make additional ListMemberships requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_memberships requests.

This class thinly wraps an initial ListMembershipsResponse object, and provides an __iter__ method to iterate through its resources field.

If there are more pages, the __iter__ method will make additional ListMemberships requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListMembershipsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ApplianceCluster contains information specific to GDC Edge Appliance Clusters.

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

The information required from end users to use GKE Connect.

ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.

Request message for the GkeHubMembershipService.CreateMembership method.

Request message for GkeHubMembershipService.DeleteMembership method.

EdgeCluster contains information specific to Google Edge Clusters.

Request message for GkeHubMembershipService.GenerateConnectManifest method.

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

The request to generate the manifests for exclusivity artifacts.

The response of the exclusivity artifacts manifests for the client to apply.

Request message for GkeHubMembershipService.GetMembership method.

GkeCluster contains information specific to GKE clusters.

KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.

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.

Request message for GkeHubMembershipService.ListMemberships method.

Response message for the GkeHubMembershipService.ListMemberships method.

Membership contains information about a member cluster.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

The abstract base class for a message.

MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State of the Membership resource.

Code describes the state of a Membership resource.

This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.

MultiCloudCluster contains information specific to GKE Multi-Cloud clusters.

OnPremCluster contains information specific to GKE On-Prem clusters.

ClusterType describes on prem cluster's type.

Represents the metadata of the long-running operation.

ResourceManifest represents a single Kubernetes resource to be applied to the cluster.

ResourceOptions represent options for Kubernetes resource generation.

TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.

Request message for GkeHubMembershipService.UpdateMembership method.

The request to validate the existing state of the membership CR in the cluster.

The response of exclusivity artifacts validation result status.

API documentation for gkehub_v1.services.gke_hub.pagers module.

API documentation for gkehub_v1beta1.services.gke_hub_membership_service.pagers module.