software.amazon.awssdk.services.pinpoint.model

Class WriteSegmentRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.WriteSegmentRequest

All Implemented Interfaces:

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

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

Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WriteSegmentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static WriteSegmentRequest.Builder	builder()
SegmentDimensions	dimensions() The criteria that define the dimensions for the segment.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the segment.
List<SdkField<?>>	sdkFields()
SegmentGroupList	segmentGroups() The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
static Class<? extends WriteSegmentRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() A string-to-string map of key-value pairs that defines the tags to associate with the segment.
WriteSegmentRequest.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

dimensions

public SegmentDimensions dimensions()

The criteria that define the dimensions for the segment.

Returns:

The criteria that define the dimensions for the segment.

name

public String name()

The name of the segment.

Returns:

The name of the segment.

segmentGroups

public SegmentGroupList segmentGroups()

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

Returns:

The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

tags

public Map<String,String> tags()

A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

toBuilder

public WriteSegmentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WriteSegmentRequest.Builder,WriteSegmentRequest>

builder

public static WriteSegmentRequest.Builder builder()

serializableBuilderClass

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

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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo