com.google.api.services.chat.v1

Class HangoutsChat.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.chat.v1.HangoutsChatRequest<Media>

com.google.api.services.chat.v1.HangoutsChat.Media.Download

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

HangoutsChat.Media

public class HangoutsChat.Media.Download
extends HangoutsChatRequest<Media>

Nested Class Summary

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

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

Method Summary

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

Methods inherited from class com.google.api.services.chat.v1.HangoutsChatRequest

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 `/v1/media/{+name}?alt=media`. Create a request for the method "media.download". This request holds the parameters needed by the the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

HangoutsChat.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 AbstractGoogleClientRequest<Media>

Throws:

IOException

executeMediaAsInputStream

public InputStream executeMediaAsInputStream()
                                      throws IOException

Overrides:

executeMediaAsInputStream in class AbstractGoogleClientRequest<Media>

Throws:

IOException

executeMedia

public HttpResponse executeMedia()
                          throws IOException

Overrides:

executeMedia in class AbstractGoogleClientRequest<Media>

Throws:

IOException

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Media>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Media>

Throws:

IOException

set$Xgafv

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

Description copied from class: HangoutsChatRequest

V1 error format.

Overrides:

set$Xgafv in class HangoutsChatRequest<Media>

setAccessToken

public HangoutsChat.Media.Download setAccessToken(String accessToken)

Description copied from class: HangoutsChatRequest

OAuth access token.

Overrides:

setAccessToken in class HangoutsChatRequest<Media>

setAlt

public HangoutsChat.Media.Download setAlt(String alt)

Description copied from class: HangoutsChatRequest

Data format for response.

Overrides:

setAlt in class HangoutsChatRequest<Media>

setCallback

public HangoutsChat.Media.Download setCallback(String callback)

Description copied from class: HangoutsChatRequest

JSONP

Overrides:

setCallback in class HangoutsChatRequest<Media>

setFields

public HangoutsChat.Media.Download setFields(String fields)

Description copied from class: HangoutsChatRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class HangoutsChatRequest<Media>

setKey

public HangoutsChat.Media.Download setKey(String key)

Description copied from class: HangoutsChatRequest

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 HangoutsChatRequest<Media>

setOauthToken

public HangoutsChat.Media.Download setOauthToken(String oauthToken)

Description copied from class: HangoutsChatRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class HangoutsChatRequest<Media>

setPrettyPrint

public HangoutsChat.Media.Download setPrettyPrint(Boolean prettyPrint)

Description copied from class: HangoutsChatRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class HangoutsChatRequest<Media>

setQuotaUser

public HangoutsChat.Media.Download setQuotaUser(String quotaUser)

Description copied from class: HangoutsChatRequest

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 HangoutsChatRequest<Media>

setUploadType

public HangoutsChat.Media.Download setUploadType(String uploadType)

Description copied from class: HangoutsChatRequest

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

Overrides:

setUploadType in class HangoutsChatRequest<Media>

setUploadProtocol

public HangoutsChat.Media.Download setUploadProtocol(String uploadProtocol)

Description copied from class: HangoutsChatRequest

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

Overrides:

setUploadProtocol in class HangoutsChatRequest<Media>

getResourceName

public String getResourceName()

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

setResourceName

public HangoutsChat.Media.Download setResourceName(String resourceName)

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

set

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

Overrides:

set in class HangoutsChatRequest<Media>