Class Label (0.54.0)

public final class Label extends GeneratedMessage implements LabelOrBuilder

A Label is additional information that can be added to an entity.

Protobuf type google.ads.admanager.v1.Label

Implements

LabelOrBuilder

Static Fields

ACTIVE_FIELD_NUMBER

public static final int ACTIVE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TYPES_FIELD_NUMBER

public static final int TYPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Label getDefaultInstance()
Returns
Type Description
Label

getDescriptor()

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

newBuilder()

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

newBuilder(Label prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getActive()

public boolean getActive()

Output only. Specifies whether or not the label is active.

optional bool active = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The active.

getDefaultInstanceForType()

public Label getDefaultInstanceForType()
Returns
Type Description
Label

getDescription()

public String getDescription()

Optional. A description of the label. This attribute has a maximum length of 255 characters.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A description of the label. This attribute has a maximum length of 255 characters.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. Display name of the Label. This attribute has a maximum length of 127 characters.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. Display name of the Label. This attribute has a maximum length of 127 characters.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Identifier. The resource name of the Label. Format: networks/{network_code}/labels/{label_id}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the Label. Format: networks/{network_code}/labels/{label_id}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTypes(int index)

public LabelTypeEnum.LabelType getTypes(int index)

Required. Unordered list. The types of the Label.

repeated .google.ads.admanager.v1.LabelTypeEnum.LabelType types = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
LabelTypeEnum.LabelType

The types at the given index.

getTypesCount()

public int getTypesCount()

Required. Unordered list. The types of the Label.

repeated .google.ads.admanager.v1.LabelTypeEnum.LabelType types = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns
Type Description
int

The count of types.

getTypesList()

public List<LabelTypeEnum.LabelType> getTypesList()

Required. Unordered list. The types of the Label.

repeated .google.ads.admanager.v1.LabelTypeEnum.LabelType types = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns
Type Description
List<LabelType>

A list containing the types.

getTypesValue(int index)

public int getTypesValue(int index)

Required. Unordered list. The types of the Label.

repeated .google.ads.admanager.v1.LabelTypeEnum.LabelType types = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of types at the given index.

getTypesValueList()

public List<Integer> getTypesValueList()

Required. Unordered list. The types of the Label.

repeated .google.ads.admanager.v1.LabelTypeEnum.LabelType types = 7 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = UNORDERED_LIST];

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for types.

hasActive()

public boolean hasActive()

Output only. Specifies whether or not the label is active.

optional bool active = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the active field is set.

hasDescription()

public boolean hasDescription()

Optional. A description of the label. This attribute has a maximum length of 255 characters.

optional string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the description field is set.

hasDisplayName()

public boolean hasDisplayName()

Required. Display name of the Label. This attribute has a maximum length of 127 characters.

optional string display_name = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the displayName field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Label.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Label.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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