software.amazon.awssdk.services.pinpoint.model

Class SegmentImportResource

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.SegmentImportResource

All Implemented Interfaces:

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

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

Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SegmentImportResource.Builder

Method Summary

Modifier and Type	Method and Description
static SegmentImportResource.Builder	builder()
Map<String,Integer>	channelCounts() The number of channel types in the endpoint definitions that were imported to create the segment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId() (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
Format	format() The format of the files that were imported to create the segment.
String	formatAsString() The format of the files that were imported to create the segment.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChannelCounts() For responses, this returns true if the service returned a value for the ChannelCounts property.
int	hashCode()
String	roleArn() The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
String	s3Url() The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
List<SdkField<?>>	sdkFields()
static Class<? extends SegmentImportResource.Builder>	serializableBuilderClass()
Integer	size() The number of endpoint definitions that were imported successfully to create the segment.
SegmentImportResource.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

hasChannelCounts

public final boolean hasChannelCounts()

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

channelCounts

public final Map<String,Integer> channelCounts()

The number of channel types in the endpoint definitions that were imported to create the segment.

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

Returns:

The number of channel types in the endpoint definitions that were imported to create the segment.

externalId

public final String externalId()

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

Returns:

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

format

public final Format format()

The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

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

Returns:

The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

See Also:

Format

formatAsString

public final String formatAsString()

The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

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

Returns:

The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

See Also:

Format

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

Returns:

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

s3Url

public final String s3Url()

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

Returns:

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

size

public final Integer size()

The number of endpoint definitions that were imported successfully to create the segment.

Returns:

The number of endpoint definitions that were imported successfully to create the segment.

toBuilder

public SegmentImportResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SegmentImportResource.Builder,SegmentImportResource>

builder

public static SegmentImportResource.Builder builder()

serializableBuilderClass

public static Class<? extends SegmentImportResource.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