GKE Hub V1 API - Class Google::Cloud::GkeHub::V1::Membership (v0.5.0)

Reference documentation and code samples for the GKE Hub V1 API class Google::Cloud::GkeHub::V1::Membership.

Membership contains information about a member cluster.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#authority

def authority() -> ::Google::Cloud::GkeHub::V1::Authority
Returns
  • (::Google::Cloud::GkeHub::V1::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

#authority=

def authority=(value) -> ::Google::Cloud::GkeHub::V1::Authority
Parameter
  • value (::Google::Cloud::GkeHub::V1::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
Returns
  • (::Google::Cloud::GkeHub::V1::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

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#delete_time

def delete_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Output only. Description of this membership, limited to 63 characters. Must match the regex: [a-zA-Z0-9][a-zA-Z0-9_\-\.\ ]*

    This field is present for legacy purposes.

#endpoint

def endpoint() -> ::Google::Cloud::GkeHub::V1::MembershipEndpoint
Returns

#endpoint=

def endpoint=(value) -> ::Google::Cloud::GkeHub::V1::MembershipEndpoint
Parameter
Returns

#external_id

def external_id() -> ::String
Returns
  • (::String) — Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended.

    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.

#external_id=

def external_id=(value) -> ::String
Parameter
  • value (::String) — Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended.

    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.

Returns
  • (::String) — Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended.

    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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels for this membership.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels for this membership.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Labels for this membership.

#last_connection_time

def last_connection_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::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.

#monitoring_config

def monitoring_config() -> ::Google::Cloud::GkeHub::V1::MonitoringConfig
Returns

#monitoring_config=

def monitoring_config=(value) -> ::Google::Cloud::GkeHub::V1::MonitoringConfig
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — 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.

#state

def state() -> ::Google::Cloud::GkeHub::V1::MembershipState
Returns

#unique_id

def unique_id() -> ::String
Returns
  • (::String) — 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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns