Class Membership (1.10.2)

Membership(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Membership contains information about a member cluster.

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

Attributes

NameDescription
name str
Output only. The full, unique name of this Membership resource in the format projects/*/locations/*/memberships/{membership_id}, set during creation. membership_id must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or - 3. It must start and end with an alphanumeric character Which can be expressed as the regex: [a-z0-9]([-a-z0-9]*[a-z0-9])?, with a maximum length of 63 characters.
labels MutableMapping[str, str]
Optional. GCP labels for this membership.
description str
Optional. Description of this membership, limited to 63 characters. Must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]*
endpoint google.cloud.gkehub_v1beta1.types.MembershipEndpoint
Optional. Endpoint information to reach this member. This field is a member of oneof_ type.
state google.cloud.gkehub_v1beta1.types.MembershipState
Output only. State of the Membership resource.
authority google.cloud.gkehub_v1beta1.types.Authority
Optional. How to identify workloads from this Membership. See the documentation on Workload Identity for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. When the Membership was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. When the Membership was last updated.
delete_time google.protobuf.timestamp_pb2.Timestamp
Output only. When the Membership was deleted.
external_id str
Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. For GKE clusters, external_id is managed by the Hub API and updates will be ignored. The ID must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.]* If this Membership represents a Kubernetes cluster, this value should be set to the UID of the kube-system namespace object.
last_connection_time google.protobuf.timestamp_pb2.Timestamp
Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset.
unique_id str
Output only. Google-generated UUID for this resource. This is unique across all Membership resources. If a Membership resource is deleted and another resource with the same name is created, it gets a different unique_id.
infrastructure_type google.cloud.gkehub_v1beta1.types.Membership.InfrastructureType
Optional. The infrastructure type this Membership is running on.
monitoring_config google.cloud.gkehub_v1beta1.types.MonitoringConfig
Optional. The monitoring config information for this membership.

Classes

InfrastructureType

InfrastructureType(value)

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.

Values: INFRASTRUCTURE_TYPE_UNSPECIFIED (0): No type was specified. Some Hub functionality may require a type be specified, and will not support Memberships with this value. ON_PREM (1): Private infrastructure that is owned or operated by customer. This includes GKE distributions such as GKE-OnPrem and GKE-OnBareMetal. MULTI_CLOUD (2): Public cloud infrastructure.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.