Class Membership

  • All Implemented Interfaces:
    MembershipOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Membership
    extends com.google.protobuf.GeneratedMessageV3
    implements MembershipOrBuilder
     Membership contains information about a member cluster.
     
    Protobuf type google.cloud.gkehub.v1alpha2.Membership
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getName

        public String getName()
         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.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface MembershipOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         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.
         
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface MembershipOrBuilder
        Returns:
        The bytes for name.
      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: MembershipOrBuilder
         Optional. GCP labels for this membership.
         
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsCount in interface MembershipOrBuilder
      • containsLabels

        public boolean containsLabels​(String key)
         Optional. GCP labels for this membership.
         
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface MembershipOrBuilder
      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. GCP labels for this membership.
         
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface MembershipOrBuilder
      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                         String defaultValue)
         Optional. GCP labels for this membership.
         
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface MembershipOrBuilder
      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. GCP labels for this membership.
         
        map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface MembershipOrBuilder
      • getDescription

        public String getDescription()
         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.
         
        string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDescription in interface MembershipOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         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.
         
        string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDescriptionBytes in interface MembershipOrBuilder
        Returns:
        The bytes for description.
      • hasEndpoint

        public boolean hasEndpoint()
         Optional. Endpoint information to reach this member.
         
        .google.cloud.gkehub.v1alpha2.MembershipEndpoint endpoint = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasEndpoint in interface MembershipOrBuilder
        Returns:
        Whether the endpoint field is set.
      • getEndpoint

        public MembershipEndpoint getEndpoint()
         Optional. Endpoint information to reach this member.
         
        .google.cloud.gkehub.v1alpha2.MembershipEndpoint endpoint = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEndpoint in interface MembershipOrBuilder
        Returns:
        The endpoint.
      • hasState

        public boolean hasState()
         Output only. State of the Membership resource.
         
        .google.cloud.gkehub.v1alpha2.MembershipState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasState in interface MembershipOrBuilder
        Returns:
        Whether the state field is set.
      • getState

        public MembershipState getState()
         Output only. State of the Membership resource.
         
        .google.cloud.gkehub.v1alpha2.MembershipState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface MembershipOrBuilder
        Returns:
        The state.
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. When the Membership was created.
         
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface MembershipOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. When the Membership was created.
         
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface MembershipOrBuilder
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. When the Membership was created.
         
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface MembershipOrBuilder
      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. When the Membership was last updated.
         
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface MembershipOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. When the Membership was last updated.
         
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface MembershipOrBuilder
        Returns:
        The updateTime.
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. When the Membership was last updated.
         
        .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface MembershipOrBuilder
      • hasDeleteTime

        public boolean hasDeleteTime()
         Output only. When the Membership was deleted.
         
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasDeleteTime in interface MembershipOrBuilder
        Returns:
        Whether the deleteTime field is set.
      • getDeleteTime

        public com.google.protobuf.Timestamp getDeleteTime()
         Output only. When the Membership was deleted.
         
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTime in interface MembershipOrBuilder
        Returns:
        The deleteTime.
      • getDeleteTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getDeleteTimeOrBuilder()
         Output only. When the Membership was deleted.
         
        .google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getDeleteTimeOrBuilder in interface MembershipOrBuilder
      • getExternalId

        public String getExternalId()
         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.
         
        string external_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExternalId in interface MembershipOrBuilder
        Returns:
        The externalId.
      • getExternalIdBytes

        public com.google.protobuf.ByteString getExternalIdBytes()
         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.
         
        string external_id = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getExternalIdBytes in interface MembershipOrBuilder
        Returns:
        The bytes for externalId.
      • hasAuthority

        public boolean hasAuthority()
         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
         
        .google.cloud.gkehub.v1alpha2.Authority authority = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasAuthority in interface MembershipOrBuilder
        Returns:
        Whether the authority field is set.
      • getAuthority

        public Authority getAuthority()
         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
         
        .google.cloud.gkehub.v1alpha2.Authority authority = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthority in interface MembershipOrBuilder
        Returns:
        The authority.
      • getAuthorityOrBuilder

        public AuthorityOrBuilder getAuthorityOrBuilder()
         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
         
        .google.cloud.gkehub.v1alpha2.Authority authority = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getAuthorityOrBuilder in interface MembershipOrBuilder
      • hasLastConnectionTime

        public boolean hasLastConnectionTime()
         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.
         
        .google.protobuf.Timestamp last_connection_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasLastConnectionTime in interface MembershipOrBuilder
        Returns:
        Whether the lastConnectionTime field is set.
      • getLastConnectionTime

        public com.google.protobuf.Timestamp getLastConnectionTime()
         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.
         
        .google.protobuf.Timestamp last_connection_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLastConnectionTime in interface MembershipOrBuilder
        Returns:
        The lastConnectionTime.
      • getLastConnectionTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getLastConnectionTimeOrBuilder()
         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.
         
        .google.protobuf.Timestamp last_connection_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLastConnectionTimeOrBuilder in interface MembershipOrBuilder
      • getUniqueId

        public String getUniqueId()
         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.
         
        string unique_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUniqueId in interface MembershipOrBuilder
        Returns:
        The uniqueId.
      • getUniqueIdBytes

        public com.google.protobuf.ByteString getUniqueIdBytes()
         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.
         
        string unique_id = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUniqueIdBytes in interface MembershipOrBuilder
        Returns:
        The bytes for uniqueId.
      • getInfrastructureTypeValue

        public int getInfrastructureTypeValue()
         Optional. The infrastructure type this Membership is running on.
         
        .google.cloud.gkehub.v1alpha2.Membership.InfrastructureType infrastructure_type = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getInfrastructureTypeValue in interface MembershipOrBuilder
        Returns:
        The enum numeric value on the wire for infrastructureType.
      • getInfrastructureType

        public Membership.InfrastructureType getInfrastructureType()
         Optional. The infrastructure type this Membership is running on.
         
        .google.cloud.gkehub.v1alpha2.Membership.InfrastructureType infrastructure_type = 13 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getInfrastructureType in interface MembershipOrBuilder
        Returns:
        The infrastructureType.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Membership parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Membership parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Membership parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Membership parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Membership parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Membership parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Membership parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Membership.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Membership.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Membership.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Membership getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Membership> parser()
      • getParserForType

        public com.google.protobuf.Parser<Membership> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Membership getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder