com.amazonaws.services.pinpoint.model

Class SegmentImportResource

java.lang.Object

com.amazonaws.services.pinpoint.model.SegmentImportResource

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SegmentImportResource
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SegmentImportResource()

Method Summary

Modifier and Type	Method and Description
SegmentImportResource	addChannelCountsEntry(String key, Integer value) Add a single ChannelCounts entry
SegmentImportResource	clearChannelCountsEntries() Removes all the entries added into ChannelCounts.
SegmentImportResource	clone()
boolean	equals(Object obj)
Map<String,Integer>	getChannelCounts() The number of channel types in the endpoint definitions that were imported to create the segment.
String	getExternalId() (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
String	getFormat() The format of the files that were imported to create the segment.
String	getRoleArn() 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	getS3Url() The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
Integer	getSize() The number of endpoint definitions that were imported successfully to create the segment.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setChannelCounts(Map<String,Integer> channelCounts) The number of channel types in the endpoint definitions that were imported to create the segment.
void	setExternalId(String externalId) (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
void	setFormat(Format format) The format of the files that were imported to create the segment.
void	setFormat(String format) The format of the files that were imported to create the segment.
void	setRoleArn(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.
void	setS3Url(String s3Url) The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
void	setSize(Integer size) The number of endpoint definitions that were imported successfully to create the segment.
String	toString() Returns a string representation of this object.
SegmentImportResource	withChannelCounts(Map<String,Integer> channelCounts) The number of channel types in the endpoint definitions that were imported to create the segment.
SegmentImportResource	withExternalId(String externalId) (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
SegmentImportResource	withFormat(Format format) The format of the files that were imported to create the segment.
SegmentImportResource	withFormat(String format) The format of the files that were imported to create the segment.
SegmentImportResource	withRoleArn(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.
SegmentImportResource	withS3Url(String s3Url) The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
SegmentImportResource	withSize(Integer size) The number of endpoint definitions that were imported successfully to create the segment.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SegmentImportResource

public SegmentImportResource()

Method Detail

getChannelCounts

public Map<String,Integer> getChannelCounts()

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

Returns:

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

setChannelCounts

public void setChannelCounts(Map<String,Integer> channelCounts)

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

Parameters:

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

withChannelCounts

public SegmentImportResource withChannelCounts(Map<String,Integer> channelCounts)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addChannelCountsEntry

public SegmentImportResource addChannelCountsEntry(String key,
                                                   Integer value)

Add a single ChannelCounts entry

See Also:

withChannelCounts(java.util.Map<java.lang.String, java.lang.Integer>)

clearChannelCountsEntries

public SegmentImportResource clearChannelCountsEntries()

Removes all the entries added into ChannelCounts.

Returns:

Returns a reference to this object so that method calls can be chained together.

setExternalId

public void setExternalId(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.

Parameters:

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.

getExternalId

public String getExternalId()

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

withExternalId

public SegmentImportResource withExternalId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setFormat

public void setFormat(String 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.

Parameters:

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.

See Also:

Format

getFormat

public String getFormat()

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.

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

withFormat

public SegmentImportResource withFormat(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Format

setFormat

public void setFormat(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.

Parameters:

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.

See Also:

Format

withFormat

public SegmentImportResource withFormat(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Format

setRoleArn

public void setRoleArn(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.

Parameters:

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.

getRoleArn

public String getRoleArn()

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.

withRoleArn

public SegmentImportResource withRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setS3Url

public void setS3Url(String s3Url)

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

Parameters:

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

getS3Url

public String getS3Url()

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.

withS3Url

public SegmentImportResource withS3Url(String s3Url)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSize

public void setSize(Integer size)

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

Parameters:

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

getSize

public Integer getSize()

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.

withSize

public SegmentImportResource withSize(Integer size)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SegmentImportResource clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo