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

Class SearchAnalysesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchAnalysesRequest.Builder,SearchAnalysesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchAnalysesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	awsAccountId()	The ID of the Amazon Web Services account that contains the analyses that you're searching for.
static SearchAnalysesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<AnalysisSearchFilter>	filters()	The structure for the search filters that you want to apply to your 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 return.
String	nextToken()	A pagination token that can be used in a subsequent request.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchAnalysesRequest.Builder>	serializableBuilderClass()
SearchAnalysesRequest.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 analyses that you're searching for.

Returns:

The ID of the Amazon Web Services account that contains the analyses that 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<AnalysisSearchFilter> filters()

The structure for the search filters that you want to apply to your search.

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 structure for the search filters that you want to apply to your search.

nextToken

public final String nextToken()

A pagination token that can be used in a subsequent request.

Returns:

A pagination token that can be used in a subsequent request.

maxResults

public final Integer maxResults()

The maximum number of results to return.

Returns:

The maximum number of results to return.

toBuilder

public SearchAnalysesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchAnalysesRequest.Builder,SearchAnalysesRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static SearchAnalysesRequest.Builder builder()

serializableBuilderClass

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