com.amazonaws.services.quicksight.model

Class StartAssetBundleExportJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.StartAssetBundleExportJobRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartAssetBundleExportJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartAssetBundleExportJobRequest()

Method Summary

Modifier and Type	Method and Description
StartAssetBundleExportJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAssetBundleExportJobId() The ID of the job.
String	getAwsAccountId() The ID of the Amazon Web Services account to export assets from.
AssetBundleCloudFormationOverridePropertyConfiguration	getCloudFormationOverridePropertyConfiguration() 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.
String	getExportFormat() The export data format.
Boolean	getIncludeAllDependencies() A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job.
Boolean	getIncludePermissions() A Boolean that determines whether all permissions for each resource ARN are exported with the job.
Boolean	getIncludeTags() A Boolean that determines whether all tags for each resource ARN are exported with the job.
List<String>	getResourceArns() An array of resource ARNs to export.
AssetBundleExportJobValidationStrategy	getValidationStrategy() An optional parameter that determines which validation strategy to use for the export job.
int	hashCode()
Boolean	isIncludeAllDependencies() A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job.
Boolean	isIncludePermissions() A Boolean that determines whether all permissions for each resource ARN are exported with the job.
Boolean	isIncludeTags() A Boolean that determines whether all tags for each resource ARN are exported with the job.
void	setAssetBundleExportJobId(String assetBundleExportJobId) The ID of the job.
void	setAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account to export assets from.
void	setCloudFormationOverridePropertyConfiguration(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.
void	setExportFormat(String exportFormat) The export data format.
void	setIncludeAllDependencies(Boolean includeAllDependencies) A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job.
void	setIncludePermissions(Boolean includePermissions) A Boolean that determines whether all permissions for each resource ARN are exported with the job.
void	setIncludeTags(Boolean includeTags) A Boolean that determines whether all tags for each resource ARN are exported with the job.
void	setResourceArns(Collection<String> resourceArns) An array of resource ARNs to export.
void	setValidationStrategy(AssetBundleExportJobValidationStrategy validationStrategy) An optional parameter that determines which validation strategy to use for the export job.
String	toString() Returns a string representation of this object.
StartAssetBundleExportJobRequest	withAssetBundleExportJobId(String assetBundleExportJobId) The ID of the job.
StartAssetBundleExportJobRequest	withAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account to export assets from.
StartAssetBundleExportJobRequest	withCloudFormationOverridePropertyConfiguration(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.
StartAssetBundleExportJobRequest	withExportFormat(AssetBundleExportFormat exportFormat) The export data format.
StartAssetBundleExportJobRequest	withExportFormat(String exportFormat) The export data format.
StartAssetBundleExportJobRequest	withIncludeAllDependencies(Boolean includeAllDependencies) A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job.
StartAssetBundleExportJobRequest	withIncludePermissions(Boolean includePermissions) A Boolean that determines whether all permissions for each resource ARN are exported with the job.
StartAssetBundleExportJobRequest	withIncludeTags(Boolean includeTags) A Boolean that determines whether all tags for each resource ARN are exported with the job.
StartAssetBundleExportJobRequest	withResourceArns(Collection<String> resourceArns) An array of resource ARNs to export.
StartAssetBundleExportJobRequest	withResourceArns(String... resourceArns) An array of resource ARNs to export.
StartAssetBundleExportJobRequest	withValidationStrategy(AssetBundleExportJobValidationStrategy validationStrategy) An optional parameter that determines which validation strategy to use for the export job.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartAssetBundleExportJobRequest

public StartAssetBundleExportJobRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(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.

getAwsAccountId

public String getAwsAccountId()

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

Returns:

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

withAwsAccountId

public StartAssetBundleExportJobRequest withAwsAccountId(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.

setAssetBundleExportJobId

public void setAssetBundleExportJobId(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.

getAssetBundleExportJobId

public String getAssetBundleExportJobId()

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:

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.

withAssetBundleExportJobId

public StartAssetBundleExportJobRequest withAssetBundleExportJobId(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.

getResourceArns

public List<String> getResourceArns()

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:

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.

setResourceArns

public void setResourceArns(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.

withResourceArns

public StartAssetBundleExportJobRequest withResourceArns(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.

NOTE: This method appends the values to the existing list (if any). Use setResourceArns(java.util.Collection) or withResourceArns(java.util.Collection) if you want to override the existing values.

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.

withResourceArns

public StartAssetBundleExportJobRequest withResourceArns(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.

setIncludeAllDependencies

public void setIncludeAllDependencies(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.

getIncludeAllDependencies

public Boolean getIncludeAllDependencies()

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:

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.

withIncludeAllDependencies

public StartAssetBundleExportJobRequest withIncludeAllDependencies(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.

isIncludeAllDependencies

public Boolean isIncludeAllDependencies()

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:

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.

setExportFormat

public void setExportFormat(String exportFormat)

The export data format.

Parameters:

exportFormat - The export data format.

See Also:

AssetBundleExportFormat

getExportFormat

public String getExportFormat()

The export data format.

Returns:

The export data format.

See Also:

AssetBundleExportFormat

withExportFormat

public StartAssetBundleExportJobRequest withExportFormat(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

withExportFormat

public StartAssetBundleExportJobRequest withExportFormat(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

setCloudFormationOverridePropertyConfiguration

public void setCloudFormationOverridePropertyConfiguration(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.

getCloudFormationOverridePropertyConfiguration

public AssetBundleCloudFormationOverridePropertyConfiguration getCloudFormationOverridePropertyConfiguration()

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:

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.

withCloudFormationOverridePropertyConfiguration

public StartAssetBundleExportJobRequest withCloudFormationOverridePropertyConfiguration(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.

setIncludePermissions

public void setIncludePermissions(Boolean includePermissions)

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

Parameters:

includePermissions - A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

getIncludePermissions

public Boolean getIncludePermissions()

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

Returns:

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

withIncludePermissions

public StartAssetBundleExportJobRequest withIncludePermissions(Boolean includePermissions)

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

Parameters:

includePermissions - A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

Returns:

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

isIncludePermissions

public Boolean isIncludePermissions()

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

Returns:

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.

setIncludeTags

public void setIncludeTags(Boolean includeTags)

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

Parameters:

includeTags - A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

getIncludeTags

public Boolean getIncludeTags()

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

Returns:

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

withIncludeTags

public StartAssetBundleExportJobRequest withIncludeTags(Boolean includeTags)

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

Parameters:

includeTags - A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

Returns:

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

isIncludeTags

public Boolean isIncludeTags()

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

Returns:

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

setValidationStrategy

public void setValidationStrategy(AssetBundleExportJobValidationStrategy validationStrategy)

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

Parameters:

validationStrategy - An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

getValidationStrategy

public AssetBundleExportJobValidationStrategy getValidationStrategy()

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

Returns:

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

withValidationStrategy

public StartAssetBundleExportJobRequest withValidationStrategy(AssetBundleExportJobValidationStrategy validationStrategy)

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

Parameters:

validationStrategy - An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartAssetBundleExportJobRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()