java.lang.Object
- software.amazon.awssdk.services.quicksight.model.AnalysisSearchFilter

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AnalysisSearchFilter.Builder,AnalysisSearchFilter>

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

A filter that you apply when searching for one or more analyses.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AnalysisSearchFilter.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AnalysisSearchFilter.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`AnalysisFilterAttribute`	`name()`	The name of the value that you want to use as a filter, for example `"Name": "QUICKSIGHT_OWNER"`.
`String`	`nameAsString()`	The name of the value that you want to use as a filter, for example `"Name": "QUICKSIGHT_OWNER"`.
`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 AnalysisSearchFilter.Builder>`	`serializableBuilderClass()`
`AnalysisSearchFilter.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"`.

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 final FilterOperator operator()
```
    The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
    
    If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
    
    If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.
    
    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". Valid values are "StringEquals" and "StringLike".
    
    If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
    
    If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.
    
    See Also:
    
    FilterOperator
  - operatorAsString
```
public final String operatorAsString()
```
    The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
    
    If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
    
    If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.
    
    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". Valid values are "StringEquals" and "StringLike".
    
    If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
    
    If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.
    
    See Also:
    
    FilterOperator
  - name
```
public final AnalysisFilterAttribute name()
```
    The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_OWNER".
    
    Valid values are defined as follows:
    
    QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered.
    
    QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
    
    DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
    
    DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
    
    DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
    
    ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.
    
    If the service returns an enum value that is not available in the current SDK version, name will return AnalysisFilterAttribute.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_OWNER".
    
    Valid values are defined as follows:
    
    QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered.
    
    QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
    
    DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
    
    DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
    
    DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
    
    ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.
    
    See Also:
    
    AnalysisFilterAttribute
  - nameAsString
```
public final String nameAsString()
```
    The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_OWNER".
    
    Valid values are defined as follows:
    
    QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered.
    
    QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
    
    DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
    
    DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
    
    DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
    
    ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.
    
    If the service returns an enum value that is not available in the current SDK version, name will return AnalysisFilterAttribute.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_OWNER".
    
    Valid values are defined as follows:
    
    QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered.
    
    QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
    
    DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
    
    DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
    
    DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
    
    ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.
    
    See Also:
    
    AnalysisFilterAttribute
  - value
```
public final String value()
```
    The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example "Value". An example is "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". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
  - toBuilder
```
public AnalysisSearchFilter.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AnalysisSearchFilter.Builder,AnalysisSearchFilter>
  - builder
```
public static AnalysisSearchFilter.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AnalysisSearchFilter.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AnalysisSearchFilter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

operator

operatorAsString

name

nameAsString

value

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields