com.amazonaws.services.pinpoint.model

Class ImportJobRequest

java.lang.Object

com.amazonaws.services.pinpoint.model.ImportJobRequest

All Implemented Interfaces:

java.io.Serializable

public class ImportJobRequest
extends java.lang.Object
implements java.io.Serializable

Import job request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ImportJobRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getDefineSegment() Sets whether the endpoints create a segment when they are imported.
java.lang.String	getExternalId() (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy.
java.lang.String	getFormat() The format of the files that contain the endpoint definitions.
java.lang.Boolean	getRegisterEndpoints() Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
java.lang.String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
java.lang.String	getS3Url() The URL of the S3 bucket that contains the segment information to import.
java.lang.String	getSegmentId() The ID of the segment to update if the import job is meant to update an existing segment.
java.lang.String	getSegmentName() A custom name for the segment created by the import job.
int	hashCode()
java.lang.Boolean	isDefineSegment() Sets whether the endpoints create a segment when they are imported.
java.lang.Boolean	isRegisterEndpoints() Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
void	setDefineSegment(java.lang.Boolean defineSegment) Sets whether the endpoints create a segment when they are imported.
void	setExternalId(java.lang.String externalId) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy.
void	setFormat(Format format) The format of the files that contain the endpoint definitions.
void	setFormat(java.lang.String format) The format of the files that contain the endpoint definitions.
void	setRegisterEndpoints(java.lang.Boolean registerEndpoints) Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
void	setRoleArn(java.lang.String roleArn) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
void	setS3Url(java.lang.String s3Url) The URL of the S3 bucket that contains the segment information to import.
void	setSegmentId(java.lang.String segmentId) The ID of the segment to update if the import job is meant to update an existing segment.
void	setSegmentName(java.lang.String segmentName) A custom name for the segment created by the import job.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ImportJobRequest	withDefineSegment(java.lang.Boolean defineSegment) Sets whether the endpoints create a segment when they are imported.
ImportJobRequest	withExternalId(java.lang.String externalId) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy.
ImportJobRequest	withFormat(Format format) The format of the files that contain the endpoint definitions.
ImportJobRequest	withFormat(java.lang.String format) The format of the files that contain the endpoint definitions.
ImportJobRequest	withRegisterEndpoints(java.lang.Boolean registerEndpoints) Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
ImportJobRequest	withRoleArn(java.lang.String roleArn) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
ImportJobRequest	withS3Url(java.lang.String s3Url) The URL of the S3 bucket that contains the segment information to import.
ImportJobRequest	withSegmentId(java.lang.String segmentId) The ID of the segment to update if the import job is meant to update an existing segment.
ImportJobRequest	withSegmentName(java.lang.String segmentName) A custom name for the segment created by the import job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImportJobRequest

public ImportJobRequest()

Method Detail

isDefineSegment

public java.lang.Boolean isDefineSegment()

Sets whether the endpoints create a segment when they are imported.

Returns:

Sets whether the endpoints create a segment when they are imported.

getDefineSegment

public java.lang.Boolean getDefineSegment()

Sets whether the endpoints create a segment when they are imported.

Returns:

Sets whether the endpoints create a segment when they are imported.

setDefineSegment

public void setDefineSegment(java.lang.Boolean defineSegment)

Sets whether the endpoints create a segment when they are imported.

Parameters:

defineSegment - Sets whether the endpoints create a segment when they are imported.

withDefineSegment

public ImportJobRequest withDefineSegment(java.lang.Boolean defineSegment)

Sets whether the endpoints create a segment when they are imported.

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

Parameters:

defineSegment - Sets whether the endpoints create a segment when they are imported.

Returns:

A reference to this updated object so that method calls can be chained together.

getExternalId

public java.lang.String getExternalId()

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

Returns:

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

setExternalId

public void setExternalId(java.lang.String externalId)

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

Parameters:

externalId - (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

withExternalId

public ImportJobRequest withExternalId(java.lang.String externalId)

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

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

Parameters:

externalId - (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

Returns:

A reference to this updated object so that method calls can be chained together.

getFormat

public java.lang.String getFormat()

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

Constraints:
Allowed Values: CSV, JSON

Returns:

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

See Also:

Format

setFormat

public void setFormat(java.lang.String format)

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

Constraints:
Allowed Values: CSV, JSON

Parameters:

format - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

See Also:

Format

withFormat

public ImportJobRequest withFormat(java.lang.String format)

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

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

Constraints:
Allowed Values: CSV, JSON

Parameters:

format - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Format

setFormat

public void setFormat(Format format)

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

Constraints:
Allowed Values: CSV, JSON

Parameters:

format - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

See Also:

Format

withFormat

public ImportJobRequest withFormat(Format format)

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

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

Constraints:
Allowed Values: CSV, JSON

Parameters:

format - The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Format

isRegisterEndpoints

public java.lang.Boolean isRegisterEndpoints()

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

Returns:

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

getRegisterEndpoints

public java.lang.Boolean getRegisterEndpoints()

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

Returns:

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

setRegisterEndpoints

public void setRegisterEndpoints(java.lang.Boolean registerEndpoints)

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

Parameters:

registerEndpoints - Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

withRegisterEndpoints

public ImportJobRequest withRegisterEndpoints(java.lang.Boolean registerEndpoints)

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

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

Parameters:

registerEndpoints - Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public java.lang.String getRoleArn()

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

Returns:

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

setRoleArn

public void setRoleArn(java.lang.String roleArn)

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

withRoleArn

public ImportJobRequest withRoleArn(java.lang.String roleArn)

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

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

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

Returns:

A reference to this updated object so that method calls can be chained together.

getS3Url

public java.lang.String getS3Url()

The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

Returns:

The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

setS3Url

public void setS3Url(java.lang.String s3Url)

The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

Parameters:

s3Url - The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

withS3Url

public ImportJobRequest withS3Url(java.lang.String s3Url)

The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

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

Parameters:

s3Url - The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

Returns:

A reference to this updated object so that method calls can be chained together.

getSegmentId

public java.lang.String getSegmentId()

The ID of the segment to update if the import job is meant to update an existing segment.

Returns:

The ID of the segment to update if the import job is meant to update an existing segment.

setSegmentId

public void setSegmentId(java.lang.String segmentId)

The ID of the segment to update if the import job is meant to update an existing segment.

Parameters:

segmentId - The ID of the segment to update if the import job is meant to update an existing segment.

withSegmentId

public ImportJobRequest withSegmentId(java.lang.String segmentId)

The ID of the segment to update if the import job is meant to update an existing segment.

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

Parameters:

segmentId - The ID of the segment to update if the import job is meant to update an existing segment.

Returns:

A reference to this updated object so that method calls can be chained together.

getSegmentName

public java.lang.String getSegmentName()

A custom name for the segment created by the import job. Use if DefineSegment is true.

Returns:

A custom name for the segment created by the import job. Use if DefineSegment is true.

setSegmentName

public void setSegmentName(java.lang.String segmentName)

A custom name for the segment created by the import job. Use if DefineSegment is true.

Parameters:

segmentName - A custom name for the segment created by the import job. Use if DefineSegment is true.

withSegmentName

public ImportJobRequest withSegmentName(java.lang.String segmentName)

A custom name for the segment created by the import job. Use if DefineSegment is true.

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

Parameters:

segmentName - A custom name for the segment created by the import job. Use if DefineSegment is true.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object