com.google.api.services.keep.v1

Class Keep.Media.Download

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.keep.v1.KeepRequest<Attachment>

com.google.api.services.keep.v1.Keep.Media.Download

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Keep.Media

public class Keep.Media.Download
extends KeepRequest<Attachment>

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Download(String name) Gets an attachment.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.GenericUrl	buildHttpRequestUrl()
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeMedia()
void	executeMediaAndDownloadTo(OutputStream outputStream)
InputStream	executeMediaAsInputStream()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getMimeType() The IANA MIME type format requested.
String	getName() Required.
Keep.Media.Download	set(String parameterName, Object value)
Keep.Media.Download	set$Xgafv(String $Xgafv) V1 error format.
Keep.Media.Download	setAccessToken(String accessToken) OAuth access token.
Keep.Media.Download	setAlt(String alt) Data format for response.
Keep.Media.Download	setCallback(String callback) JSONP
Keep.Media.Download	setFields(String fields) Selector specifying which fields to include in a partial response.
Keep.Media.Download	setKey(String key) API key.
Keep.Media.Download	setMimeType(String mimeType) The IANA MIME type format requested.
Keep.Media.Download	setName(String name) Required.
Keep.Media.Download	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Keep.Media.Download	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Keep.Media.Download	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Keep.Media.Download	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Keep.Media.Download	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.keep.v1.KeepRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, 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

Download

protected Download(String name)

Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type. Create a request for the method "media.download". This request holds the parameters needed by the the keep server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

name - Required. The name of the attachment.

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:

executeMediaAndDownloadTo in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Attachment>

Throws:

IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:

executeMediaAsInputStream in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Attachment>

Throws:

IOException

executeMedia

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

Overrides:

executeMedia in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Attachment>

Throws:

IOException

buildHttpRequestUrl

public com.google.api.client.http.GenericUrl buildHttpRequestUrl()

Overrides:

buildHttpRequestUrl in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Attachment>

executeUsingHead

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

Overrides:

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Keep.Media.Download set$Xgafv(String $Xgafv)

Description copied from class: KeepRequest

V1 error format.

Overrides:

set$Xgafv in class KeepRequest<Attachment>

setAccessToken

public Keep.Media.Download setAccessToken(String accessToken)

Description copied from class: KeepRequest

OAuth access token.

Overrides:

setAccessToken in class KeepRequest<Attachment>

setAlt

public Keep.Media.Download setAlt(String alt)

Description copied from class: KeepRequest

Data format for response.

Overrides:

setAlt in class KeepRequest<Attachment>

setCallback

public Keep.Media.Download setCallback(String callback)

Description copied from class: KeepRequest

JSONP

Overrides:

setCallback in class KeepRequest<Attachment>

setFields

public Keep.Media.Download setFields(String fields)

Description copied from class: KeepRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class KeepRequest<Attachment>

setKey

public Keep.Media.Download setKey(String key)

Description copied from class: KeepRequest

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 KeepRequest<Attachment>

setOauthToken

public Keep.Media.Download setOauthToken(String oauthToken)

Description copied from class: KeepRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class KeepRequest<Attachment>

setPrettyPrint

public Keep.Media.Download setPrettyPrint(Boolean prettyPrint)

Description copied from class: KeepRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class KeepRequest<Attachment>

setQuotaUser

public Keep.Media.Download setQuotaUser(String quotaUser)

Description copied from class: KeepRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class KeepRequest<Attachment>

setUploadType

public Keep.Media.Download setUploadType(String uploadType)

Description copied from class: KeepRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class KeepRequest<Attachment>

setUploadProtocol

public Keep.Media.Download setUploadProtocol(String uploadProtocol)

Description copied from class: KeepRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class KeepRequest<Attachment>

getName

public String getName()

Required. The name of the attachment.

setName

public Keep.Media.Download setName(String name)

Required. The name of the attachment.

getMimeType

public String getMimeType()

The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise.

setMimeType

public Keep.Media.Download setMimeType(String mimeType)

The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise.

set

public Keep.Media.Download set(String parameterName,
                               Object value)

Overrides:

set in class KeepRequest<Attachment>