Class Offering

    • Method Detail

      • id

        public final String id()

        The ID that corresponds to a device offering.

        Returns:
        The ID that corresponds to a device offering.
      • description

        public final String description()

        A string that describes the offering.

        Returns:
        A string that describes the offering.
      • type

        public final OfferingType type()

        The type of offering (for example, RECURRING) for a device.

        If the service returns an enum value that is not available in the current SDK version, type will return OfferingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The type of offering (for example, RECURRING) for a device.
        See Also:
        OfferingType
      • typeAsString

        public final String typeAsString()

        The type of offering (for example, RECURRING) for a device.

        If the service returns an enum value that is not available in the current SDK version, type will return OfferingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

        Returns:
        The type of offering (for example, RECURRING) for a device.
        See Also:
        OfferingType
      • platform

        public final DevicePlatform platform()

        The platform of the device (for example, ANDROID or IOS).

        If the service returns an enum value that is not available in the current SDK version, platform will return DevicePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

        Returns:
        The platform of the device (for example, ANDROID or IOS).
        See Also:
        DevicePlatform
      • platformAsString

        public final String platformAsString()

        The platform of the device (for example, ANDROID or IOS).

        If the service returns an enum value that is not available in the current SDK version, platform will return DevicePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

        Returns:
        The platform of the device (for example, ANDROID or IOS).
        See Also:
        DevicePlatform
      • hasRecurringCharges

        public final boolean hasRecurringCharges()
        For responses, this returns true if the service returned a value for the RecurringCharges property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • recurringCharges

        public final List<RecurringCharge> recurringCharges()

        Specifies whether there are recurring charges for the offering.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRecurringCharges() method.

        Returns:
        Specifies whether there are recurring charges for the offering.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)