CreateDashboardRequest (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.CreateDashboardRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateDashboardRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`awsAccountId()` The ID of the AWS account where you want to create the dashboard.
`static CreateDashboardRequest.Builder`	`builder()`
`String`	`dashboardId()` The ID for the dashboard, also added to the IAM policy.
`DashboardPublishOptions`	`dashboardPublishOptions()` Options for publishing the dashboard when you create it:
`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()` The display name of the dashboard.
`Parameters`	`parameters()` The parameters for the creation of the dashboard, which you want to use to override the default settings.
`List<ResourcePermission>`	`permissions()` A structure that contains the permissions of the dashboard.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDashboardRequest.Builder>`	`serializableBuilderClass()`
`DashboardSourceEntity`	`sourceEntity()` The entity that you are using as a source when you create the dashboard.
`List<Tag>`	`tags()` Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
`String`	`themeArn()` The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
`CreateDashboardRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`versionDescription()` A description for the first version of the dashboard being created.

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 want to create the dashboard.
    
    Returns:
    
    The ID of the AWS account where you want to create the dashboard.
  - dashboardId
```
public String dashboardId()
```
    The ID for the dashboard, also added to the IAM policy.
    
    Returns:
    
    The ID for the dashboard, also added to the IAM policy.
  - name
```
public String name()
```
    The display name of the dashboard.
    
    Returns:
    
    The display name of the dashboard.
  - parameters
```
public Parameters parameters()
```
    The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
    
    Returns:
    
    The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, 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 contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.
    
    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 contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.
  - sourceEntity
```
public DashboardSourceEntity sourceEntity()
```
    The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.
    
    Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
    
    Returns:
    
    The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.
    
    Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
  - 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 dashboard.
    
    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 dashboard.
  - versionDescription
```
public String versionDescription()
```
    A description for the first version of the dashboard being created.
    
    Returns:
    
    A description for the first version of the dashboard being created.
  - dashboardPublishOptions
```
public DashboardPublishOptions dashboardPublishOptions()
```
    Options for publishing the dashboard when you create it:
    - AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
    - AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
    - VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
    Returns:
    Options for publishing the dashboard when you create it:
    
    AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
    
    AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default.
    
    VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
  - themeArn
```
public String themeArn()
```
    The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
  - toBuilder
```
public CreateDashboardRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
  - builder
```
public static CreateDashboardRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDashboardRequest.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 CreateDashboardRequest

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

dashboardId

name

parameters

hasPermissions

permissions

sourceEntity

hasTags

tags

versionDescription

dashboardPublishOptions

themeArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields