Label (Gmail API v1 (Rev. 95) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.gmail.model.Label

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Label
extends com.google.api.client.json.GenericJson
```
Labels are used to categorize messages and threads within the user's mailbox.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Label()

Constructors
Constructor and Description
`Label()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Label`	`clone()`
`LabelColor`	`getColor()` The color to assign to the label.
`java.lang.String`	`getId()` The immutable ID of the label.
`java.lang.String`	`getLabelListVisibility()` The visibility of the label in the label list in the Gmail web interface.
`java.lang.String`	`getMessageListVisibility()` The visibility of the label in the message list in the Gmail web interface.
`java.lang.Integer`	`getMessagesTotal()` The total number of messages with the label.
`java.lang.Integer`	`getMessagesUnread()` The number of unread messages with the label.
`java.lang.String`	`getName()` The display name of the label.
`java.lang.Integer`	`getThreadsTotal()` The total number of threads with the label.
`java.lang.Integer`	`getThreadsUnread()` The number of unread threads with the label.
`java.lang.String`	`getType()` The owner type for the label.
`Label`	`set(java.lang.String fieldName, java.lang.Object value)`
`Label`	`setColor(LabelColor color)` The color to assign to the label.
`Label`	`setId(java.lang.String id)` The immutable ID of the label.
`Label`	`setLabelListVisibility(java.lang.String labelListVisibility)` The visibility of the label in the label list in the Gmail web interface.
`Label`	`setMessageListVisibility(java.lang.String messageListVisibility)` The visibility of the label in the message list in the Gmail web interface.
`Label`	`setMessagesTotal(java.lang.Integer messagesTotal)` The total number of messages with the label.
`Label`	`setMessagesUnread(java.lang.Integer messagesUnread)` The number of unread messages with the label.
`Label`	`setName(java.lang.String name)` The display name of the label.
`Label`	`setThreadsTotal(java.lang.Integer threadsTotal)` The total number of threads with the label.
`Label`	`setThreadsUnread(java.lang.Integer threadsUnread)` The number of unread threads with the label.
`Label`	`setType(java.lang.String type)` The owner type for the label.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Label
```
public Label()
```
- Method Detail
  - getColor
```
public LabelColor getColor()
```
    The color to assign to the label. Color is only available for labels that have their type set to user.
    
    Returns:
    
    value or null for none
  - setColor
```
public Label setColor(LabelColor color)
```
    The color to assign to the label. Color is only available for labels that have their type set to user.
    
    Parameters:
    
    color - color or null for none
  - getId
```
public java.lang.String getId()
```
    The immutable ID of the label.
    
    Returns:
    
    value or null for none
  - setId
```
public Label setId(java.lang.String id)
```
    The immutable ID of the label.
    
    Parameters:
    
    id - id or null for none
  - getLabelListVisibility
```
public java.lang.String getLabelListVisibility()
```
    The visibility of the label in the label list in the Gmail web interface.
    
    Returns:
    
    value or null for none
  - setLabelListVisibility
```
public Label setLabelListVisibility(java.lang.String labelListVisibility)
```
    The visibility of the label in the label list in the Gmail web interface.
    
    Parameters:
    
    labelListVisibility - labelListVisibility or null for none
  - getMessageListVisibility
```
public java.lang.String getMessageListVisibility()
```
    The visibility of the label in the message list in the Gmail web interface.
    
    Returns:
    
    value or null for none
  - setMessageListVisibility
```
public Label setMessageListVisibility(java.lang.String messageListVisibility)
```
    The visibility of the label in the message list in the Gmail web interface.
    
    Parameters:
    
    messageListVisibility - messageListVisibility or null for none
  - getMessagesTotal
```
public java.lang.Integer getMessagesTotal()
```
    The total number of messages with the label.
    
    Returns:
    
    value or null for none
  - setMessagesTotal
```
public Label setMessagesTotal(java.lang.Integer messagesTotal)
```
    The total number of messages with the label.
    
    Parameters:
    
    messagesTotal - messagesTotal or null for none
  - getMessagesUnread
```
public java.lang.Integer getMessagesUnread()
```
    The number of unread messages with the label.
    
    Returns:
    
    value or null for none
  - setMessagesUnread
```
public Label setMessagesUnread(java.lang.Integer messagesUnread)
```
    The number of unread messages with the label.
    
    Parameters:
    
    messagesUnread - messagesUnread or null for none
  - getName
```
public java.lang.String getName()
```
    The display name of the label.
    
    Returns:
    
    value or null for none
  - setName
```
public Label setName(java.lang.String name)
```
    The display name of the label.
    
    Parameters:
    
    name - name or null for none
  - getThreadsTotal
```
public java.lang.Integer getThreadsTotal()
```
    The total number of threads with the label.
    
    Returns:
    
    value or null for none
  - setThreadsTotal
```
public Label setThreadsTotal(java.lang.Integer threadsTotal)
```
    The total number of threads with the label.
    
    Parameters:
    
    threadsTotal - threadsTotal or null for none
  - getThreadsUnread
```
public java.lang.Integer getThreadsUnread()
```
    The number of unread threads with the label.
    
    Returns:
    
    value or null for none
  - setThreadsUnread
```
public Label setThreadsUnread(java.lang.Integer threadsUnread)
```
    The number of unread threads with the label.
    
    Parameters:
    
    threadsUnread - threadsUnread or null for none
  - getType
```
public java.lang.String getType()
```
    The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
    
    Returns:
    
    value or null for none
  - setType
```
public Label setType(java.lang.String type)
```
    The owner type for the label. User labels are created by the user and can be modified and deleted by the user and can be applied to any message or thread. System labels are internally created and cannot be added, modified, or deleted. System labels may be able to be applied to or removed from messages and threads under some circumstances but this is not guaranteed. For example, users can apply and remove the INBOX and UNREAD labels from messages and threads, but cannot apply or remove the DRAFTS or SENT labels from messages or threads.
    
    Parameters:
    
    type - type or null for none
  - set
```
public Label set(java.lang.String fieldName,
                 java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Label clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Gmail API v1 (revision 95)

Class Label

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Label

Method Detail

getColor

setColor

getId

setId

getLabelListVisibility

setLabelListVisibility

getMessageListVisibility

setMessageListVisibility

getMessagesTotal

setMessagesTotal

getMessagesUnread

setMessagesUnread

getName

setName

getThreadsTotal

setThreadsTotal

getThreadsUnread

setThreadsUnread

getType

setType

set

clone