software.amazon.awssdk.services.quicksight.model

Class SearchDashboardsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchDashboardsRequest.Builder,SearchDashboardsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchDashboardsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The ID of the AWS account that contains the user whose dashboards you're searching for.
static SearchDashboardsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<DashboardSearchFilter>	filters() The filters to apply to the search.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Integer	maxResults() The maximum number of results to be returned per request.
String	nextToken() The token for the next set of results, or null if there are no more results.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchDashboardsRequest.Builder>	serializableBuilderClass()
SearchDashboardsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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 that contains the user whose dashboards you're searching for.

Returns:

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

hasFilters

public boolean hasFilters()

Returns true if the Filters 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.

filters

public List<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" } ]

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilters() to see if a value was sent in this field.

Returns:

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" } ]

nextToken

public String nextToken()

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

Returns:

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

maxResults

public Integer maxResults()

The maximum number of results to be returned per request.

Returns:

The maximum number of results to be returned per request.

toBuilder

public SearchDashboardsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchDashboardsRequest.Builder,SearchDashboardsRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static SearchDashboardsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchDashboardsRequest.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