Class FilterOperationSelectedFieldsConfiguration

    • Method Detail

      • hasSelectedFields

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

        public final List<String> selectedFields()

        Chooses the fields that are filtered in CustomActionFilterOperation.

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

        Returns:
        Chooses the fields that are filtered in CustomActionFilterOperation.
      • selectedFieldOptions

        public final SelectedFieldOptions selectedFieldOptions()

        A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

        Valid values are defined as follows:

        • ALL_FIELDS: Applies the filter operation to all fields.

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

        Returns:
        A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

        Valid values are defined as follows:

        • ALL_FIELDS: Applies the filter operation to all fields.

        See Also:
        SelectedFieldOptions
      • selectedFieldOptionsAsString

        public final String selectedFieldOptionsAsString()

        A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

        Valid values are defined as follows:

        • ALL_FIELDS: Applies the filter operation to all fields.

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

        Returns:
        A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

        Valid values are defined as follows:

        • ALL_FIELDS: Applies the filter operation to all fields.

        See Also:
        SelectedFieldOptions
      • hasSelectedColumns

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

        public final List<ColumnIdentifier> selectedColumns()

        The selected columns of a dataset.

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

        Returns:
        The selected columns of a dataset.
      • 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)