SegmentResponse (AWS Java SDK :: Services :: Amazon Pinpoint 2.16.29 API)

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>
```
Provides information about the configuration, dimension, and other settings for a segment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface SegmentResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`SegmentResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`applicationId()` The unique identifier for the application that the segment is associated with.
`String`	`arn()` The Amazon Resource Name (ARN) of the segment.
`static SegmentResponse.Builder`	`builder()`
`String`	`creationDate()` The date and time when the segment was created.
`SegmentDimensions`	`dimensions()` The dimension settings for the segment.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`id()` The unique identifier for the segment.
`SegmentImportResource`	`importDefinition()` The settings for the import job that's associated with the segment.
`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 list of one or more segment groups that apply to the segment.
`SegmentType`	`segmentType()` The segment type.
`String`	`segmentTypeAsString()` The segment type.
`static Class<? extends SegmentResponse.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` A string-to-string map of key-value pairs that identifies the tags that are associated with the segment.
`SegmentResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Integer`	`version()` The version number of the segment.

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
  - applicationId
```
public final String applicationId()
```
    The unique identifier for the application that the segment is associated with.
    
    Returns:
    
    The unique identifier for the application that the segment is associated with.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the segment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the segment.
  - creationDate
```
public final String creationDate()
```
    The date and time when the segment was created.
    
    Returns:
    
    The date and time when the segment was created.
  - dimensions
```
public final SegmentDimensions dimensions()
```
    The dimension settings for the segment.
    
    Returns:
    
    The dimension settings for the segment.
  - id
```
public final String id()
```
    The unique identifier for the segment.
    
    Returns:
    
    The unique identifier for the segment.
  - importDefinition
```
public final SegmentImportResource importDefinition()
```
    The settings for the import job that's associated with the segment.
    
    Returns:
    
    The settings for the import job that's associated with the segment.
  - lastModifiedDate
```
public final 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 final String name()
```
    The name of the segment.
    
    Returns:
    
    The name of the segment.
  - segmentGroups
```
public final SegmentGroupList segmentGroups()
```
    A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
    
    Returns:
    
    A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
  - segmentType
```
public final SegmentType segmentType()
```
    The segment type. Valid values are:
    - DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
    - IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you they don't change over time.
    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. Valid values are:
    
    DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
    
    IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
    See Also:
    
    SegmentType
  - segmentTypeAsString
```
public final String segmentTypeAsString()
```
    The segment type. Valid values are:
    - DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
    - IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
    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. Valid values are:
    
    DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.
    
    IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
    See Also:
    
    SegmentType
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final Map<String,String> tags()
```
    A string-to-string map of key-value pairs that identifies the tags that are associated 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
  - version
```
public final Integer version()
```
    The version number of the segment.
    
    Returns:
    
    The version number of the segment.
  - toBuilder
```
public SegmentResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SegmentResponse.Builder,SegmentResponse>
  - builder
```
public static SegmentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SegmentResponse.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

Class SegmentResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

applicationId

arn

creationDate

dimensions

id

importDefinition

lastModifiedDate

name

segmentGroups

segmentType

segmentTypeAsString

hasTags

tags

version

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields