Class SetLabelsRequest (2.56.0)

public final class SetLabelsRequest extends GeneratedMessageV3 implements SetLabelsRequestOrBuilder

SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster

Protobuf type google.container.v1.SetLabelsRequest

Static Fields

CLUSTER_ID_FIELD_NUMBER

public static final int CLUSTER_ID_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_LABELS_FIELD_NUMBER

public static final int RESOURCE_LABELS_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SetLabelsRequest getDefaultInstance()
Returns
Type Description
SetLabelsRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SetLabelsRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsResourceLabels(String key)

public boolean containsResourceLabels(String key)

Required. The labels to set for that cluster.

map<string, string> resource_labels = 4 [(.google.api.field_behavior) = REQUIRED];

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

getClusterId() (deprecated)

public String getClusterId()

Deprecated. google.container.v1.SetLabelsRequest.cluster_id is deprecated. See google/container/v1/cluster_service.proto;l=4448

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

string cluster_id = 3 [deprecated = true];

Returns
Type Description
String

The clusterId.

getClusterIdBytes() (deprecated)

public ByteString getClusterIdBytes()

Deprecated. google.container.v1.SetLabelsRequest.cluster_id is deprecated. See google/container/v1/cluster_service.proto;l=4448

Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.

string cluster_id = 3 [deprecated = true];

Returns
Type Description
ByteString

The bytes for clusterId.

getDefaultInstanceForType()

public SetLabelsRequest getDefaultInstanceForType()
Returns
Type Description
SetLabelsRequest

getLabelFingerprint()

public String getLabelFingerprint()

Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

string label_fingerprint = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a get() request to the resource to get the latest fingerprint.

string label_fingerprint = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getName()

public String getName()

The name (project, location, cluster name) of the cluster to set labels. Specified in the format projects/*/locations/*/clusters/*.

string name = 7;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name (project, location, cluster name) of the cluster to set labels. Specified in the format projects/*/locations/*/clusters/*.

string name = 7;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getProjectId() (deprecated)

public String getProjectId()

Deprecated. google.container.v1.SetLabelsRequest.project_id is deprecated. See google/container/v1/cluster_service.proto;l=4438

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

string project_id = 1 [deprecated = true];

Returns
Type Description
String

The projectId.

getProjectIdBytes() (deprecated)

public ByteString getProjectIdBytes()

Deprecated. google.container.v1.SetLabelsRequest.project_id is deprecated. See google/container/v1/cluster_service.proto;l=4438

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field.

string project_id = 1 [deprecated = true];

Returns
Type Description
ByteString

The bytes for projectId.

getResourceLabels() (deprecated)

public Map<String,String> getResourceLabels()
Returns
Type Description
Map<String,String>

getResourceLabelsCount()

public int getResourceLabelsCount()

Required. The labels to set for that cluster.

map<string, string> resource_labels = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getResourceLabelsMap()

public Map<String,String> getResourceLabelsMap()

Required. The labels to set for that cluster.

map<string, string> resource_labels = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Map<String,String>

getResourceLabelsOrDefault(String key, String defaultValue)

public String getResourceLabelsOrDefault(String key, String defaultValue)

Required. The labels to set for that cluster.

map<string, string> resource_labels = 4 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getResourceLabelsOrThrow(String key)

public String getResourceLabelsOrThrow(String key)

Required. The labels to set for that cluster.

map<string, string> resource_labels = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
String

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getZone() (deprecated)

public String getZone()

Deprecated. google.container.v1.SetLabelsRequest.zone is deprecated. See google/container/v1/cluster_service.proto;l=4444

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

string zone = 2 [deprecated = true];

Returns
Type Description
String

The zone.

getZoneBytes() (deprecated)

public ByteString getZoneBytes()

Deprecated. google.container.v1.SetLabelsRequest.zone is deprecated. See google/container/v1/cluster_service.proto;l=4444

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field.

string zone = 2 [deprecated = true];

Returns
Type Description
ByteString

The bytes for zone.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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