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("software.amazon.awssdk:codegen")
public final class CreateDashboardRequest
extends QuickSightRequest
implements ToCopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateDashboardRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`awsAccountId()`	The ID of the Amazon Web Services 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:
`DashboardVersionDefinition`	`definition()`	The definition of a dashboard.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`folderArns()`	When you create the dashboard, QuickSight adds the dashboard to these folders.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFolderArns()`	For responses, this returns true if the service returned a value for the FolderArns property.
`int`	`hashCode()`
`boolean`	`hasLinkEntities()`	For responses, this returns true if the service returned a value for the LinkEntities property.
`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.
`List<String>`	`linkEntities()`	A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
`LinkSharingConfiguration`	`linkSharingConfiguration()`	A structure that contains the permissions of a shareable link to the dashboard.
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.
`ValidationStrategy`	`validationStrategy()`	The option to relax the validation needed to create a dashboard with definition objects.
`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 final String awsAccountId()
```
    The ID of the Amazon Web Services account where you want to create the dashboard.
    
    Returns:
    
    The ID of the Amazon Web Services account where you want to create the dashboard.
  - dashboardId
```
public final 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 final String name()
```
    The display name of the dashboard.
    
    Returns:
    
    The display name of the dashboard.
  - parameters
```
public final 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 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 contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
    
    To specify no permissions, omit the permissions list.
    
    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 contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
    
    To specify no permissions, omit the permissions list.
  - sourceEntity
```
public final 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 Amazon Web Services account and any QuickSight-supported Amazon Web Services 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.
    
    Either a SourceEntity or a Definition must be provided in order for the request to be valid.
    
    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 Amazon Web Services account and any QuickSight-supported Amazon Web Services 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.
    
    Either a SourceEntity or a Definition must be provided in order for the request to be valid.
  - 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 dashboard.
    
    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 dashboard.
  - versionDescription
```
public final 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 final 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.
    
    AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.
    
    AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED 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.
    
    AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.
    
    AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.
  - themeArn
```
public final 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 Amazon Web Services 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 Amazon Web Services account where you create the dashboard.
  - definition
```
public final DashboardVersionDefinition definition()
```
    The definition of a dashboard.
    
    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 a dashboard.
    
    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.
  - validationStrategy
```
public final ValidationStrategy validationStrategy()
```
    The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
    
    Returns:
    
    The option to relax the validation needed to create a dashboard with definition objects. This option 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 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.
  - folderArns
```
public final List<String> folderArns()
```
    When you create the dashboard, QuickSight adds the dashboard 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 dashboard, QuickSight adds the dashboard to these folders.
  - linkSharingConfiguration
```
public final LinkSharingConfiguration linkSharingConfiguration()
```
    A structure that contains the permissions of a shareable link to the dashboard.
    
    Returns:
    
    A structure that contains the permissions of a shareable link to the dashboard.
  - hasLinkEntities
```
public final boolean hasLinkEntities()
```
    For responses, this returns true if the service returned a value for the LinkEntities 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.
  - linkEntities
```
public final List<String> linkEntities()
```
    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
    
    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 hasLinkEntities() method.
    
    Returns:
    
    A list of analysis Amazon Resource Names (ARNs) to be linked to 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 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField 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

definition

validationStrategy

hasFolderArns

folderArns

linkSharingConfiguration

hasLinkEntities

linkEntities

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField