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

Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

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 the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
String	getS3UrlPrefix() The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to.
String	getSegmentId() The identifier for the segment that the endpoint definitions were exported from.
Integer	getSegmentVersion() The version of the segment that the endpoint definitions were exported from.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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 where the endpoint definitions were exported to.
void	setS3UrlPrefix(String s3UrlPrefix) The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to.
void	setSegmentId(String segmentId) The identifier for the segment that the endpoint definitions were exported from.
void	setSegmentVersion(Integer segmentVersion) The version of the segment that the endpoint definitions were exported from.
String	toString() Returns a string representation of this object.
ExportJobResource	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 where the endpoint definitions were exported to.
ExportJobResource	withS3UrlPrefix(String s3UrlPrefix) The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to.
ExportJobResource	withSegmentId(String segmentId) The identifier for the segment that the endpoint definitions were exported from.
ExportJobResource	withSegmentVersion(Integer segmentVersion) The version of the segment that the endpoint definitions were exported from.

Methods inherited from class java.lang.Object

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 the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

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 where the endpoint definitions were exported to.

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 where the endpoint definitions were exported to.

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 where the endpoint definitions were exported to.

withRoleArn

public ExportJobResource 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 where the endpoint definitions were exported to.

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 where the endpoint definitions were exported to.

Returns:

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

setS3UrlPrefix

public void setS3UrlPrefix(String s3UrlPrefix)

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

Parameters:

s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

getS3UrlPrefix

public String getS3UrlPrefix()

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

Returns:

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

withS3UrlPrefix

public ExportJobResource withS3UrlPrefix(String s3UrlPrefix)

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

Parameters:

s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

Returns:

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

setSegmentId

public void setSegmentId(String segmentId)

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

Parameters:

segmentId - The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

getSegmentId

public String getSegmentId()

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

Returns:

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

withSegmentId

public ExportJobResource withSegmentId(String segmentId)

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

Parameters:

segmentId - The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with 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 that the endpoint definitions were exported from.

Parameters:

segmentVersion - The version of the segment that the endpoint definitions were exported from.

getSegmentVersion

public Integer getSegmentVersion()

The version of the segment that the endpoint definitions were exported from.

Returns:

The version of the segment that the endpoint definitions were exported from.

withSegmentVersion

public ExportJobResource withSegmentVersion(Integer segmentVersion)

The version of the segment that the endpoint definitions were exported from.

Parameters:

segmentVersion - The version of the segment that the endpoint definitions were exported from.

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

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.