ExportJobRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.ExportJobRequest

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Export job request.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ExportJobRequest()

Constructors
Constructor and Description
`ExportJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExportJobRequest`	`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)` Marshalls this structured data using the given `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.
`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.
`ExportJobRequest`	`withSegmentVersion(Integer segmentVersion)` The version of the segment to export if specified.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ExportJobRequest
```
public ExportJobRequest()
```
- 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 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.
    
    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 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.
    
    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 ExportJobRequest 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 ExportJobRequest 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 ExportJobRequest 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.

Did this page help you?

Class ExportJobRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExportJobRequest

Method Detail

setRoleArn

getRoleArn

withRoleArn

setS3UrlPrefix

getS3UrlPrefix

withS3UrlPrefix

setSegmentId

getSegmentId

withSegmentId

setSegmentVersion

getSegmentVersion

withSegmentVersion

toString

equals

hashCode

clone

marshall