Package software.amazon.awssdk.services.quicksight.model

Interface UpdateDashboardRequest.Builder

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

  • Method Details

    • awsAccountId

      UpdateDashboardRequest.Builder awsAccountId(String awsAccountId)

      The ID of the Amazon Web Services account that contains the dashboard that you're updating.

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

    • dashboardId

      UpdateDashboardRequest.Builder dashboardId(String dashboardId)

      The ID for the dashboard.

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

    • name

      UpdateDashboardRequest.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.

    • sourceEntity

      UpdateDashboardRequest.Builder sourceEntity(DashboardSourceEntity sourceEntity)

      The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update 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 SourceTemplate ARN 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.

      Parameters:
      sourceEntity - The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update 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 SourceTemplate ARN 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.

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

    • sourceEntity

      default UpdateDashboardRequest.Builder sourceEntity(Consumer<DashboardSourceEntity.Builder> sourceEntity)

      The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update 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 SourceTemplate ARN 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.

      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:

    • parameters

      UpdateDashboardRequest.Builder parameters(Parameters parameters)

      A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

      Parameters:
      parameters - A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. 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 UpdateDashboardRequest.Builder parameters(Consumer<Parameters.Builder> parameters)

      A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. 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:

    • versionDescription

      UpdateDashboardRequest.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

      UpdateDashboardRequest.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 UpdateDashboardRequest.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

      UpdateDashboardRequest.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 was originally associated with the 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 was originally associated with the 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

      UpdateDashboardRequest.Builder definition(DashboardVersionDefinition definition)

      The definition of a dashboard.

      A definition is the data model of all features in a Dashboard, Template, or Analysis.

      Parameters:
      definition - The definition of a dashboard.

      A definition is the data model of all features in a Dashboard, Template, or Analysis.

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

    • definition

      default UpdateDashboardRequest.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.

      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

      UpdateDashboardRequest.Builder validationStrategy(ValidationStrategy validationStrategy)

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

      Parameters:
      validationStrategy - The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validationStrategy

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

      The option to relax the validation needed to update a dashboard with definition objects. This 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:

    • overrideConfiguration

      UpdateDashboardRequest.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

      UpdateDashboardRequest.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.