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

Class GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents

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.GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Overview of delivery performance for messages that were successfully delivered. All percentages are calculated with countMessagesAccepted as the denominator. These categories are not mutually exclusive; a message can be delayed for multiple reasons.

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
GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents()

Method Summary

Modifier and Type	Method and Description
GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents	clone()
Float	getDelayedDeviceDoze() The percentage of accepted messages that were delayed because the device was in doze mode.
Float	getDelayedDeviceOffline() The percentage of accepted messages that were delayed because the target device was not connected at the time of sending.
Float	getDelayedMessageThrottled() The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_throttling) or [maximum message rate throttling](https://firebase.google.com/docs/cloud-messaging/concept- options#device_throttling).
Float	getDelayedUserStopped() The percentage of accepted messages that were delayed because the intended device user-profile was [stopped](https://firebase.google.com/docs/cloud- messaging/android/receive#handling_messages) on the target device at the time of the send.
Float	getDeliveredNoDelay() The percentage of accepted messages that were delivered to the device without delay from the FCM system.
GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents	set(String fieldName, Object value)
GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents	setDelayedDeviceDoze(Float delayedDeviceDoze) The percentage of accepted messages that were delayed because the device was in doze mode.
GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents	setDelayedDeviceOffline(Float delayedDeviceOffline) The percentage of accepted messages that were delayed because the target device was not connected at the time of sending.
GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents	setDelayedMessageThrottled(Float delayedMessageThrottled) The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_throttling) or [maximum message rate throttling](https://firebase.google.com/docs/cloud-messaging/concept- options#device_throttling).
GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents	setDelayedUserStopped(Float delayedUserStopped) The percentage of accepted messages that were delayed because the intended device user-profile was [stopped](https://firebase.google.com/docs/cloud- messaging/android/receive#handling_messages) on the target device at the time of the send.
GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents	setDeliveredNoDelay(Float deliveredNoDelay) The percentage of accepted messages that were delivered to the device without delay from the FCM system.

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

GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents

public GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents()

Method Detail

getDelayedDeviceDoze

public Float getDelayedDeviceDoze()

The percentage of accepted messages that were delayed because the device was in doze mode. Only [normal priority messages](https://firebase.google.com/docs/cloud-messaging/concept- options#setting-the-priority-of-a-message) should be delayed due to doze mode.

Returns:

value or null for none

setDelayedDeviceDoze

public GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents setDelayedDeviceDoze(Float delayedDeviceDoze)

The percentage of accepted messages that were delayed because the device was in doze mode. Only [normal priority messages](https://firebase.google.com/docs/cloud-messaging/concept- options#setting-the-priority-of-a-message) should be delayed due to doze mode.

Parameters:

delayedDeviceDoze - delayedDeviceDoze or null for none

getDelayedDeviceOffline

public Float getDelayedDeviceOffline()

The percentage of accepted messages that were delayed because the target device was not connected at the time of sending. These messages were eventually delivered when the device reconnected.

Returns:

value or null for none

setDelayedDeviceOffline

public GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents setDelayedDeviceOffline(Float delayedDeviceOffline)

The percentage of accepted messages that were delayed because the target device was not connected at the time of sending. These messages were eventually delivered when the device reconnected.

Parameters:

delayedDeviceOffline - delayedDeviceOffline or null for none

getDelayedMessageThrottled

public Float getDelayedMessageThrottled()

The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_throttling) or [maximum message rate throttling](https://firebase.google.com/docs/cloud-messaging/concept- options#device_throttling).

Returns:

value or null for none

setDelayedMessageThrottled

public GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents setDelayedMessageThrottled(Float delayedMessageThrottled)

The percentage of accepted messages that were delayed due to message throttling, such as [collapsible message throttling](https://firebase.google.com/docs/cloud-messaging/concept- options#collapsible_throttling) or [maximum message rate throttling](https://firebase.google.com/docs/cloud-messaging/concept- options#device_throttling).

Parameters:

delayedMessageThrottled - delayedMessageThrottled or null for none

getDelayedUserStopped

public Float getDelayedUserStopped()

The percentage of accepted messages that were delayed because the intended device user-profile was [stopped](https://firebase.google.com/docs/cloud- messaging/android/receive#handling_messages) on the target device at the time of the send. The messages were eventually delivered when the user-profile was started again.

Returns:

value or null for none

setDelayedUserStopped

public GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents setDelayedUserStopped(Float delayedUserStopped)

The percentage of accepted messages that were delayed because the intended device user-profile was [stopped](https://firebase.google.com/docs/cloud- messaging/android/receive#handling_messages) on the target device at the time of the send. The messages were eventually delivered when the user-profile was started again.

Parameters:

delayedUserStopped - delayedUserStopped or null for none

getDeliveredNoDelay

public Float getDeliveredNoDelay()

The percentage of accepted messages that were delivered to the device without delay from the FCM system.

Returns:

value or null for none

setDeliveredNoDelay

public GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents setDeliveredNoDelay(Float deliveredNoDelay)

The percentage of accepted messages that were delivered to the device without delay from the FCM system.

Parameters:

deliveredNoDelay - deliveredNoDelay or null for none

set

public GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents set(String fieldName,
                                                                   Object value)

Overrides:

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

clone

public GoogleFirebaseFcmDataV1beta1DeliveryPerformancePercents clone()

Overrides:

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