software.amazon.awssdk.services.quicksight.model

Class DashboardSearchFilter

java.lang.Object

software.amazon.awssdk.services.quicksight.model.DashboardSearchFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DashboardSearchFilter.Builder,DashboardSearchFilter>

@Generated(value="software.amazon.awssdk:codegen")
public final class DashboardSearchFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DashboardSearchFilter.Builder,DashboardSearchFilter>

A filter that you apply when searching for dashboards.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DashboardSearchFilter.Builder

Method Summary

Modifier and Type	Method and Description
static DashboardSearchFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DashboardFilterAttribute	name() The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER".
String	nameAsString() The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER".
FilterOperator	operator() The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".
String	operatorAsString() The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".
List<SdkField<?>>	sdkFields()
static Class<? extends DashboardSearchFilter.Builder>	serializableBuilderClass()
DashboardSearchFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	value() The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

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

operator

public FilterOperator operator()

The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".

If the service returns an enum value that is not available in the current SDK version, operator will return FilterOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".

See Also:

FilterOperator

operatorAsString

public String operatorAsString()

The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".

If the service returns an enum value that is not available in the current SDK version, operator will return FilterOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

The comparison operator that you want to use as a filter, for example, "Operator": "StringEquals".

See Also:

FilterOperator

name

public DashboardFilterAttribute name()

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER".

If the service returns an enum value that is not available in the current SDK version, name will return DashboardFilterAttribute.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER".

See Also:

DashboardFilterAttribute

nameAsString

public String nameAsString()

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER".

If the service returns an enum value that is not available in the current SDK version, name will return DashboardFilterAttribute.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_USER".

See Also:

DashboardFilterAttribute

value

public String value()

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

Returns:

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".

toBuilder

public DashboardSearchFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DashboardSearchFilter.Builder,DashboardSearchFilter>

builder

public static DashboardSearchFilter.Builder builder()

serializableBuilderClass

public static Class<? extends DashboardSearchFilter.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo