Class CreateAnalysisRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateAnalysisRequest.Builder,
CreateAnalysisRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID for the analysis that you're creating.final String
The ID of the Amazon Web Services account where you are creating an analysis.builder()
final AnalysisDefinition
The definition of an analysis.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.When you create the analysis, Amazon QuickSight adds the analysis to these folders.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the FolderArns property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Permissions property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
A descriptive name for the analysis that you're creating.final Parameters
The parameter names and override values that you want to use.final List
<ResourcePermission> A structure that describes the principals and the resource-level permissions on an analysis.static Class
<? extends CreateAnalysisRequest.Builder> final AnalysisSourceEntity
A source entity to use for the analysis that you're creating.tags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.final String
themeArn()
The ARN for the theme to apply to the analysis that you're creating.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ValidationStrategy
The option to relax the validation needed to create an analysis with definition objects.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
awsAccountId
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.
-
analysisId
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.
-
name
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.
-
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:
- 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.
-
hasPermissions
public final boolean hasPermissions()For responses, this returns true if the service returned a value for the Permissions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPermissions()
method.- 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
.
-
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 aDefinition
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 aDefinition
must be provided in order for the request to be valid.
-
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:
- 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.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
-
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 aDefinition
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 aDefinition
must be provided in order for the request to be valid.
-
validationStrategy
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.
-
hasFolderArns
public final boolean hasFolderArns()For responses, this returns true if the service returned a value for the FolderArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
folderArns
When you create the analysis, Amazon QuickSight adds the analysis to these folders.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFolderArns()
method.- Returns:
- When you create the analysis, Amazon QuickSight adds the analysis to these folders.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateAnalysisRequest.Builder,
CreateAnalysisRequest> - Specified by:
toBuilder
in classQuickSightRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-