software.amazon.awssdk.services.pinpoint.model

Interface ImportJobResource.Builder

All Superinterfaces:

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

Enclosing class:

ImportJobResource

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

Method Summary

Modifier and Type	Method and Description
ImportJobResource.Builder	defineSegment(Boolean defineSegment) Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
ImportJobResource.Builder	externalId(String externalId) (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy.
ImportJobResource.Builder	format(Format format) The format of the files that contain the endpoint definitions to import.
ImportJobResource.Builder	format(String format) The format of the files that contain the endpoint definitions to import.
ImportJobResource.Builder	registerEndpoints(Boolean registerEndpoints) Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
ImportJobResource.Builder	roleArn(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.
ImportJobResource.Builder	s3Url(String s3Url) The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import.
ImportJobResource.Builder	segmentId(String segmentId) The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
ImportJobResource.Builder	segmentName(String segmentName) The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

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

equalsBySdkFields, 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

ImportJobResource.Builder defineSegment(Boolean defineSegment)

Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

Parameters:

defineSegment - Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

Returns:

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

externalId

ImportJobResource.Builder externalId(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.

Parameters:

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:

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

format

ImportJobResource.Builder format(String 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 files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

Parameters:

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 files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

Returns:

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

See Also:

Format, Format

format

ImportJobResource.Builder format(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 files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

Parameters:

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 files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

Returns:

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

See Also:

Format, Format

registerEndpoints

ImportJobResource.Builder registerEndpoints(Boolean registerEndpoints)

Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

Parameters:

registerEndpoints - Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

Returns:

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

roleArn

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

Parameters:

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:

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

s3Url

ImportJobResource.Builder s3Url(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.

Parameters:

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:

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

segmentId

ImportJobResource.Builder segmentId(String segmentId)

The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

Parameters:

segmentId - The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

Returns:

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

segmentName

ImportJobResource.Builder segmentName(String segmentName)

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

Parameters:

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

Returns:

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