Interface CreateDashboardRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>, QuickSightRequest.Builder, SdkBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDashboardRequest
public static interface CreateDashboardRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<CreateDashboardRequest.Builder,CreateDashboardRequest>

  • Method Details

    • awsAccountId

      CreateDashboardRequest.Builder awsAccountId(String awsAccountId)

      The ID of the Amazon Web Services account where you want to create the dashboard.

      Parameters:
      awsAccountId - The ID of the Amazon Web Services account where you want to create the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dashboardId

      CreateDashboardRequest.Builder dashboardId(String dashboardId)

      The ID for the dashboard, also added to the IAM policy.

      Parameters:
      dashboardId - The ID for the dashboard, also added to the IAM policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateDashboardRequest.Builder name(String name)

      The display name of the dashboard.

      Parameters:
      name - The display name of the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

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

      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:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      default CreateDashboardRequest.Builder parameters(Consumer<Parameters.Builder> 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.

      This is a convenience method that creates an instance of the Parameters.Builder avoiding the need to create one manually via Parameters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(Parameters).

      Parameters:
      parameters - a consumer that will call methods on Parameters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • permissions

      CreateDashboardRequest.Builder permissions(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

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

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permissions

      CreateDashboardRequest.Builder permissions(Consumer<ResourcePermission.Builder>... 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.

      This is a convenience method that creates an instance of the ResourcePermission.Builder avoiding the need to create one manually via ResourcePermission.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to permissions(List<ResourcePermission>).

      Parameters:
      permissions - a consumer that will call methods on ResourcePermission.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceEntity

      CreateDashboardRequest.Builder sourceEntity(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 Amazon 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.

      Parameters:
      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 Amazon 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:
      Returns a reference to this object so that method calls can be chained together.

    • sourceEntity

      default CreateDashboardRequest.Builder sourceEntity(Consumer<DashboardSourceEntity.Builder> 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 Amazon 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.

      This is a convenience method that creates an instance of the DashboardSourceEntity.Builder avoiding the need to create one manually via DashboardSourceEntity.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceEntity(DashboardSourceEntity).

      Parameters:
      sourceEntity - a consumer that will call methods on DashboardSourceEntity.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateDashboardRequest.Builder tags(Collection<Tag> tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDashboardRequest.Builder tags(Tag... tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateDashboardRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • versionDescription

      CreateDashboardRequest.Builder versionDescription(String versionDescription)

      A description for the first version of the dashboard being created.

      Parameters:
      versionDescription - A description for the first version of the dashboard being created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dashboardPublishOptions

      CreateDashboardRequest.Builder dashboardPublishOptions(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, Amazon 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.

      Parameters:
      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, Amazon 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:
      Returns a reference to this object so that method calls can be chained together.

    • dashboardPublishOptions

      default CreateDashboardRequest.Builder dashboardPublishOptions(Consumer<DashboardPublishOptions.Builder> 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, Amazon 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.

      This is a convenience method that creates an instance of the DashboardPublishOptions.Builder avoiding the need to create one manually via DashboardPublishOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dashboardPublishOptions(DashboardPublishOptions).

      Parameters:
      dashboardPublishOptions - a consumer that will call methods on DashboardPublishOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • themeArn

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • definition

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • definition

      default CreateDashboardRequest.Builder definition(Consumer<DashboardVersionDefinition.Builder> 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.

      This is a convenience method that creates an instance of the DashboardVersionDefinition.Builder avoiding the need to create one manually via DashboardVersionDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(DashboardVersionDefinition).

      Parameters:
      definition - a consumer that will call methods on DashboardVersionDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • validationStrategy

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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • validationStrategy

      default CreateDashboardRequest.Builder validationStrategy(Consumer<ValidationStrategy.Builder> validationStrategy)

      The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

      This is a convenience method that creates an instance of the ValidationStrategy.Builder avoiding the need to create one manually via ValidationStrategy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validationStrategy(ValidationStrategy).

      Parameters:
      validationStrategy - a consumer that will call methods on ValidationStrategy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • folderArns

      CreateDashboardRequest.Builder folderArns(Collection<String> folderArns)

      When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

      Parameters:
      folderArns - When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • folderArns

      CreateDashboardRequest.Builder folderArns(String... folderArns)

      When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

      Parameters:
      folderArns - When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • linkSharingConfiguration

      CreateDashboardRequest.Builder linkSharingConfiguration(LinkSharingConfiguration linkSharingConfiguration)

      A structure that contains the permissions of a shareable link to the dashboard.

      Parameters:
      linkSharingConfiguration - A structure that contains the permissions of a shareable link to the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • linkSharingConfiguration

      default CreateDashboardRequest.Builder linkSharingConfiguration(Consumer<LinkSharingConfiguration.Builder> linkSharingConfiguration)

      A structure that contains the permissions of a shareable link to the dashboard.

      This is a convenience method that creates an instance of the LinkSharingConfiguration.Builder avoiding the need to create one manually via LinkSharingConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to linkSharingConfiguration(LinkSharingConfiguration).

      Parameters:
      linkSharingConfiguration - a consumer that will call methods on LinkSharingConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • linkEntities

      CreateDashboardRequest.Builder linkEntities(Collection<String> linkEntities)

      A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

      Parameters:
      linkEntities - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • linkEntities

      CreateDashboardRequest.Builder linkEntities(String... linkEntities)

      A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

      Parameters:
      linkEntities - A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateDashboardRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDashboardRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.