target.apidocs.com.google.api.services.gmail.model.BatchModifyMessagesRequest.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-gmail Show documentation

There is a newer version: v1-rev20240520-2.0.0

Show newest version







BatchModifyMessagesRequest (Gmail API v1-rev20230925-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.gmail.model
Class BatchModifyMessagesRequest



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.gmail.model.BatchModifyMessagesRequest













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class BatchModifyMessagesRequest
extends com.google.api.client.json.GenericJson
Model definition for BatchModifyMessagesRequest.

  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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


BatchModifyMessagesRequest() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BatchModifyMessagesRequest
clone() 


List<String>
getAddLabelIds()
A list of label IDs to add to messages.



List<String>
getIds()
The IDs of the messages to modify.



List<String>
getRemoveLabelIds()
A list of label IDs to remove from messages.



BatchModifyMessagesRequest
set(String fieldName,
   Object value) 


BatchModifyMessagesRequest
setAddLabelIds(List<String> addLabelIds)
A list of label IDs to add to messages.



BatchModifyMessagesRequest
setIds(List<String> ids)
The IDs of the messages to modify.



BatchModifyMessagesRequest
setRemoveLabelIds(List<String> removeLabelIds)
A list of label IDs to remove from messages.







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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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





BatchModifyMessagesRequest
public BatchModifyMessagesRequest()









Method Detail





getAddLabelIds
public List<String> getAddLabelIds()
A list of label IDs to add to messages.

Returns:
value or null for none








setAddLabelIds
public BatchModifyMessagesRequest setAddLabelIds(List<String> addLabelIds)
A list of label IDs to add to messages.

Parameters:
addLabelIds - addLabelIds or null for none








getIds
public List<String> getIds()
The IDs of the messages to modify. There is a limit of 1000 ids per request.

Returns:
value or null for none








setIds
public BatchModifyMessagesRequest setIds(List<String> ids)
The IDs of the messages to modify. There is a limit of 1000 ids per request.

Parameters:
ids - ids or null for none








getRemoveLabelIds
public List<String> getRemoveLabelIds()
A list of label IDs to remove from messages.

Returns:
value or null for none








setRemoveLabelIds
public BatchModifyMessagesRequest setRemoveLabelIds(List<String> removeLabelIds)
A list of label IDs to remove from messages.

Parameters:
removeLabelIds - removeLabelIds or null for none








set
public BatchModifyMessagesRequest set(String fieldName,
                                      Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public BatchModifyMessagesRequest clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.

Modifier and Type	Method and Description
`BatchModifyMessagesRequest`	`clone()`
`List<String>`	`getAddLabelIds()` A list of label IDs to add to messages.
`List<String>`	`getIds()` The IDs of the messages to modify.
`List<String>`	`getRemoveLabelIds()` A list of label IDs to remove from messages.
`BatchModifyMessagesRequest`	`set(String fieldName, Object value)`
`BatchModifyMessagesRequest`	`setAddLabelIds(List<String> addLabelIds)` A list of label IDs to add to messages.
`BatchModifyMessagesRequest`	`setIds(List<String> ids)` The IDs of the messages to modify.
`BatchModifyMessagesRequest`	`setRemoveLabelIds(List<String> removeLabelIds)` A list of label IDs to remove from messages.