com.amazonaws.services.quicksight.model

Class CreateAnalysisRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.CreateAnalysisRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAnalysisRequest
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
CreateAnalysisRequest()

Method Summary

Modifier and Type	Method and Description
CreateAnalysisRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAnalysisId() The ID for the analysis that you're creating.
String	getAwsAccountId() The ID of the Amazon Web Services account where you are creating an analysis.
AnalysisDefinition	getDefinition() The definition of an analysis.
List<String>	getFolderArns() When you create the analysis, Amazon QuickSight adds the analysis to these folders.
String	getName() A descriptive name for the analysis that you're creating.
Parameters	getParameters() The parameter names and override values that you want to use.
List<ResourcePermission>	getPermissions() A structure that describes the principals and the resource-level permissions on an analysis.
AnalysisSourceEntity	getSourceEntity() A source entity to use for the analysis that you're creating.
List<Tag>	getTags() Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
String	getThemeArn() The ARN for the theme to apply to the analysis that you're creating.
ValidationStrategy	getValidationStrategy() The option to relax the validation needed to create an analysis with definition objects.
int	hashCode()
void	setAnalysisId(String analysisId) The ID for the analysis that you're creating.
void	setAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account where you are creating an analysis.
void	setDefinition(AnalysisDefinition definition) The definition of an analysis.
void	setFolderArns(Collection<String> folderArns) When you create the analysis, Amazon QuickSight adds the analysis to these folders.
void	setName(String name) A descriptive name for the analysis that you're creating.
void	setParameters(Parameters parameters) The parameter names and override values that you want to use.
void	setPermissions(Collection<ResourcePermission> permissions) A structure that describes the principals and the resource-level permissions on an analysis.
void	setSourceEntity(AnalysisSourceEntity sourceEntity) A source entity to use for the analysis that you're creating.
void	setTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
void	setThemeArn(String themeArn) The ARN for the theme to apply to the analysis that you're creating.
void	setValidationStrategy(ValidationStrategy validationStrategy) The option to relax the validation needed to create an analysis with definition objects.
String	toString() Returns a string representation of this object.
CreateAnalysisRequest	withAnalysisId(String analysisId) The ID for the analysis that you're creating.
CreateAnalysisRequest	withAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account where you are creating an analysis.
CreateAnalysisRequest	withDefinition(AnalysisDefinition definition) The definition of an analysis.
CreateAnalysisRequest	withFolderArns(Collection<String> folderArns) When you create the analysis, Amazon QuickSight adds the analysis to these folders.
CreateAnalysisRequest	withFolderArns(String... folderArns) When you create the analysis, Amazon QuickSight adds the analysis to these folders.
CreateAnalysisRequest	withName(String name) A descriptive name for the analysis that you're creating.
CreateAnalysisRequest	withParameters(Parameters parameters) The parameter names and override values that you want to use.
CreateAnalysisRequest	withPermissions(Collection<ResourcePermission> permissions) A structure that describes the principals and the resource-level permissions on an analysis.
CreateAnalysisRequest	withPermissions(ResourcePermission... permissions) A structure that describes the principals and the resource-level permissions on an analysis.
CreateAnalysisRequest	withSourceEntity(AnalysisSourceEntity sourceEntity) A source entity to use for the analysis that you're creating.
CreateAnalysisRequest	withTags(Collection<Tag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
CreateAnalysisRequest	withTags(Tag... tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
CreateAnalysisRequest	withThemeArn(String themeArn) The ARN for the theme to apply to the analysis that you're creating.
CreateAnalysisRequest	withValidationStrategy(ValidationStrategy validationStrategy) The option to relax the validation needed to create an analysis with definition objects.

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

CreateAnalysisRequest

public CreateAnalysisRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

The ID of the Amazon Web Services account where you are creating an analysis.

Parameters:

awsAccountId - The ID of the Amazon Web Services account where you are creating an analysis.

getAwsAccountId

public String getAwsAccountId()

The ID of the Amazon Web Services account where you are creating an analysis.

Returns:

The ID of the Amazon Web Services account where you are creating an analysis.

withAwsAccountId

public CreateAnalysisRequest withAwsAccountId(String awsAccountId)

The ID of the Amazon Web Services account where you are creating an analysis.

Parameters:

awsAccountId - The ID of the Amazon Web Services account where you are creating an analysis.

Returns:

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

setAnalysisId

public void setAnalysisId(String analysisId)

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Parameters:

analysisId - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

getAnalysisId

public String getAnalysisId()

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Returns:

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

withAnalysisId

public CreateAnalysisRequest withAnalysisId(String analysisId)

The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Parameters:

analysisId - The ID for the analysis that you're creating. This ID displays in the URL of the analysis.

Returns:

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

setName

public void setName(String name)

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

Parameters:

name - A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

getName

public String getName()

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

Returns:

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

withName

public CreateAnalysisRequest withName(String name)

A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

Parameters:

name - A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.

Returns:

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

setParameters

public void setParameters(Parameters parameters)

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Parameters:

parameters - The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

getParameters

public Parameters getParameters()

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Returns:

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

withParameters

public CreateAnalysisRequest withParameters(Parameters parameters)

The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Parameters:

parameters - The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.

Returns:

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

getPermissions

public List<ResourcePermission> getPermissions()

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

Returns:

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

setPermissions

public void setPermissions(Collection<ResourcePermission> permissions)

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

Parameters:

permissions - A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

withPermissions

public CreateAnalysisRequest withPermissions(ResourcePermission... permissions)

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

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

Parameters:

permissions - A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

Returns:

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

withPermissions

public CreateAnalysisRequest withPermissions(Collection<ResourcePermission> permissions)

A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

Parameters:

permissions - A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).

To specify no permissions, omit Permissions.

Returns:

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

setSourceEntity

public void setSourceEntity(AnalysisSourceEntity sourceEntity)

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

sourceEntity - A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

getSourceEntity

public AnalysisSourceEntity getSourceEntity()

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

withSourceEntity

public CreateAnalysisRequest withSourceEntity(AnalysisSourceEntity sourceEntity)

A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

sourceEntity - A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

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

setThemeArn

public void setThemeArn(String themeArn)

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

Parameters:

themeArn - The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

getThemeArn

public String getThemeArn()

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

Returns:

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

withThemeArn

public CreateAnalysisRequest withThemeArn(String themeArn)

The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

Parameters:

themeArn - The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.

Returns:

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

getTags

public List<Tag> getTags()

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Returns:

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

setTags

public void setTags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

withTags

public CreateAnalysisRequest withTags(Tag... tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

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

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Returns:

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

withTags

public CreateAnalysisRequest withTags(Collection<Tag> tags)

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Parameters:

tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

Returns:

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

setDefinition

public void setDefinition(AnalysisDefinition definition)

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

definition - The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

getDefinition

public AnalysisDefinition getDefinition()

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

withDefinition

public CreateAnalysisRequest withDefinition(AnalysisDefinition definition)

The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Parameters:

definition - The definition of an analysis.

A definition is the data model of all features in a Dashboard, Template, or Analysis.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

Returns:

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

setValidationStrategy

public void setValidationStrategy(ValidationStrategy validationStrategy)

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

Parameters:

validationStrategy - The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

getValidationStrategy

public ValidationStrategy getValidationStrategy()

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

Returns:

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

withValidationStrategy

public CreateAnalysisRequest withValidationStrategy(ValidationStrategy validationStrategy)

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

Parameters:

validationStrategy - The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

Returns:

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

getFolderArns

public List<String> getFolderArns()

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

Returns:

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

setFolderArns

public void setFolderArns(Collection<String> folderArns)

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

Parameters:

folderArns - When you create the analysis, Amazon QuickSight adds the analysis to these folders.

withFolderArns

public CreateAnalysisRequest withFolderArns(String... folderArns)

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

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

Parameters:

folderArns - When you create the analysis, Amazon QuickSight adds the analysis to these folders.

Returns:

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

withFolderArns

public CreateAnalysisRequest withFolderArns(Collection<String> folderArns)

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

Parameters:

folderArns - When you create the analysis, Amazon QuickSight adds the analysis to these folders.

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 CreateAnalysisRequest 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()