CreateAnalysisRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.quicksight.model.QuickSightRequest
    - - software.amazon.awssdk.services.quicksight.model.CreateAnalysisRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateAnalysisRequest.Builder,CreateAnalysisRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateAnalysisRequest
extends QuickSightRequest
implements ToCopyableBuilder<CreateAnalysisRequest.Builder,CreateAnalysisRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateAnalysisRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateAnalysisRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`analysisId()` The ID for the analysis that you're creating.
`String`	`awsAccountId()` The ID of the Amazon Web Services account where you are creating an analysis.
`static CreateAnalysisRequest.Builder`	`builder()`
`AnalysisDefinition`	`definition()` The definition of an analysis.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPermissions()` For responses, this returns true if the service returned a value for the Permissions property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()` A descriptive name for the analysis that you're creating.
`Parameters`	`parameters()` The parameter names and override values that you want to use.
`List<ResourcePermission>`	`permissions()` A structure that describes the principals and the resource-level permissions on an analysis.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateAnalysisRequest.Builder>`	`serializableBuilderClass()`
`AnalysisSourceEntity`	`sourceEntity()` A source entity to use for the analysis that you're creating.
`List<Tag>`	`tags()` Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
`String`	`themeArn()` The ARN for the theme to apply to the analysis that you're creating.
`CreateAnalysisRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - awsAccountId
```
public final String 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
```
public final String 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
```
public final String 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
```
public final 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:
    
    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 the isEmpty() 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
```
public final List<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.
    
    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
```
public final 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.
    
    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.
  - themeArn
```
public final 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.
    
    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 the isEmpty() 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
```
public final List<Tag> 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
```
public final 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.
    
    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.
  - toBuilder
```
public CreateAnalysisRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateAnalysisRequest.Builder,CreateAnalysisRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
  - builder
```
public static CreateAnalysisRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateAnalysisRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateAnalysisRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

awsAccountId

analysisId

name

parameters

hasPermissions

permissions

sourceEntity

themeArn

hasTags

tags

definition

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields