Package software.amazon.awssdk.services.customerprofiles.model

Class SegmentGroup

java.lang.Object

software.amazon.awssdk.services.customerprofiles.model.SegmentGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SegmentGroup.Builder,SegmentGroup>

@Generated("software.amazon.awssdk:codegen")
public final class SegmentGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SegmentGroup.Builder,SegmentGroup>

Contains all groups of the segment definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SegmentGroup.Builder

Method Summary

Modifier and Type	Method	Description
static SegmentGroup.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
List<Group>	groups()	Holds the list of groups within the segment definition.
boolean	hasGroups()	For responses, this returns true if the service returned a value for the Groups property.
int	hashCode()
IncludeOptions	include()	Defines whether to include or exclude the profiles that fit the segment criteria.
String	includeAsString()	Defines whether to include or exclude the profiles that fit the segment criteria.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SegmentGroup.Builder>	serializableBuilderClass()
SegmentGroup.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasGroups

public final boolean hasGroups()

For responses, this returns true if the service returned a value for the Groups 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.

groups

public final List<Group> groups()

Holds the list of groups within the segment definition.

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

Returns:

Holds the list of groups within the segment definition.

include

public final IncludeOptions include()

Defines whether to include or exclude the profiles that fit the segment criteria.

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

Returns:

Defines whether to include or exclude the profiles that fit the segment criteria.

See Also:

IncludeOptions

includeAsString

public final String includeAsString()

Defines whether to include or exclude the profiles that fit the segment criteria.

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

Returns:

Defines whether to include or exclude the profiles that fit the segment criteria.

See Also:

IncludeOptions

toBuilder

public SegmentGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SegmentGroup.Builder,SegmentGroup>

builder

public static SegmentGroup.Builder builder()

serializableBuilderClass

public static Class<? extends SegmentGroup.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo