software.amazon.awssdk.services.pinpoint.model

Class ExportJobResource

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.ExportJobResource

All Implemented Interfaces:

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

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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ExportJobResource.Builder

Method Summary

Modifier and Type	Method and Description
static ExportJobResource.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 authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
String	s3UrlPrefix() The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to.
List<SdkField<?>>	sdkFields()
String	segmentId() The identifier for the segment that the endpoint definitions were exported from.
Integer	segmentVersion() The version of the segment that the endpoint definitions were exported from.
static Class<? extends ExportJobResource.Builder>	serializableBuilderClass()
ExportJobResource.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 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.

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.

s3UrlPrefix

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

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

segmentId

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

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.

segmentVersion

public Integer segmentVersion()

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.

toBuilder

public ExportJobResource.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExportJobResource.Builder,ExportJobResource>

builder

public static ExportJobResource.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo