com.google.api.services.walletobjects.model

Class MediaRequestInfo

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.walletobjects.model.MediaRequestInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class MediaRequestInfo
extends com.google.api.client.json.GenericJson

Extra information added to operations that support Scotty media requests.

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 Google Wallet 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
MediaRequestInfo()

Method Summary

Modifier and Type	Method and Description
MediaRequestInfo	clone()
byte[]	decodeRequestReceivedParamsServingInfo() The partition of the Scotty server handling this request.
MediaRequestInfo	encodeRequestReceivedParamsServingInfo(byte[] requestReceivedParamsServingInfo) The partition of the Scotty server handling this request.
Long	getCurrentBytes() The number of current bytes uploaded or downloaded.
String	getCustomData() Data to be copied to backend requests.
String	getDiffObjectVersion() Set if the http request info is diff encoded.
Integer	getFinalStatus()
String	getNotificationType() The type of notification received from Scotty.
String	getRequestId() The Scotty request ID.
String	getRequestReceivedParamsServingInfo() The partition of the Scotty server handling this request.
Long	getTotalBytes() The total size of the file.
Boolean	getTotalBytesIsEstimated() Whether the total bytes field contains an estimated data.
MediaRequestInfo	set(String fieldName, Object value)
MediaRequestInfo	setCurrentBytes(Long currentBytes) The number of current bytes uploaded or downloaded.
MediaRequestInfo	setCustomData(String customData) Data to be copied to backend requests.
MediaRequestInfo	setDiffObjectVersion(String diffObjectVersion) Set if the http request info is diff encoded.
MediaRequestInfo	setFinalStatus(Integer finalStatus)
MediaRequestInfo	setNotificationType(String notificationType) The type of notification received from Scotty.
MediaRequestInfo	setRequestId(String requestId) The Scotty request ID.
MediaRequestInfo	setRequestReceivedParamsServingInfo(String requestReceivedParamsServingInfo) The partition of the Scotty server handling this request.
MediaRequestInfo	setTotalBytes(Long totalBytes) The total size of the file.
MediaRequestInfo	setTotalBytesIsEstimated(Boolean totalBytesIsEstimated) Whether the total bytes field contains an estimated data.

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

MediaRequestInfo

public MediaRequestInfo()

Method Detail

getCurrentBytes

public Long getCurrentBytes()

The number of current bytes uploaded or downloaded.

Returns:

value or null for none

setCurrentBytes

public MediaRequestInfo setCurrentBytes(Long currentBytes)

The number of current bytes uploaded or downloaded.

Parameters:

currentBytes - currentBytes or null for none

getCustomData

public String getCustomData()

Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.

Returns:

value or null for none

setCustomData

public MediaRequestInfo setCustomData(String customData)

Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.

Parameters:

customData - customData or null for none

getDiffObjectVersion

public String getDiffObjectVersion()

Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.

Returns:

value or null for none

setDiffObjectVersion

public MediaRequestInfo setDiffObjectVersion(String diffObjectVersion)

Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.

Parameters:

diffObjectVersion - diffObjectVersion or null for none

getFinalStatus

public Integer getFinalStatus()

Returns:

value or null for none

setFinalStatus

public MediaRequestInfo setFinalStatus(Integer finalStatus)

Parameters:

finalStatus - finalStatus or null for none

getNotificationType

public String getNotificationType()

The type of notification received from Scotty.

Returns:

value or null for none

setNotificationType

public MediaRequestInfo setNotificationType(String notificationType)

The type of notification received from Scotty.

Parameters:

notificationType - notificationType or null for none

getRequestId

public String getRequestId()

The Scotty request ID.

Returns:

value or null for none

setRequestId

public MediaRequestInfo setRequestId(String requestId)

The Scotty request ID.

Parameters:

requestId - requestId or null for none

getRequestReceivedParamsServingInfo

public String getRequestReceivedParamsServingInfo()

The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()

Returns:

value or null for none

See Also:

decodeRequestReceivedParamsServingInfo()

decodeRequestReceivedParamsServingInfo

public byte[] decodeRequestReceivedParamsServingInfo()

The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getRequestReceivedParamsServingInfo()

setRequestReceivedParamsServingInfo

public MediaRequestInfo setRequestReceivedParamsServingInfo(String requestReceivedParamsServingInfo)

The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()

Parameters:

requestReceivedParamsServingInfo - requestReceivedParamsServingInfo or null for none

See Also:

#encodeRequestReceivedParamsServingInfo()

encodeRequestReceivedParamsServingInfo

public MediaRequestInfo encodeRequestReceivedParamsServingInfo(byte[] requestReceivedParamsServingInfo)

The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getTotalBytes

public Long getTotalBytes()

The total size of the file.

Returns:

value or null for none

setTotalBytes

public MediaRequestInfo setTotalBytes(Long totalBytes)

The total size of the file.

Parameters:

totalBytes - totalBytes or null for none

getTotalBytesIsEstimated

public Boolean getTotalBytesIsEstimated()

Whether the total bytes field contains an estimated data.

Returns:

value or null for none

setTotalBytesIsEstimated

public MediaRequestInfo setTotalBytesIsEstimated(Boolean totalBytesIsEstimated)

Whether the total bytes field contains an estimated data.

Parameters:

totalBytesIsEstimated - totalBytesIsEstimated or null for none

set

public MediaRequestInfo set(String fieldName,
                            Object value)

Overrides:

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

clone

public MediaRequestInfo clone()

Overrides:

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