Class FilterGroup

    • Method Detail

      • filterGroupId

        public final String filterGroupId()

        The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

        Returns:
        The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.
      • hasFilters

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

        public final List<Filter> filters()

        The list of filters that are present in a FilterGroup.

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

        Returns:
        The list of filters that are present in a FilterGroup.
      • scopeConfiguration

        public final FilterScopeConfiguration scopeConfiguration()

        The configuration that specifies what scope to apply to a FilterGroup.

        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

        Returns:
        The configuration that specifies what scope to apply to a FilterGroup.

        This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

      • crossDataset

        public final CrossDatasetTypes crossDataset()

        The filter new feature which can apply filter group to all data sets. Choose one of the following options:

        • ALL_DATASETS

        • SINGLE_DATASET

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

        Returns:
        The filter new feature which can apply filter group to all data sets. Choose one of the following options:

        • ALL_DATASETS

        • SINGLE_DATASET

        See Also:
        CrossDatasetTypes
      • crossDatasetAsString

        public final String crossDatasetAsString()

        The filter new feature which can apply filter group to all data sets. Choose one of the following options:

        • ALL_DATASETS

        • SINGLE_DATASET

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

        Returns:
        The filter new feature which can apply filter group to all data sets. Choose one of the following options:

        • ALL_DATASETS

        • SINGLE_DATASET

        See Also:
        CrossDatasetTypes
      • 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)