software.amazon.awssdk.services.pinpoint.model

Class SegmentResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SegmentResponse

All Implemented Interfaces:

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

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

Segment definition.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SegmentResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationId() The ID of the application that the segment applies to.
static SegmentResponse.Builder	builder()
String	creationDate() The date and time when the segment was created.
SegmentDimensions	dimensions() The segment dimensions attributes.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The unique segment ID.
SegmentImportResource	importDefinition() The import job settings.
String	lastModifiedDate() The date and time when the segment was last modified.
String	name() The name of the segment.
List<SdkField<?>>	sdkFields()
SegmentGroupList	segmentGroups() A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.
SegmentType	segmentType() The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app.
String	segmentTypeAsString() The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app.
static Class<? extends SegmentResponse.Builder>	serializableBuilderClass()
SegmentResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	version() The segment version number.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

applicationId

public String applicationId()

The ID of the application that the segment applies to.

Returns:

The ID of the application that the segment applies to.

creationDate

public String creationDate()

The date and time when the segment was created.

Returns:

The date and time when the segment was created.

dimensions

public SegmentDimensions dimensions()

The segment dimensions attributes.

Returns:

The segment dimensions attributes.

id

public String id()

The unique segment ID.

Returns:

The unique segment ID.

importDefinition

public SegmentImportResource importDefinition()

The import job settings.

Returns:

The import job settings.

lastModifiedDate

public String lastModifiedDate()

The date and time when the segment was last modified.

Returns:

The date and time when the segment was last modified.

name

public String name()

The name of the segment.

Returns:

The name of the segment.

segmentGroups

public SegmentGroupList segmentGroups()

A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.

Returns:

A segment group, which consists of zero or more source segments, plus dimensions that are applied to those source segments.

segmentType

public SegmentType segmentType()

The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.

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

Returns:

The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.

See Also:

SegmentType

segmentTypeAsString

public String segmentTypeAsString()

The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.

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

Returns:

The segment type: DIMENSIONAL - A dynamic segment built from selection criteria based on endpoint data reported by your app. You create this type of segment by using the segment builder in the Amazon Pinpoint console or by making a POST request to the segments resource. IMPORT - A static segment built from an imported set of endpoint definitions. You create this type of segment by importing a segment in the Amazon Pinpoint console or by making a POST request to the jobs/import resource.

See Also:

SegmentType

version

public Integer version()

The segment version number.

Returns:

The segment version number.

toBuilder

public SegmentResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SegmentResponse.Builder,SegmentResponse>

Returns:

a builder for type T

builder

public static SegmentResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.