Package 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("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	Description
static interface	WriteSegmentRequest.Builder

Method Summary

Modifier and Type	Method	Description
static WriteSegmentRequest.Builder	builder()
SegmentDimensions	dimensions()	The criteria that define the dimensions for the segment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
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()
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 final SegmentDimensions dimensions()

The criteria that define the dimensions for the segment.

Returns:

The criteria that define the dimensions for the segment.

name

public final String name()

The name of the segment.

Returns:

The name of the segment.

segmentGroups

public final 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.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

(Deprecated) 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.

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

Returns:

As of 22-05-2023 tags has been deprecated for update operations. After this date any value in tags is not processed and an error code is not returned. To manage tags we recommend using either Tags in the API Reference for Amazon Pinpoint, resourcegroupstaggingapi commands in the AWS Command Line Interface Documentation or resourcegroupstaggingapi in the AWS SDK.

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 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