software.amazon.awssdk.services.pinpoint.model

Class ImportJobRequest

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.ImportJobRequest

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ImportJobRequest.Builder,ImportJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class ImportJobRequest
extends Object
implements StructuredPojo, ToCopyableBuilder<ImportJobRequest.Builder,ImportJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ImportJobRequest.Builder	builder()
Boolean	defineSegment() Sets whether the endpoints create a segment when they are imported.
boolean	equals(Object obj)
String	externalId() A unique, custom ID assigned to the IAM role that restricts who can assume the role.
Format	format() The format of the files that contain the endpoint definitions.
String	formatAsString() The format of the files that contain the endpoint definitions.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
Boolean	registerEndpoints() Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.
String	s3Url() A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import.
String	segmentId() The ID of the segment to update if the import job is meant to update an existing segment.
String	segmentName() A custom name for the segment created by the import job.
static Class<? extends ImportJobRequest.Builder>	serializableBuilderClass()
ImportJobRequest.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

defineSegment

public Boolean defineSegment()

Sets whether the endpoints create a segment when they are imported.

Returns:

Sets whether the endpoints create a segment when they are imported.

externalId

public String externalId()

A unique, custom ID assigned to the IAM role that restricts who can assume the role.

Returns:

A unique, custom ID assigned to the IAM role that restricts who can assume the role.

format

public Format format()

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

See Also:

Format

formatAsString

public String formatAsString()

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The format of the files that contain the endpoint definitions. Valid values: CSV, JSON

See Also:

Format

registerEndpoints

public Boolean registerEndpoints()

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

Returns:

Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.

roleArn

public String roleArn()

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

Returns:

The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that contains the endpoints to import.

s3Url

public String s3Url()

A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.

Returns:

A URL that points to the location within an Amazon S3 bucket that contains the endpoints to import. The location can be a folder or a single file. The URL should follow this format: s3://bucket-name/folder-name/file-name Amazon Pinpoint will import endpoints from this location and any subfolders it contains.

segmentId

public String segmentId()

The ID of the segment to update if the import job is meant to update an existing segment.

Returns:

The ID of the segment to update if the import job is meant to update an existing segment.

segmentName

public String segmentName()

A custom name for the segment created by the import job. Use if DefineSegment is true.

Returns:

A custom name for the segment created by the import job. Use if DefineSegment is true.

toBuilder

public ImportJobRequest.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<ImportJobRequest.Builder,ImportJobRequest>

Returns:

a builder for type T

builder

public static ImportJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ImportJobRequest.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)

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.