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

Class BatchGetUsersResponse

  • All Implemented Interfaces:
    java.lang.Cloneable, java.util.Map<java.lang.String,​java.lang.Object>
    public final class BatchGetUsersResponse
extends com.google.api.client.json.GenericJson
    Response message for RBMService.BatchGetUsers method.

    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
      BatchGetUsersResponse clone()  
      java.lang.Integer getReachableRandomSampleUserCount()
      Amount of users' phone numbers from the randomly selected list that are RCS-enabled regardless of the launch status for the agent.
      java.util.List<java.lang.String> getReachableUsers()
      List of users' phone numbers that can be reached from the RBM platform.
      java.lang.Integer getTotalRandomSampleUserCount()
      Amount of users' phone number randomly selected from the request.
      BatchGetUsersResponse set​(java.lang.String fieldName, java.lang.Object value)  
      BatchGetUsersResponse setReachableRandomSampleUserCount​(java.lang.Integer reachableRandomSampleUserCount)
      Amount of users' phone numbers from the randomly selected list that are RCS-enabled regardless of the launch status for the agent.
      BatchGetUsersResponse setReachableUsers​(java.util.List<java.lang.String> reachableUsers)
      List of users' phone numbers that can be reached from the RBM platform.
      BatchGetUsersResponse setTotalRandomSampleUserCount​(java.lang.Integer totalRandomSampleUserCount)
      Amount of users' phone number randomly selected from the request.

      • 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

      • BatchGetUsersResponse

        public BatchGetUsersResponse()

    • Method Detail

      • getReachableRandomSampleUserCount

        public java.lang.Integer getReachableRandomSampleUserCount()
        Amount of users' phone numbers from the randomly selected list that are RCS-enabled regardless of the launch status for the agent. The ratio between this value and the total_random_sample_user_count can be used to approximate the potential reach for a list of users.
        Returns:
        value or null for none

      • setReachableRandomSampleUserCount

        public BatchGetUsersResponse setReachableRandomSampleUserCount​(java.lang.Integer reachableRandomSampleUserCount)
        Amount of users' phone numbers from the randomly selected list that are RCS-enabled regardless of the launch status for the agent. The ratio between this value and the total_random_sample_user_count can be used to approximate the potential reach for a list of users.
        Parameters:
        reachableRandomSampleUserCount - reachableRandomSampleUserCount or null for none

      • getReachableUsers

        public java.util.List<java.lang.String> getReachableUsers()
        List of users' phone numbers that can be reached from the RBM platform. Only users on carriers that the agent is launched on will be returned.
        Returns:
        value or null for none

      • setReachableUsers

        public BatchGetUsersResponse setReachableUsers​(java.util.List<java.lang.String> reachableUsers)
        List of users' phone numbers that can be reached from the RBM platform. Only users on carriers that the agent is launched on will be returned.
        Parameters:
        reachableUsers - reachableUsers or null for none

      • getTotalRandomSampleUserCount

        public java.lang.Integer getTotalRandomSampleUserCount()
        Amount of users' phone number randomly selected from the request. Typically this value will be ~75% of the total requested users in the initial BatchGetUsers request. This value will be 0 if the amount of requested users is less than 500.
        Returns:
        value or null for none

      • setTotalRandomSampleUserCount

        public BatchGetUsersResponse setTotalRandomSampleUserCount​(java.lang.Integer totalRandomSampleUserCount)
        Amount of users' phone number randomly selected from the request. Typically this value will be ~75% of the total requested users in the initial BatchGetUsers request. This value will be 0 if the amount of requested users is less than 500.
        Parameters:
        totalRandomSampleUserCount - totalRandomSampleUserCount or null for none

      • set

        public BatchGetUsersResponse set​(java.lang.String fieldName,
                                 java.lang.Object value)
        Overrides:
        set in class com.google.api.client.json.GenericJson

      • clone

        public BatchGetUsersResponse clone()
        Overrides:
        clone in class com.google.api.client.json.GenericJson