com.amazonaws.services.pinpoint.model

Class ExportJobResource

java.lang.Object

com.amazonaws.services.pinpoint.model.ExportJobResource

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Export job resource.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExportJobResource()

Method Summary

Modifier and Type	Method and Description
ExportJobResource	clone()
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.
Integer	getSegmentVersion() The version of the segment to export if specified.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
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.
void	setSegmentVersion(Integer segmentVersion) The version of the segment to export if specified.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ExportJobResource	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.
ExportJobResource	withS3UrlPrefix(String s3UrlPrefix) A URL that points to the location within an Amazon S3 bucket that will receive the export.
ExportJobResource	withSegmentId(String segmentId) The ID of the segment to export endpoints from.
ExportJobResource	withSegmentVersion(Integer segmentVersion) The version of the segment to export if specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExportJobResource

public ExportJobResource()

Method Detail

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.

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.

withRoleArn

public ExportJobResource 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.

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:

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

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.

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.

withS3UrlPrefix

public ExportJobResource 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.

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:

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

setSegmentId

public void setSegmentId(String segmentId)

The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

Parameters:

segmentId - The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

getSegmentId

public String getSegmentId()

The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

Returns:

The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

withSegmentId

public ExportJobResource withSegmentId(String segmentId)

The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

Parameters:

segmentId - The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

Returns:

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

setSegmentVersion

public void setSegmentVersion(Integer segmentVersion)

The version of the segment to export if specified.

Parameters:

segmentVersion - The version of the segment to export if specified.

getSegmentVersion

public Integer getSegmentVersion()

The version of the segment to export if specified.

Returns:

The version of the segment to export if specified.

withSegmentVersion

public ExportJobResource withSegmentVersion(Integer segmentVersion)

The version of the segment to export if specified.

Parameters:

segmentVersion - The version of the segment to export if specified.

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; useful for testing and debugging.

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 ExportJobResource clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo