Class SegmentResponse
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SegmentResponse.Builder,
SegmentResponse>
Provides information about the configuration, dimension, and other settings for a segment.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique identifier for the application that the segment is associated with.final String
arn()
The Amazon Resource Name (ARN) of the segment.static SegmentResponse.Builder
builder()
final String
The date and time when the segment was created.final SegmentDimensions
The dimension settings for the segment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
id()
The unique identifier for the segment.final SegmentImportResource
The settings for the import job that's associated with the segment.final String
The date and time when the segment was last modified.final String
name()
The name of the segment.final SegmentGroupList
A list of one or more segment groups that apply to the segment.final SegmentType
The segment type.final String
The segment type.static Class
<? extends SegmentResponse.Builder> tags()
A string-to-string map of key-value pairs that identifies the tags that are associated with the segment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
version()
The version number of the segment.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Amazon Resource Name (ARN) of the segment.
- Returns:
- The Amazon Resource Name (ARN) of the segment.
-
creationDate
The date and time when the segment was created.
- Returns:
- The date and time when the segment was created.
-
dimensions
The dimension settings for the segment.
- Returns:
- The dimension settings for the segment.
-
id
The unique identifier for the segment.
- Returns:
- The unique identifier for the segment.
-
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
The date and time when the segment was last modified.
- Returns:
- The date and time when the segment was last modified.
-
name
The name of the segment.
- Returns:
- The name of the segment.
-
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
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 returnSegmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsegmentTypeAsString()
.- 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:
-
-
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 returnSegmentType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsegmentTypeAsString()
.- 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:
-
-
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 theisEmpty()
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
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.
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:
- 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
The version number of the segment.
- Returns:
- The version number of the segment.
-
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 interfaceToCopyableBuilder<SegmentResponse.Builder,
SegmentResponse> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-