Interface AnalysisSearchFilter.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AnalysisSearchFilter.Builder,
,AnalysisSearchFilter> SdkBuilder<AnalysisSearchFilter.Builder,
,AnalysisSearchFilter> SdkPojo
- Enclosing class:
AnalysisSearchFilter
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the value that you want to use as a filter, for example"Name": "QUICKSIGHT_OWNER"
.name
(AnalysisFilterAttribute name) The name of the value that you want to use as a filter, for example"Name": "QUICKSIGHT_OWNER"
.The comparison operator that you want to use as a filter, for example"Operator": "StringEquals"
.operator
(FilterOperator operator) The comparison operator that you want to use as a filter, for example"Operator": "StringEquals"
.The value of the named item, in this caseQUICKSIGHT_USER
, that you want to use as a filter, for example"Value"
.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test"
. The"StringLike"
operator only supports theNAME
valueANALYSIS_NAME
.- Parameters:
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 theNAME
valueANALYSIS_NAME
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theNAME
valueANALYSIS_NAME
.- Parameters:
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 theNAME
valueANALYSIS_NAME
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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"
.- Parameters:
value
- The value of the named item, in this caseQUICKSIGHT_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:
- Returns a reference to this object so that method calls can be chained together.
-