com.google.api.services.displayvideo.v4

Class DisplayVideo.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.displayvideo.v4.DisplayVideoRequest<GoogleBytestreamMedia>

com.google.api.services.displayvideo.v4.DisplayVideo.Media.Download

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DisplayVideo.Media

public class DisplayVideo.Media.Download
extends DisplayVideoRequest<GoogleBytestreamMedia>

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 resourceName) Downloads media.

Method Summary

Modifier and Type	Method and Description
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	getResourceName() Name of the media that is being downloaded.
DisplayVideo.Media.Download	set(String parameterName, Object value)
DisplayVideo.Media.Download	set$Xgafv(String $Xgafv) V1 error format.
DisplayVideo.Media.Download	setAccessToken(String accessToken) OAuth access token.
DisplayVideo.Media.Download	setAlt(String alt) Data format for response.
DisplayVideo.Media.Download	setCallback(String callback) JSONP
DisplayVideo.Media.Download	setFields(String fields) Selector specifying which fields to include in a partial response.
DisplayVideo.Media.Download	setKey(String key) API key.
DisplayVideo.Media.Download	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DisplayVideo.Media.Download	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DisplayVideo.Media.Download	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DisplayVideo.Media.Download	setResourceName(String resourceName) Name of the media that is being downloaded.
DisplayVideo.Media.Download	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DisplayVideo.Media.Download	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.displayvideo.v4.DisplayVideoRequest

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, buildHttpRequestUrl, 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 resourceName)

Downloads media. Download is supported on the URI `/download/{resource_name=**}?alt=media.` **Note**: Download requests will not be successful without including `alt=media` query string. Create a request for the method "media.download". This request holds the parameters needed by the the displayvideo server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

resourceName - Name of the media that is being downloaded. See ReadRequest.resource_name.

Since:

1.13

Method Detail

executeMediaAndDownloadTo

public void executeMediaAndDownloadTo(OutputStream outputStream)
                               throws IOException

Overrides:

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

Throws:

IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:

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

Throws:

IOException

executeMedia

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

Overrides:

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

Throws:

IOException

executeUsingHead

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

Overrides:

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

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

Description copied from class: DisplayVideoRequest

V1 error format.

Overrides:

set$Xgafv in class DisplayVideoRequest<GoogleBytestreamMedia>

setAccessToken

public DisplayVideo.Media.Download setAccessToken(String accessToken)

Description copied from class: DisplayVideoRequest

OAuth access token.

Overrides:

setAccessToken in class DisplayVideoRequest<GoogleBytestreamMedia>

setAlt

public DisplayVideo.Media.Download setAlt(String alt)

Description copied from class: DisplayVideoRequest

Data format for response.

Overrides:

setAlt in class DisplayVideoRequest<GoogleBytestreamMedia>

setCallback

public DisplayVideo.Media.Download setCallback(String callback)

Description copied from class: DisplayVideoRequest

JSONP

Overrides:

setCallback in class DisplayVideoRequest<GoogleBytestreamMedia>

setFields

public DisplayVideo.Media.Download setFields(String fields)

Description copied from class: DisplayVideoRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DisplayVideoRequest<GoogleBytestreamMedia>

setKey

public DisplayVideo.Media.Download setKey(String key)

Description copied from class: DisplayVideoRequest

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 DisplayVideoRequest<GoogleBytestreamMedia>

setOauthToken

public DisplayVideo.Media.Download setOauthToken(String oauthToken)

Description copied from class: DisplayVideoRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DisplayVideoRequest<GoogleBytestreamMedia>

setPrettyPrint

public DisplayVideo.Media.Download setPrettyPrint(Boolean prettyPrint)

Description copied from class: DisplayVideoRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DisplayVideoRequest<GoogleBytestreamMedia>

setQuotaUser

public DisplayVideo.Media.Download setQuotaUser(String quotaUser)

Description copied from class: DisplayVideoRequest

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 DisplayVideoRequest<GoogleBytestreamMedia>

setUploadType

public DisplayVideo.Media.Download setUploadType(String uploadType)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadType in class DisplayVideoRequest<GoogleBytestreamMedia>

setUploadProtocol

public DisplayVideo.Media.Download setUploadProtocol(String uploadProtocol)

Description copied from class: DisplayVideoRequest

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

Overrides:

setUploadProtocol in class DisplayVideoRequest<GoogleBytestreamMedia>

getResourceName

public String getResourceName()

Name of the media that is being downloaded. See ReadRequest.resource_name.

setResourceName

public DisplayVideo.Media.Download setResourceName(String resourceName)

Name of the media that is being downloaded. See ReadRequest.resource_name.

set

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

Overrides:

set in class DisplayVideoRequest<GoogleBytestreamMedia>