software.amazon.awssdk.services.pinpoint.model

Class ImportJobRequest

java.lang.Object

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

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

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() Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId() (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
Format	format() The format of the files that contain the endpoint definitions to import.
String	formatAsString() The format of the files that contain the endpoint definitions to import.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	registerEndpoints() Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
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 to import endpoint definitions from.
String	s3Url() The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import.
List<SdkField<?>>	sdkFields()
String	segmentId() The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
String	segmentName() A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
static Class<? extends ImportJobRequest.Builder>	serializableBuilderClass()
ImportJobRequest.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

defineSegment

public Boolean defineSegment()

Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

Returns:

Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

externalId

public String externalId()

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

Returns:

(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

format

public Format format()

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

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 to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

See Also:

Format

formatAsString

public String formatAsString()

The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

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 to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

See Also:

Format

registerEndpoints

public Boolean registerEndpoints()

Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

Returns:

Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

roleArn

public 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 to import endpoint definitions from.

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 to import endpoint definitions from.

s3Url

public String s3Url()

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

Returns:

The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

The URL should be in the following format: s3://bucket-name/folder -name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

segmentId

public String segmentId()

The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

Returns:

The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

segmentName

public String segmentName()

A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

Returns:

A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

toBuilder

public ImportJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportJobRequest.Builder,ImportJobRequest>

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

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