software.amazon.awssdk.services.quicksight.model

Interface StartAssetBundleExportJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartAssetBundleExportJobRequest.Builder,StartAssetBundleExportJobRequest>, QuickSightRequest.Builder, SdkBuilder<StartAssetBundleExportJobRequest.Builder,StartAssetBundleExportJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartAssetBundleExportJobRequest

public static interface StartAssetBundleExportJobRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<StartAssetBundleExportJobRequest.Builder,StartAssetBundleExportJobRequest>

Method Summary

Modifier and Type	Method and Description
StartAssetBundleExportJobRequest.Builder	assetBundleExportJobId(String assetBundleExportJobId) The ID of the job.
StartAssetBundleExportJobRequest.Builder	awsAccountId(String awsAccountId) The ID of the Amazon Web Services account to export assets from.
StartAssetBundleExportJobRequest.Builder	cloudFormationOverridePropertyConfiguration(AssetBundleCloudFormationOverridePropertyConfiguration cloudFormationOverridePropertyConfiguration) An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.
default StartAssetBundleExportJobRequest.Builder	cloudFormationOverridePropertyConfiguration(Consumer<AssetBundleCloudFormationOverridePropertyConfiguration.Builder> cloudFormationOverridePropertyConfiguration) An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.
StartAssetBundleExportJobRequest.Builder	exportFormat(AssetBundleExportFormat exportFormat) The export data format.
StartAssetBundleExportJobRequest.Builder	exportFormat(String exportFormat) The export data format.
StartAssetBundleExportJobRequest.Builder	includeAllDependencies(Boolean includeAllDependencies) A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job.
StartAssetBundleExportJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartAssetBundleExportJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartAssetBundleExportJobRequest.Builder	resourceArns(Collection<String> resourceArns) An array of resource ARNs to export.
StartAssetBundleExportJobRequest.Builder	resourceArns(String... resourceArns) An array of resource ARNs to export.

Methods inherited from interface software.amazon.awssdk.services.quicksight.model.QuickSightRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

awsAccountId

StartAssetBundleExportJobRequest.Builder awsAccountId(String awsAccountId)

The ID of the Amazon Web Services account to export assets from.

Parameters:

awsAccountId - The ID of the Amazon Web Services account to export assets from.

Returns:

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

assetBundleExportJobId

StartAssetBundleExportJobRequest.Builder assetBundleExportJobId(String assetBundleExportJobId)

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

Parameters:

assetBundleExportJobId - The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

Returns:

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

resourceArns

StartAssetBundleExportJobRequest.Builder resourceArns(Collection<String> resourceArns)

An array of resource ARNs to export. The following resources are supported.

• Analysis

• Dashboard

• DataSet

• DataSource

• RefreshSchedule

• Theme

• VPCConnection

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

Parameters:

resourceArns - An array of resource ARNs to export. The following resources are supported.

• Analysis

• Dashboard

• DataSet

• DataSource

• RefreshSchedule

• Theme

• VPCConnection

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

Returns:

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

resourceArns

StartAssetBundleExportJobRequest.Builder resourceArns(String... resourceArns)

An array of resource ARNs to export. The following resources are supported.

• Analysis

• Dashboard

• DataSet

• DataSource

• RefreshSchedule

• Theme

• VPCConnection

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

Parameters:

resourceArns - An array of resource ARNs to export. The following resources are supported.

• Analysis

• Dashboard

• DataSet

• DataSource

• RefreshSchedule

• Theme

• VPCConnection

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

Returns:

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

includeAllDependencies

StartAssetBundleExportJobRequest.Builder includeAllDependencies(Boolean includeAllDependencies)

A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

Parameters:

includeAllDependencies - A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.

Returns:

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

exportFormat

StartAssetBundleExportJobRequest.Builder exportFormat(String exportFormat)

The export data format.

Parameters:

exportFormat - The export data format.

Returns:

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

See Also:

AssetBundleExportFormat, AssetBundleExportFormat

exportFormat

StartAssetBundleExportJobRequest.Builder exportFormat(AssetBundleExportFormat exportFormat)

The export data format.

Parameters:

exportFormat - The export data format.

Returns:

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

See Also:

AssetBundleExportFormat, AssetBundleExportFormat

cloudFormationOverridePropertyConfiguration

StartAssetBundleExportJobRequest.Builder cloudFormationOverridePropertyConfiguration(AssetBundleCloudFormationOverridePropertyConfiguration cloudFormationOverridePropertyConfiguration)

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

Parameters:

cloudFormationOverridePropertyConfiguration - An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

Returns:

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

cloudFormationOverridePropertyConfiguration

default StartAssetBundleExportJobRequest.Builder cloudFormationOverridePropertyConfiguration(Consumer<AssetBundleCloudFormationOverridePropertyConfiguration.Builder> cloudFormationOverridePropertyConfiguration)

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

This is a convenience method that creates an instance of the AssetBundleCloudFormationOverridePropertyConfiguration.Builder avoiding the need to create one manually via AssetBundleCloudFormationOverridePropertyConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudFormationOverridePropertyConfiguration(AssetBundleCloudFormationOverridePropertyConfiguration).

Parameters:

cloudFormationOverridePropertyConfiguration - a consumer that will call methods on AssetBundleCloudFormationOverridePropertyConfiguration.Builder

Returns:

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

See Also:

cloudFormationOverridePropertyConfiguration(AssetBundleCloudFormationOverridePropertyConfiguration)

overrideConfiguration

StartAssetBundleExportJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartAssetBundleExportJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder