Package 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("software.amazon.awssdk:codegen")
public final class ExportJobRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ExportJobRequest.Builder,ExportJobRequest>

Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExportJobRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ExportJobRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn()	The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
String	s3UrlPrefix()	The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to.
List<SdkField<?>>	sdkFields()
String	segmentId()	The identifier for the segment to export endpoint definitions from.
Integer	segmentVersion()	The version of the segment to export endpoint definitions from, if specified.
static Class<? extends ExportJobRequest.Builder>	serializableBuilderClass()
ExportJobRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

Returns:

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

s3UrlPrefix

public final String s3UrlPrefix()

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions 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 you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

segmentId

public final String segmentId()

The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

Returns:

The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

segmentVersion

public final Integer segmentVersion()

The version of the segment to export endpoint definitions from, if specified.

Returns:

The version of the segment to export endpoint definitions from, if specified.

toBuilder

public ExportJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExportJobRequest.Builder,ExportJobRequest>

builder

public static ExportJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo