software.amazon.awssdk.services.pinpoint.model

Interface ImportJobRequest.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ImportJobRequest.Builder,ImportJobRequest>, SdkBuilder<ImportJobRequest.Builder,ImportJobRequest>, SdkPojo

Enclosing class:

ImportJobRequest

public static interface ImportJobRequest.Builder
extends SdkPojo, CopyableBuilder<ImportJobRequest.Builder,ImportJobRequest>

Method Summary

Modifier and Type	Method and Description
ImportJobRequest.Builder	defineSegment(Boolean defineSegment) Sets whether the endpoints create a segment when they are imported.
ImportJobRequest.Builder	externalId(String externalId) (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy.
ImportJobRequest.Builder	format(Format format) The format of the files that contain the endpoint definitions.
ImportJobRequest.Builder	format(String format) The format of the files that contain the endpoint definitions.
ImportJobRequest.Builder	registerEndpoints(Boolean registerEndpoints) Sets whether the endpoints are registered with Amazon Pinpoint when they are imported.
ImportJobRequest.Builder	roleArn(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.
ImportJobRequest.Builder	s3Url(String s3Url) The URL of the S3 bucket that contains the segment information to import.
ImportJobRequest.Builder	segmentId(String segmentId) The ID of the segment to update if the import job is meant to update an existing segment.
ImportJobRequest.Builder	segmentName(String segmentName) A custom name for the segment created by the import job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

defineSegment

ImportJobRequest.Builder defineSegment(Boolean defineSegment)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

externalId

ImportJobRequest.Builder externalId(String externalId)

(Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

Parameters:

externalId - (Deprecated) Your AWS account ID, which you assigned to the ExternalID key in an IAM trust policy. Used by Amazon Pinpoint to assume an IAM role. This requirement is removed, and external IDs are not recommended for IAM roles assumed by Amazon Pinpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

format

ImportJobRequest.Builder format(String format)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Format, Format

format

ImportJobRequest.Builder format(Format format)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Format, Format

registerEndpoints

ImportJobRequest.Builder registerEndpoints(Boolean registerEndpoints)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

ImportJobRequest.Builder roleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

s3Url

ImportJobRequest.Builder s3Url(String s3Url)

The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

Parameters:

s3Url - The URL of the S3 bucket that contains the segment information to import. The location can be a folder or a single file. The URL should use the following format: s3://bucket-name/folder-name/file-name Amazon Pinpoint imports endpoints from this location and any subfolders it contains.

Returns:

Returns a reference to this object so that method calls can be chained together.

segmentId

ImportJobRequest.Builder segmentId(String segmentId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

segmentName

ImportJobRequest.Builder segmentName(String segmentName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.