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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchDashboardsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	awsAccountId()	The ID of the Amazon Web Services 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()	For responses, this returns true if the service returned a value for the Filters property.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
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 final String awsAccountId()

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

Returns:

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

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final 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.

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 hasFilters() method.

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 final 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 final 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 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