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 the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
ExportJobRequest.Builder	s3UrlPrefix(String s3UrlPrefix) The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to.
ExportJobRequest.Builder	segmentId(String segmentId) The identifier for the segment to export endpoint definitions from.
ExportJobRequest.Builder	segmentVersion(Integer segmentVersion) The version of the segment to export endpoint definitions from, if specified.

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

roleArn

ExportJobRequest.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 where you want to export endpoint definitions to.

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 where you want to export endpoint definitions to.

Returns:

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

s3UrlPrefix

ExportJobRequest.Builder s3UrlPrefix(String s3UrlPrefix)

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

Parameters:

s3UrlPrefix - The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

Returns:

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

segmentId

ExportJobRequest.Builder segmentId(String segmentId)

The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

Parameters:

segmentId - The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with 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 endpoint definitions from, if specified.

Parameters:

segmentVersion - The version of the segment to export endpoint definitions from, if specified.

Returns:

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