Package software.amazon.awssdk.services.quicksight.model

Interface DescribeAssetBundleExportJobResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeAssetBundleExportJobResponse.Builder,DescribeAssetBundleExportJobResponse>, QuickSightResponse.Builder, SdkBuilder<DescribeAssetBundleExportJobResponse.Builder,DescribeAssetBundleExportJobResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeAssetBundleExportJobResponse

public static interface DescribeAssetBundleExportJobResponse.Builder
extends QuickSightResponse.Builder, SdkPojo, CopyableBuilder<DescribeAssetBundleExportJobResponse.Builder,DescribeAssetBundleExportJobResponse>

Method Summary

Modifier and Type	Method	Description
DescribeAssetBundleExportJobResponse.Builder	arn(String arn)	The Amazon Resource Name (ARN) for the export job.
DescribeAssetBundleExportJobResponse.Builder	assetBundleExportJobId(String assetBundleExportJobId)	The ID of the job.
DescribeAssetBundleExportJobResponse.Builder	awsAccountId(String awsAccountId)	The ID of the Amazon Web Services account that the export job was executed in.
default DescribeAssetBundleExportJobResponse.Builder	cloudFormationOverridePropertyConfiguration(Consumer<AssetBundleCloudFormationOverridePropertyConfiguration.Builder> cloudFormationOverridePropertyConfiguration)	The CloudFormation override property configuration for the export job.
DescribeAssetBundleExportJobResponse.Builder	cloudFormationOverridePropertyConfiguration(AssetBundleCloudFormationOverridePropertyConfiguration cloudFormationOverridePropertyConfiguration)	The CloudFormation override property configuration for the export job.
DescribeAssetBundleExportJobResponse.Builder	createdTime(Instant createdTime)	The time that the export job was created.
DescribeAssetBundleExportJobResponse.Builder	downloadUrl(String downloadUrl)	The URL to download the exported asset bundle data from.
DescribeAssetBundleExportJobResponse.Builder	errors(Collection<AssetBundleExportJobError> errors)	An array of error records that describes any failures that occurred during the export job processing.
DescribeAssetBundleExportJobResponse.Builder	errors(Consumer<AssetBundleExportJobError.Builder>... errors)	An array of error records that describes any failures that occurred during the export job processing.
DescribeAssetBundleExportJobResponse.Builder	errors(AssetBundleExportJobError... errors)	An array of error records that describes any failures that occurred during the export job processing.
DescribeAssetBundleExportJobResponse.Builder	exportFormat(String exportFormat)	The format of the exported asset bundle.
DescribeAssetBundleExportJobResponse.Builder	exportFormat(AssetBundleExportFormat exportFormat)	The format of the exported asset bundle.
DescribeAssetBundleExportJobResponse.Builder	includeAllDependencies(Boolean includeAllDependencies)	The include dependencies flag.
DescribeAssetBundleExportJobResponse.Builder	includePermissions(Boolean includePermissions)	The include permissions flag.
DescribeAssetBundleExportJobResponse.Builder	includeTags(Boolean includeTags)	The include tags flag.
DescribeAssetBundleExportJobResponse.Builder	jobStatus(String jobStatus)	Indicates the status of a job through its queuing and execution.
DescribeAssetBundleExportJobResponse.Builder	jobStatus(AssetBundleExportJobStatus jobStatus)	Indicates the status of a job through its queuing and execution.
DescribeAssetBundleExportJobResponse.Builder	requestId(String requestId)	The Amazon Web Services request ID for this operation.
DescribeAssetBundleExportJobResponse.Builder	resourceArns(String... resourceArns)	A list of resource ARNs that exported with the job.
DescribeAssetBundleExportJobResponse.Builder	resourceArns(Collection<String> resourceArns)	A list of resource ARNs that exported with the job.
DescribeAssetBundleExportJobResponse.Builder	status(Integer status)	The HTTP status of the response.
default DescribeAssetBundleExportJobResponse.Builder	validationStrategy(Consumer<AssetBundleExportJobValidationStrategy.Builder> validationStrategy)	The validation strategy that is used to export the analysis or dashboard.
DescribeAssetBundleExportJobResponse.Builder	validationStrategy(AssetBundleExportJobValidationStrategy validationStrategy)	The validation strategy that is used to export the analysis or dashboard.
DescribeAssetBundleExportJobResponse.Builder	warnings(Collection<AssetBundleExportJobWarning> warnings)	An array of warning records that describe the analysis or dashboard that is exported.
DescribeAssetBundleExportJobResponse.Builder	warnings(Consumer<AssetBundleExportJobWarning.Builder>... warnings)	An array of warning records that describe the analysis or dashboard that is exported.
DescribeAssetBundleExportJobResponse.Builder	warnings(AssetBundleExportJobWarning... warnings)	An array of warning records that describe the analysis or dashboard that is exported.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

jobStatus

DescribeAssetBundleExportJobResponse.Builder jobStatus(String jobStatus)

Indicates the status of a job through its queuing and execution.

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

Parameters:

jobStatus - Indicates the status of a job through its queuing and execution.

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

Returns:

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

See Also:

• AssetBundleExportJobStatus
• AssetBundleExportJobStatus

jobStatus

DescribeAssetBundleExportJobResponse.Builder jobStatus(AssetBundleExportJobStatus jobStatus)

Indicates the status of a job through its queuing and execution.

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

Parameters:

jobStatus - Indicates the status of a job through its queuing and execution.

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

Returns:

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

See Also:

• AssetBundleExportJobStatus
• AssetBundleExportJobStatus

downloadUrl

DescribeAssetBundleExportJobResponse.Builder downloadUrl(String downloadUrl)

The URL to download the exported asset bundle data from.

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

Parameters:

downloadUrl - The URL to download the exported asset bundle data from.

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

Returns:

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

errors

DescribeAssetBundleExportJobResponse.Builder errors(Collection<AssetBundleExportJobError> errors)

An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

Parameters:

errors - An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

Returns:

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

errors

DescribeAssetBundleExportJobResponse.Builder errors(AssetBundleExportJobError... errors)

An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

Parameters:

errors - An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

Returns:

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

errors

DescribeAssetBundleExportJobResponse.Builder errors(Consumer<AssetBundleExportJobError.Builder>... errors)

An array of error records that describes any failures that occurred during the export job processing.

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to errors(List<AssetBundleExportJobError>).

Parameters:

errors - a consumer that will call methods on AssetBundleExportJobError.Builder

Returns:

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

See Also:

• errors(java.util.Collection<AssetBundleExportJobError>)

arn

DescribeAssetBundleExportJobResponse.Builder arn(String arn)

The Amazon Resource Name (ARN) for the export job.

Parameters:

arn - The Amazon Resource Name (ARN) for the export job.

Returns:

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

createdTime

DescribeAssetBundleExportJobResponse.Builder createdTime(Instant createdTime)

The time that the export job was created.

Parameters:

createdTime - The time that the export job was created.

Returns:

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

assetBundleExportJobId

DescribeAssetBundleExportJobResponse.Builder assetBundleExportJobId(String assetBundleExportJobId)

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

Parameters:

assetBundleExportJobId - The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

Returns:

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

awsAccountId

DescribeAssetBundleExportJobResponse.Builder awsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that the export job was executed in.

Parameters:

awsAccountId - The ID of the Amazon Web Services account that the export job was executed in.

Returns:

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

resourceArns

DescribeAssetBundleExportJobResponse.Builder resourceArns(Collection<String> resourceArns)

A list of resource ARNs that exported with the job.

Parameters:

resourceArns - A list of resource ARNs that exported with the job.

Returns:

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

resourceArns

DescribeAssetBundleExportJobResponse.Builder resourceArns(String... resourceArns)

A list of resource ARNs that exported with the job.

Parameters:

resourceArns - A list of resource ARNs that exported with the job.

Returns:

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

includeAllDependencies

DescribeAssetBundleExportJobResponse.Builder includeAllDependencies(Boolean includeAllDependencies)

The include dependencies flag.

Parameters:

includeAllDependencies - The include dependencies flag.

Returns:

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

exportFormat

DescribeAssetBundleExportJobResponse.Builder exportFormat(String exportFormat)

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

Parameters:

exportFormat - The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

Returns:

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

See Also:

• AssetBundleExportFormat
• AssetBundleExportFormat

exportFormat

DescribeAssetBundleExportJobResponse.Builder exportFormat(AssetBundleExportFormat exportFormat)

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

Parameters:

exportFormat - The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

Returns:

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

See Also:

• AssetBundleExportFormat
• AssetBundleExportFormat

cloudFormationOverridePropertyConfiguration

DescribeAssetBundleExportJobResponse.Builder cloudFormationOverridePropertyConfiguration(AssetBundleCloudFormationOverridePropertyConfiguration cloudFormationOverridePropertyConfiguration)

The CloudFormation override property configuration for the export job.

Parameters:

cloudFormationOverridePropertyConfiguration - The CloudFormation override property configuration for the export job.

Returns:

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

cloudFormationOverridePropertyConfiguration

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

The CloudFormation override property configuration for the export job.

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)

requestId

DescribeAssetBundleExportJobResponse.Builder requestId(String requestId)

The Amazon Web Services request ID for this operation.

Parameters:

requestId - The Amazon Web Services request ID for this operation.

Returns:

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

status

DescribeAssetBundleExportJobResponse.Builder status(Integer status)

The HTTP status of the response.

Parameters:

status - The HTTP status of the response.

Returns:

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

includePermissions

DescribeAssetBundleExportJobResponse.Builder includePermissions(Boolean includePermissions)

The include permissions flag.

Parameters:

includePermissions - The include permissions flag.

Returns:

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

includeTags

DescribeAssetBundleExportJobResponse.Builder includeTags(Boolean includeTags)

The include tags flag.

Parameters:

includeTags - The include tags flag.

Returns:

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

validationStrategy

DescribeAssetBundleExportJobResponse.Builder validationStrategy(AssetBundleExportJobValidationStrategy validationStrategy)

The validation strategy that is used to export the analysis or dashboard.

Parameters:

validationStrategy - The validation strategy that is used to export the analysis or dashboard.

Returns:

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

validationStrategy

default DescribeAssetBundleExportJobResponse.Builder validationStrategy(Consumer<AssetBundleExportJobValidationStrategy.Builder> validationStrategy)

The validation strategy that is used to export the analysis or dashboard.

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

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

Parameters:

validationStrategy - a consumer that will call methods on AssetBundleExportJobValidationStrategy.Builder

Returns:

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

See Also:

• validationStrategy(AssetBundleExportJobValidationStrategy)

warnings

DescribeAssetBundleExportJobResponse.Builder warnings(Collection<AssetBundleExportJobWarning> warnings)

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

Parameters:

warnings - An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

Returns:

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

warnings

DescribeAssetBundleExportJobResponse.Builder warnings(AssetBundleExportJobWarning... warnings)

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

Parameters:

warnings - An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

Returns:

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

warnings

DescribeAssetBundleExportJobResponse.Builder warnings(Consumer<AssetBundleExportJobWarning.Builder>... warnings)

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to warnings(List<AssetBundleExportJobWarning>).

Parameters:

warnings - a consumer that will call methods on AssetBundleExportJobWarning.Builder

Returns:

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

See Also:

• warnings(java.util.Collection<AssetBundleExportJobWarning>)