com.google.api.services.fcmdata.v1beta1.model

Class GoogleFirebaseFcmDataV1beta1MessageOutcomePercents

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.fcmdata.v1beta1.model.GoogleFirebaseFcmDataV1beta1MessageOutcomePercents

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Percentage breakdown of message delivery outcomes. These categories are mutually exclusive. All percentages are calculated with countMessagesAccepted as the denominator. These categories may not account for all message outcomes.

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 Firebase Cloud Messaging Data 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
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents()

Method Summary

Modifier and Type	Method and Description
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	clone()
Float	getCollapsed() The percentage of accepted messages that were [collapsed](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_and_non-collapsible_messages) by another message.
Float	getDelivered() The percentage of all accepted messages that were successfully delivered to the device.
Float	getDroppedAppForceStopped() The percentage of accepted messages that were dropped because the application was force stopped on the device at the time of delivery and retries were unsuccessful.
Float	getDroppedDeviceInactive() The percentage of accepted messages that were dropped because the target device is inactive.
Float	getDroppedTooManyPendingMessages() The percentage of accepted messages that were dropped due to [too many undelivered non- collapsible messages](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_and_non-collapsible_messages).
Float	getDroppedTtlExpired() The percentage of accepted messages that expired because [Time To Live (TTL)](https://firebase.google.com/docs/cloud-messaging/concept-options#ttl) elapsed before the target device reconnected.
Float	getPending() The percentage of messages accepted on this day that were not dropped and not delivered, due to the device being disconnected (as of the end of the America/Los_Angeles day when the message was sent to FCM).
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	set(String fieldName, Object value)
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	setCollapsed(Float collapsed) The percentage of accepted messages that were [collapsed](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_and_non-collapsible_messages) by another message.
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	setDelivered(Float delivered) The percentage of all accepted messages that were successfully delivered to the device.
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	setDroppedAppForceStopped(Float droppedAppForceStopped) The percentage of accepted messages that were dropped because the application was force stopped on the device at the time of delivery and retries were unsuccessful.
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	setDroppedDeviceInactive(Float droppedDeviceInactive) The percentage of accepted messages that were dropped because the target device is inactive.
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	setDroppedTooManyPendingMessages(Float droppedTooManyPendingMessages) The percentage of accepted messages that were dropped due to [too many undelivered non- collapsible messages](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_and_non-collapsible_messages).
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	setDroppedTtlExpired(Float droppedTtlExpired) The percentage of accepted messages that expired because [Time To Live (TTL)](https://firebase.google.com/docs/cloud-messaging/concept-options#ttl) elapsed before the target device reconnected.
GoogleFirebaseFcmDataV1beta1MessageOutcomePercents	setPending(Float pending) The percentage of messages accepted on this day that were not dropped and not delivered, due to the device being disconnected (as of the end of the America/Los_Angeles day when the message was sent to FCM).

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

GoogleFirebaseFcmDataV1beta1MessageOutcomePercents

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents()

Method Detail

getCollapsed

public Float getCollapsed()

The percentage of accepted messages that were [collapsed](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_and_non-collapsible_messages) by another message.

Returns:

value or null for none

setCollapsed

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents setCollapsed(Float collapsed)

The percentage of accepted messages that were [collapsed](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_and_non-collapsible_messages) by another message.

Parameters:

collapsed - collapsed or null for none

getDelivered

public Float getDelivered()

The percentage of all accepted messages that were successfully delivered to the device.

Returns:

value or null for none

setDelivered

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents setDelivered(Float delivered)

The percentage of all accepted messages that were successfully delivered to the device.

Parameters:

delivered - delivered or null for none

getDroppedAppForceStopped

public Float getDroppedAppForceStopped()

The percentage of accepted messages that were dropped because the application was force stopped on the device at the time of delivery and retries were unsuccessful.

Returns:

value or null for none

setDroppedAppForceStopped

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents setDroppedAppForceStopped(Float droppedAppForceStopped)

The percentage of accepted messages that were dropped because the application was force stopped on the device at the time of delivery and retries were unsuccessful.

Parameters:

droppedAppForceStopped - droppedAppForceStopped or null for none

getDroppedDeviceInactive

public Float getDroppedDeviceInactive()

The percentage of accepted messages that were dropped because the target device is inactive. FCM will drop messages if the target device is deemed inactive by our servers. If a device does reconnect, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud- messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages.

Returns:

value or null for none

setDroppedDeviceInactive

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents setDroppedDeviceInactive(Float droppedDeviceInactive)

The percentage of accepted messages that were dropped because the target device is inactive. FCM will drop messages if the target device is deemed inactive by our servers. If a device does reconnect, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud- messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages.

Parameters:

droppedDeviceInactive - droppedDeviceInactive or null for none

getDroppedTooManyPendingMessages

public Float getDroppedTooManyPendingMessages()

The percentage of accepted messages that were dropped due to [too many undelivered non- collapsible messages](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_and_non-collapsible_messages). Specifically, each app instance can only have 100 pending messages stored on our servers for a device which is disconnected. When that device reconnects, those messages are delivered. When there are more than the maximum pending messages, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud- messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages.

Returns:

value or null for none

setDroppedTooManyPendingMessages

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents setDroppedTooManyPendingMessages(Float droppedTooManyPendingMessages)

The percentage of accepted messages that were dropped due to [too many undelivered non- collapsible messages](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_and_non-collapsible_messages). Specifically, each app instance can only have 100 pending messages stored on our servers for a device which is disconnected. When that device reconnects, those messages are delivered. When there are more than the maximum pending messages, we call [OnDeletedMessages()](https://firebase.google.com/docs/cloud- messaging/android/receive#override-ondeletedmessages) in our SDK instead of delivering the messages.

Parameters:

droppedTooManyPendingMessages - droppedTooManyPendingMessages or null for none

getDroppedTtlExpired

public Float getDroppedTtlExpired()

The percentage of accepted messages that expired because [Time To Live (TTL)](https://firebase.google.com/docs/cloud-messaging/concept-options#ttl) elapsed before the target device reconnected.

Returns:

value or null for none

setDroppedTtlExpired

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents setDroppedTtlExpired(Float droppedTtlExpired)

The percentage of accepted messages that expired because [Time To Live (TTL)](https://firebase.google.com/docs/cloud-messaging/concept-options#ttl) elapsed before the target device reconnected.

Parameters:

droppedTtlExpired - droppedTtlExpired or null for none

getPending

public Float getPending()

The percentage of messages accepted on this day that were not dropped and not delivered, due to the device being disconnected (as of the end of the America/Los_Angeles day when the message was sent to FCM). A portion of these messages will be delivered the next day when the device connects but others may be destined to devices that ultimately never reconnect.

Returns:

value or null for none

setPending

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents setPending(Float pending)

The percentage of messages accepted on this day that were not dropped and not delivered, due to the device being disconnected (as of the end of the America/Los_Angeles day when the message was sent to FCM). A portion of these messages will be delivered the next day when the device connects but others may be destined to devices that ultimately never reconnect.

Parameters:

pending - pending or null for none

set

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents set(String fieldName,
                                                              Object value)

Overrides:

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

clone

public GoogleFirebaseFcmDataV1beta1MessageOutcomePercents clone()

Overrides:

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