Package com.google.api.services.rcsbusinessmessaging.v1.model

Class MediaRequestInfo

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.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 RCS Business Messaging 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

        java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      MediaRequestInfo clone()  
      java.lang.Long getCurrentBytes()
      The number of current bytes uploaded or downloaded.
      java.lang.String getCustomData()
      Data to be copied to backend requests.
      java.lang.String getDiffObjectVersion()
      Set if the http request info is diff encoded.
      java.lang.Integer getFinalStatus()  
      java.lang.String getNotificationType()
      The type of notification received from Scotty.
      java.lang.String getRequestId()
      The Scotty request ID.
      java.lang.Long getTotalBytes()
      The total size of the file.
      java.lang.Boolean getTotalBytesIsEstimated()
      Whether the total bytes field contains an estimated data.
      MediaRequestInfo set​(java.lang.String fieldName, java.lang.Object value)  
      MediaRequestInfo setCurrentBytes​(java.lang.Long currentBytes)
      The number of current bytes uploaded or downloaded.
      MediaRequestInfo setCustomData​(java.lang.String customData)
      Data to be copied to backend requests.
      MediaRequestInfo setDiffObjectVersion​(java.lang.String diffObjectVersion)
      Set if the http request info is diff encoded.
      MediaRequestInfo setFinalStatus​(java.lang.Integer finalStatus)  
      MediaRequestInfo setNotificationType​(java.lang.String notificationType)
      The type of notification received from Scotty.
      MediaRequestInfo setRequestId​(java.lang.String requestId)
      The Scotty request ID.
      MediaRequestInfo setTotalBytes​(java.lang.Long totalBytes)
      The total size of the file.
      MediaRequestInfo setTotalBytesIsEstimated​(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

      • Methods inherited from class java.util.AbstractMap

        clear, containsKey, containsValue, equals, hashCode, 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 java.lang.Long getCurrentBytes()
        The number of current bytes uploaded or downloaded.
        Returns:
        value or null for none

      • setCurrentBytes

        public MediaRequestInfo setCurrentBytes​(java.lang.Long currentBytes)
        The number of current bytes uploaded or downloaded.
        Parameters:
        currentBytes - currentBytes or null for none

      • getCustomData

        public java.lang.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​(java.lang.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 java.lang.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​(java.lang.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 java.lang.Integer getFinalStatus()
        Returns:
        value or null for none

      • setFinalStatus

        public MediaRequestInfo setFinalStatus​(java.lang.Integer finalStatus)
        Parameters:
        finalStatus - finalStatus or null for none

      • getNotificationType

        public java.lang.String getNotificationType()
        The type of notification received from Scotty.
        Returns:
        value or null for none

      • setNotificationType

        public MediaRequestInfo setNotificationType​(java.lang.String notificationType)
        The type of notification received from Scotty.
        Parameters:
        notificationType - notificationType or null for none

      • getRequestId

        public java.lang.String getRequestId()
        The Scotty request ID.
        Returns:
        value or null for none

      • setRequestId

        public MediaRequestInfo setRequestId​(java.lang.String requestId)
        The Scotty request ID.
        Parameters:
        requestId - requestId or null for none

      • getTotalBytes

        public java.lang.Long getTotalBytes()
        The total size of the file.
        Returns:
        value or null for none

      • setTotalBytes

        public MediaRequestInfo setTotalBytes​(java.lang.Long totalBytes)
        The total size of the file.
        Parameters:
        totalBytes - totalBytes or null for none

      • getTotalBytesIsEstimated

        public java.lang.Boolean getTotalBytesIsEstimated()
        Whether the total bytes field contains an estimated data.
        Returns:
        value or null for none

      • setTotalBytesIsEstimated

        public MediaRequestInfo setTotalBytesIsEstimated​(java.lang.Boolean totalBytesIsEstimated)
        Whether the total bytes field contains an estimated data.
        Parameters:
        totalBytesIsEstimated - totalBytesIsEstimated or null for none

      • set

        public MediaRequestInfo set​(java.lang.String fieldName,
                            java.lang.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