Interface SearchDashboardsRequest.Builder

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

  • Method Details

    • awsAccountId

      SearchDashboardsRequest.Builder awsAccountId(String awsAccountId)

      The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

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

    • filters

      SearchDashboardsRequest.Builder filters(Collection<DashboardSearchFilter> filters)

      The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

      Parameters:
      filters - The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      SearchDashboardsRequest.Builder filters(DashboardSearchFilter... filters)

      The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

      Parameters:
      filters - The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      SearchDashboardsRequest.Builder filters(Consumer<DashboardSearchFilter.Builder>... filters)

      The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

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

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

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

    • nextToken

      SearchDashboardsRequest.Builder nextToken(String nextToken)

      The token for the next set of results, or null if there are no more results.

      Parameters:
      nextToken - The token for the next set of results, or null if there are no more results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      SearchDashboardsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to be returned per request.

      Parameters:
      maxResults - The maximum number of results to be returned per request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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