Class MixedMeasureMapping

    • Method Detail

      • measureName

        public final String measureName()

        Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.

        Returns:
        Refers to the value of measure_name in a result row. This field is required if MeasureNameColumn is provided.
      • sourceColumn

        public final String sourceColumn()

        This field refers to the source column from which measure-value is to be read for result materialization.

        Returns:
        This field refers to the source column from which measure-value is to be read for result materialization.
      • targetMeasureName

        public final String targetMeasureName()

        Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.

        Returns:
        Target measure name to be used. If not provided, the target measure name by default would be measure-name if provided, or sourceColumn otherwise.
      • measureValueType

        public final MeasureValueType measureValueType()

        Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.

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

        Returns:
        Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.
        See Also:
        MeasureValueType
      • measureValueTypeAsString

        public final String measureValueTypeAsString()

        Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.

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

        Returns:
        Type of the value that is to be read from sourceColumn. If the mapping is for MULTI, use MeasureValueType.MULTI.
        See Also:
        MeasureValueType
      • hasMultiMeasureAttributeMappings

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

        public final List<MultiMeasureAttributeMapping> multiMeasureAttributeMappings()

        Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.

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

        Returns:
        Required when measureValueType is MULTI. Attribute mappings for MULTI value measures.
      • 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)