Class CostCategorySplitChargeRule

    • Method Detail

      • source

        public final String source()

        The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.

        Returns:
        The Cost Category value that you want to split. That value can't be used as a source or a target in other split charge rules. To indicate uncategorized costs, you can use an empty string as the source.
      • hasTargets

        public final boolean hasTargets()
        For responses, this returns true if the service returned a value for the Targets 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.
      • targets

        public final List<String> targets()

        The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.

        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 hasTargets() method.

        Returns:
        The Cost Category values that you want to split costs across. These values can't be used as a source in other split charge rules.
      • method

        public final CostCategorySplitChargeMethod method()

        The method that's used to define how to split your source costs across your targets.

        Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

        Fixed - Allocates charges across your targets based on your defined allocation percentage.

        >Even - Allocates costs evenly across all targets.

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

        Returns:
        The method that's used to define how to split your source costs across your targets.

        Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

        Fixed - Allocates charges across your targets based on your defined allocation percentage.

        >Even - Allocates costs evenly across all targets.

        See Also:
        CostCategorySplitChargeMethod
      • methodAsString

        public final String methodAsString()

        The method that's used to define how to split your source costs across your targets.

        Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

        Fixed - Allocates charges across your targets based on your defined allocation percentage.

        >Even - Allocates costs evenly across all targets.

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

        Returns:
        The method that's used to define how to split your source costs across your targets.

        Proportional - Allocates charges across your targets based on the proportional weighted cost of each target.

        Fixed - Allocates charges across your targets based on your defined allocation percentage.

        >Even - Allocates costs evenly across all targets.

        See Also:
        CostCategorySplitChargeMethod
      • hasParameters

        public final boolean hasParameters()
        For responses, this returns true if the service returned a value for the Parameters 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.
      • parameters

        public final List<CostCategorySplitChargeRuleParameter> parameters()

        The parameters for a split charge method. This is only required for the FIXED method.

        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 hasParameters() method.

        Returns:
        The parameters for a split charge method. This is only required for the FIXED method.
      • 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)