com.google.api.services.drive

Class Drive.Files.ListLabels

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.drive.DriveRequest<LabelList>

com.google.api.services.drive.Drive.Files.ListLabels

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Files

public class Drive.Files.ListLabels
extends DriveRequest<LabelList>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListLabels(String fileId) Lists the labels on a file.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFileId() The ID of the file.
Integer	getMaxResults() The maximum number of labels to return per page.
String	getPageToken() The token for continuing a previous list request on the next page.
Drive.Files.ListLabels	set(String parameterName, Object value)
Drive.Files.ListLabels	setAlt(String alt) Data format for the response.
Drive.Files.ListLabels	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Files.ListLabels	setFileId(String fileId) The ID of the file.
Drive.Files.ListLabels	setKey(String key) API key.
Drive.Files.ListLabels	setMaxResults(Integer maxResults) The maximum number of labels to return per page.
Drive.Files.ListLabels	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.ListLabels	setPageToken(String pageToken) The token for continuing a previous list request on the next page.
Drive.Files.ListLabels	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.ListLabels	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Drive.Files.ListLabels	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.drive.DriveRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

ListLabels

protected ListLabels(String fileId)

Lists the labels on a file. Create a request for the method "files.listLabels". This request holds the parameters needed by the the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

fileId - The ID of the file.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LabelList>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<LabelList>

Throws:

IOException

setAlt

public Drive.Files.ListLabels setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<LabelList>

setFields

public Drive.Files.ListLabels setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<LabelList>

setKey

public Drive.Files.ListLabels setKey(String key)

Description copied from class: DriveRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DriveRequest<LabelList>

setOauthToken

public Drive.Files.ListLabels setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<LabelList>

setPrettyPrint

public Drive.Files.ListLabels setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<LabelList>

setQuotaUser

public Drive.Files.ListLabels setQuotaUser(String quotaUser)

Description copied from class: DriveRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DriveRequest<LabelList>

setUserIp

public Drive.Files.ListLabels setUserIp(String userIp)

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<LabelList>

getFileId

public String getFileId()

The ID of the file.

setFileId

public Drive.Files.ListLabels setFileId(String fileId)

The ID of the file.

getMaxResults

public Integer getMaxResults()

The maximum number of labels to return per page. When not set, this defaults to 100. [default: 100] [minimum: 1] [maximum: 100]

setMaxResults

public Drive.Files.ListLabels setMaxResults(Integer maxResults)

The maximum number of labels to return per page. When not set, this defaults to 100.

getPageToken

public String getPageToken()

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

setPageToken

public Drive.Files.ListLabels setPageToken(String pageToken)

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

set

public Drive.Files.ListLabels set(String parameterName,
                                  Object value)

Overrides:

set in class DriveRequest<LabelList>