software.amazon.awssdk.services.pinpoint.model

Interface ExportJobRequest.Builder

All Superinterfaces:

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

Enclosing class:

ExportJobRequest

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

Method Summary

Modifier and Type	Method and Description
ExportJobRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.
ExportJobRequest.Builder	s3UrlPrefix(String s3UrlPrefix) A URL that points to the location within an Amazon S3 bucket that will receive the export.
ExportJobRequest.Builder	segmentId(String segmentId) The ID of the segment to export endpoints from.
ExportJobRequest.Builder	segmentVersion(Integer segmentVersion) The version of the segment to export if specified.

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

roleArn

ExportJobRequest.Builder roleArn(String roleArn)

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

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role that grants Amazon Pinpoint access to the Amazon S3 location that endpoints will be exported to.

Returns:

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

s3UrlPrefix

ExportJobRequest.Builder s3UrlPrefix(String s3UrlPrefix)

A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

Parameters:

s3UrlPrefix - A URL that points to the location within an Amazon S3 bucket that will receive the export. The location is typically a folder with multiple files. The URL should follow this format: s3://bucket-name/folder-name/ Amazon Pinpoint will export endpoints to this location.

Returns:

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

segmentId

ExportJobRequest.Builder segmentId(String segmentId)

The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

Parameters:

segmentId - The ID of the segment to export endpoints from. If not present, Amazon Pinpoint exports all of the endpoints that belong to the application.

Returns:

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

segmentVersion

ExportJobRequest.Builder segmentVersion(Integer segmentVersion)

The version of the segment to export if specified.

Parameters:

segmentVersion - The version of the segment to export if specified.

Returns:

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