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 AWS account where you are creating an analysis.
`static CreateAnalysisRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPermissions()` Returns true if the Permissions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 String awsAccountId()
```
    The ID of the AWS account where you are creating an analysis.
    
    Returns:
    
    The ID of the AWS account where you are creating an analysis.
  - analysisId
```
public 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 String name()
```
    A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
    
    Returns:
    
    A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
  - parameters
```
public 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 boolean hasPermissions()
```
    Returns true if the Permissions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - permissions
```
public 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 AWS 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.
    
    You can use hasPermissions() to see if a value was sent in this field.
    
    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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
    
    To specify no permissions, omit Permissions.
  - sourceEntity
```
public 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.
    
    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.
  - themeArn
```
public String themeArn()
```
    The ARN for the theme to apply to the analysis that you're creating. To see the theme in the 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 QuickSight console, make sure that you have access to it.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
  - 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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public 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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields