Class Group

    • Method Detail

      • hasDimensions

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

        public final List<Dimension> dimensions()

        Defines the attributes to segment on.

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

        Returns:
        Defines the attributes to segment on.
      • hasSourceSegments

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

        public final List<SourceSegment> sourceSegments()

        Defines the starting source of data.

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

        Returns:
        Defines the starting source of data.
      • sourceTypeAsString

        public final String sourceTypeAsString()

        Defines how to interact with the source data.

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

        Returns:
        Defines how to interact with the source data.
        See Also:
        IncludeOptions
      • type

        public final IncludeOptions type()

        Defines how to interact with the profiles found in the current filtering.

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

        Returns:
        Defines how to interact with the profiles found in the current filtering.
        See Also:
        IncludeOptions
      • typeAsString

        public final String typeAsString()

        Defines how to interact with the profiles found in the current filtering.

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

        Returns:
        Defines how to interact with the profiles found in the current filtering.
        See Also:
        IncludeOptions
      • serializableBuilderClass

        public static Class<? extends Group.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)