Interface DashboardSearchFilter.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<DashboardSearchFilter.Builder,DashboardSearchFilter>,SdkBuilder<DashboardSearchFilter.Builder,DashboardSearchFilter>,SdkPojo
- Enclosing class:
- DashboardSearchFilter
public static interface DashboardSearchFilter.Builder extends SdkPojo, CopyableBuilder<DashboardSearchFilter.Builder,DashboardSearchFilter>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DashboardSearchFilter.Buildername(String name)The name of the value that you want to use as a filter, for example,"Name": "QUICKSIGHT_OWNER".DashboardSearchFilter.Buildername(DashboardFilterAttribute name)The name of the value that you want to use as a filter, for example,"Name": "QUICKSIGHT_OWNER".DashboardSearchFilter.Builderoperator(String operator)The comparison operator that you want to use as a filter, for example"Operator": "StringEquals".DashboardSearchFilter.Builderoperator(FilterOperator operator)The comparison operator that you want to use as a filter, for example"Operator": "StringEquals".DashboardSearchFilter.Buildervalue(String value)The value of the named item, in this caseQUICKSIGHT_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 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 Detail
-
operator
DashboardSearchFilter.Builder operator(String 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":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The"StringLike"operator only supports theNAMEvalueDASHBOARD_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":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The"StringLike"operator only supports theNAMEvalueDASHBOARD_NAME.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
FilterOperator,FilterOperator
-
operator
DashboardSearchFilter.Builder operator(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":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The"StringLike"operator only supports theNAMEvalueDASHBOARD_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":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The"StringLike"operator only supports theNAMEvalueDASHBOARD_NAME.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
FilterOperator,FilterOperator
-
name
DashboardSearchFilter.Builder name(String 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 dashboards with that ARN listed as one of the dashboards'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 dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered. -
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered. -
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards 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 dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered. -
DASHBOARD_NAME: Any dashboards 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 dashboards with that ARN listed as one of the dashboards'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 dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered. -
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered. -
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards 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 dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered. -
DASHBOARD_NAME: Any dashboards 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:
DashboardFilterAttribute,DashboardFilterAttribute
-
-
name
DashboardSearchFilter.Builder name(DashboardFilterAttribute 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 dashboards with that ARN listed as one of the dashboards'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 dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered. -
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered. -
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards 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 dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered. -
DASHBOARD_NAME: Any dashboards 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 dashboards with that ARN listed as one of the dashboards'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 dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered. -
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered. -
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards 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 dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered. -
DASHBOARD_NAME: Any dashboards 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:
DashboardFilterAttribute,DashboardFilterAttribute
-
-
value
DashboardSearchFilter.Builder value(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".- Parameters:
value- The value of the named item, in this caseQUICKSIGHT_USER, that you want to use as a filter, for example,"Value": "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.
-
-