Class Membership (1.12.0) 

public final class Membership extends GeneratedMessageV3 implements MembershipOrBuilder

Membership contains information about a member cluster.

Protobuf type google.cloud.gkehub.v1alpha2.Membership

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Membership

Implements

MembershipOrBuilder

Static Fields

AUTHORITY_FIELD_NUMBER

public static final int AUTHORITY_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DELETE_TIME_FIELD_NUMBER

public static final int DELETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

EXTERNAL_ID_FIELD_NUMBER

public static final int EXTERNAL_ID_FIELD_NUMBER
Field Value
Type Description
int

INFRASTRUCTURE_TYPE_FIELD_NUMBER

public static final int INFRASTRUCTURE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LAST_CONNECTION_TIME_FIELD_NUMBER

public static final int LAST_CONNECTION_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UNIQUE_ID_FIELD_NUMBER

public static final int UNIQUE_ID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Membership getDefaultInstance()
Returns
Type Description
Membership

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Membership.Builder newBuilder()
Returns
Type Description
Membership.Builder

newBuilder(Membership prototype)

public static Membership.Builder newBuilder(Membership prototype)
Parameter
Name Description
prototype Membership
Returns
Type Description
Membership.Builder

parseDelimitedFrom(InputStream input)

public static Membership parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Membership
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Membership parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Membership
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Membership parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Membership
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Membership parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Membership
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Membership parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Membership
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Membership parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Membership
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Membership parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Membership
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Membership parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Membership
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Membership parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Membership
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Membership parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Membership
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Membership parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Membership
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Membership parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Membership
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Membership> parser()
Returns
Type Description
Parser<Membership>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. GCP labels for this membership.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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];

Returns
Type Description
Authority

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];

Returns
Type Description
AuthorityOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. When the Membership was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. When the Membership was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Membership getDefaultInstanceForType()
Returns
Type Description
Membership

getDeleteTime()

public Timestamp getDeleteTime()

Output only. When the Membership was deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The deleteTime.

getDeleteTimeOrBuilder()

public TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. When the Membership was deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescription()

public String getDescription()

Output only. Description of this membership, limited to 63 characters. Must match the regex: a-zA-Z0-9* This field is present for legacy purposes.

string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. Description of this membership, limited to 63 characters. Must match the regex: a-zA-Z0-9* This field is present for legacy purposes.

string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for description.

getEndpoint()

public MembershipEndpoint getEndpoint()

Optional. Endpoint information to reach this member.

.google.cloud.gkehub.v1alpha2.MembershipEndpoint endpoint = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MembershipEndpoint

The endpoint.

getEndpointOrBuilder()

public MembershipEndpointOrBuilder getEndpointOrBuilder()

Optional. Endpoint information to reach this member.

.google.cloud.gkehub.v1alpha2.MembershipEndpoint endpoint = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MembershipEndpointOrBuilder

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* 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];

Returns
Type Description
String

The externalId.

getExternalIdBytes()

public 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* 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];

Returns
Type Description
ByteString

The bytes for externalId.

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];

Returns
Type Description
Membership.InfrastructureType

The infrastructureType.

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];

Returns
Type Description
int

The enum numeric value on the wire for infrastructureType.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. GCP labels for this membership.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. GCP labels for this membership.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. GCP labels for this membership.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. GCP labels for this membership.

map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getLastConnectionTime()

public 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];

Returns
Type Description
Timestamp

The lastConnectionTime.

getLastConnectionTimeOrBuilder()

public 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];

Returns
Type Description
TimestampOrBuilder

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?, with a maximum length of 63 characters.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public 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?, with a maximum length of 63 characters.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Membership> getParserForType()
Returns
Type Description
Parser<Membership>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public MembershipState getState()

Output only. State of the Membership resource.

.google.cloud.gkehub.v1alpha2.MembershipState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MembershipState

The state.

getStateOrBuilder()

public MembershipStateOrBuilder getStateOrBuilder()

Output only. State of the Membership resource.

.google.cloud.gkehub.v1alpha2.MembershipState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MembershipStateOrBuilder

getTypeCase()

public Membership.TypeCase getTypeCase()
Returns
Type Description
Membership.TypeCase

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];

Returns
Type Description
String

The uniqueId.

getUniqueIdBytes()

public 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];

Returns
Type Description
ByteString

The bytes for uniqueId.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. When the Membership was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. When the Membership was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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];

Returns
Type Description
boolean

Whether the authority field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. When the Membership was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDeleteTime()

public boolean hasDeleteTime()

Output only. When the Membership was deleted.

.google.protobuf.Timestamp delete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the deleteTime field is set.

hasEndpoint()

public boolean hasEndpoint()

Optional. Endpoint information to reach this member.

.google.cloud.gkehub.v1alpha2.MembershipEndpoint endpoint = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the endpoint field is set.

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];

Returns
Type Description
boolean

Whether the lastConnectionTime field is set.

hasState()

public boolean hasState()

Output only. State of the Membership resource.

.google.cloud.gkehub.v1alpha2.MembershipState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the state field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. When the Membership was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Membership.Builder newBuilderForType()
Returns
Type Description
Membership.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Membership.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Membership.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Membership.Builder toBuilder()
Returns
Type Description
Membership.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException