software.amazon.awssdk.services.pinpoint.model

Class ExportJobRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.ExportJobRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ExportJobRequest.Builder,ExportJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExportJobRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExportJobRequest.Builder,ExportJobRequest>

Export job request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExportJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ExportJobRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
String	s3UrlPrefix() A URL that points to the location within an Amazon S3 bucket that will receive the export.
List<SdkField<?>>	sdkFields()
String	segmentId() The ID of the segment to export endpoints from.
Integer	segmentVersion() The version of the segment to export if specified.
static Class<? extends ExportJobRequest.Builder>	serializableBuilderClass()
ExportJobRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

roleArn

public 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:

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.

s3UrlPrefix

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

segmentId

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

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.

segmentVersion

public Integer segmentVersion()

The version of the segment to export if specified.

Returns:

The version of the segment to export if specified.

toBuilder

public ExportJobRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ExportJobRequest.Builder,ExportJobRequest>

Returns:

a builder for type T

builder

public static ExportJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ExportJobRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.