Class Field

    • Method Detail

      • aggregation

        public final FieldAggregationType aggregation()

        (Optional) Indicates the type of aggregation or summary operation (such as Sum, Average, and so on) to be performed on a particular field or set of data.

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

        Returns:
        (Optional) Indicates the type of aggregation or summary operation (such as Sum, Average, and so on) to be performed on a particular field or set of data.
        See Also:
        FieldAggregationType
      • aggregationAsString

        public final String aggregationAsString()

        (Optional) Indicates the type of aggregation or summary operation (such as Sum, Average, and so on) to be performed on a particular field or set of data.

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

        Returns:
        (Optional) Indicates the type of aggregation or summary operation (such as Sum, Average, and so on) to be performed on a particular field or set of data.
        See Also:
        FieldAggregationType
      • name

        public final String name()

        Name of the field.

        Returns:
        Name of the field.
      • serializableBuilderClass

        public static Class<? extends Field.Builder> serializableBuilderClass()
      • 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)