Class FolderSearchFilter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FolderSearchFilter.Builder,
FolderSearchFilter>
A filter to use to search an Amazon QuickSight folder.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic FolderSearchFilter.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final FolderFilterAttribute
name()
The name of a value that you want to use in the filter.final String
The name of a value that you want to use in the filter.final FilterOperator
operator()
The comparison operator that you want to use as a filter, for example"Operator": "StringEquals"
.final String
The comparison operator that you want to use as a filter, for example"Operator": "StringEquals"
.static Class
<? extends FolderSearchFilter.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
value()
The value of the named item (in this example,PARENT_FOLDER_ARN
), that you want to use as a filter.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"
. The"StringLike"
operator only supports theNAME
valueFOLDER_NAME
.If the service returns an enum value that is not available in the current SDK version,
operator
will returnFilterOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatorAsString()
.- 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":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"
. The"StringLike"
operator only supports theNAME
valueFOLDER_NAME
. - See Also:
-
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":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"
. The"StringLike"
operator only supports theNAME
valueFOLDER_NAME
.If the service returns an enum value that is not available in the current SDK version,
operator
will returnFilterOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatorAsString()
.- 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":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"
. The"StringLike"
operator only supports theNAME
valueFOLDER_NAME
. - See Also:
-
name
The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder's 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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered. -
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered. -
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. -
FOLDER_NAME
: Any folders whose names have a substring match to this value will be returned. -
PARENT_FOLDER_ARN
: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
If the service returns an enum value that is not available in the current SDK version,
name
will returnFolderFilterAttribute.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder's 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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered. -
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered. -
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. -
FOLDER_NAME
: Any folders whose names have a substring match to this value will be returned. -
PARENT_FOLDER_ARN
: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
-
- See Also:
-
-
nameAsString
The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder's 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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered. -
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered. -
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. -
FOLDER_NAME
: Any folders whose names have a substring match to this value will be returned. -
PARENT_FOLDER_ARN
: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
If the service returns an enum value that is not available in the current SDK version,
name
will returnFolderFilterAttribute.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of a value that you want to use in the 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 folders with that ARN listed as one of the folder's 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 folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered. -
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered. -
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders 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 folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. -
FOLDER_NAME
: Any folders whose names have a substring match to this value will be returned. -
PARENT_FOLDER_ARN
: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
-
- See Also:
-
-
value
The value of the named item (in this example,
PARENT_FOLDER_ARN
), that you want to use as a filter. For example,"Value": "arn:aws:quicksight:us-east-1:1:folder/folderId"
.- Returns:
- The value of the named item (in this example,
PARENT_FOLDER_ARN
), that you want to use as a filter. For example,"Value": "arn:aws:quicksight:us-east-1:1:folder/folderId"
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<FolderSearchFilter.Builder,
FolderSearchFilter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-