com.amazonaws.services.pinpoint.model

Class ExportJobRequest

java.lang.Object

com.amazonaws.services.pinpoint.model.ExportJobRequest

All Implemented Interfaces:

Serializable

public class ExportJobRequest
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExportJobRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getRoleArn() The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
String	getS3UrlPrefix() A URL that points to the location within an Amazon S3 bucket that will receive the export.
String	getSegmentId() The ID of the segment to export endpoints from.
int	hashCode()
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
void	setS3UrlPrefix(String s3UrlPrefix) A URL that points to the location within an Amazon S3 bucket that will receive the export.
void	setSegmentId(String segmentId) The ID of the segment to export endpoints from.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ExportJobRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
ExportJobRequest	withS3UrlPrefix(String s3UrlPrefix) A URL that points to the location within an Amazon S3 bucket that will receive the export.
ExportJobRequest	withSegmentId(String segmentId) The ID of the segment to export endpoints from.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportJobRequest

public ExportJobRequest()

Method Detail

getRoleArn

public String getRoleArn()

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

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

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

Parameters:

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

withRoleArn

public ExportJobRequest withRoleArn(String roleArn)

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

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 endpoints will be exported to.

Returns:

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

getS3UrlPrefix

public String getS3UrlPrefix()

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

Returns:

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

setS3UrlPrefix

public void setS3UrlPrefix(String s3UrlPrefix)

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

Parameters:

s3UrlPrefix - A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

withS3UrlPrefix

public ExportJobRequest withS3UrlPrefix(String s3UrlPrefix)

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

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

Parameters:

s3UrlPrefix - A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

Returns:

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

getSegmentId

public String getSegmentId()

The ID of the segment to export endpoints from. If not present all endpoints will be exported.

Returns:

The ID of the segment to export endpoints from. If not present all endpoints will be exported.

setSegmentId

public void setSegmentId(String segmentId)

The ID of the segment to export endpoints from. If not present all endpoints will be exported.

Parameters:

segmentId - The ID of the segment to export endpoints from. If not present all endpoints will be exported.

withSegmentId

public ExportJobRequest withSegmentId(String segmentId)

The ID of the segment to export endpoints from. If not present all endpoints will be exported.

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

Parameters:

segmentId - The ID of the segment to export endpoints from. If not present all endpoints will be exported.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object