com.amazonaws.services.quicksight.model

Class SearchDashboardsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.SearchDashboardsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SearchDashboardsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SearchDashboardsRequest()

Method Summary

Modifier and Type	Method and Description
SearchDashboardsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
List<DashboardSearchFilter>	getFilters() The filters to apply to the search.
Integer	getMaxResults() The maximum number of results to be returned per request.
String	getNextToken() The token for the next set of results, or null if there are no more results.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
void	setFilters(Collection<DashboardSearchFilter> filters) The filters to apply to the search.
void	setMaxResults(Integer maxResults) The maximum number of results to be returned per request.
void	setNextToken(String nextToken) The token for the next set of results, or null if there are no more results.
String	toString() Returns a string representation of this object.
SearchDashboardsRequest	withAwsAccountId(String awsAccountId) The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
SearchDashboardsRequest	withFilters(Collection<DashboardSearchFilter> filters) The filters to apply to the search.
SearchDashboardsRequest	withFilters(DashboardSearchFilter... filters) The filters to apply to the search.
SearchDashboardsRequest	withMaxResults(Integer maxResults) The maximum number of results to be returned per request.
SearchDashboardsRequest	withNextToken(String nextToken) The token for the next set of results, or null if there are no more results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchDashboardsRequest

public SearchDashboardsRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

Parameters:

awsAccountId - The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

getAwsAccountId

public String getAwsAccountId()

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

Returns:

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

withAwsAccountId

public SearchDashboardsRequest withAwsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

Parameters:

awsAccountId - The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

Returns:

Returns a reference to this object so that method calls can be chained together.

getFilters

public List<DashboardSearchFilter> getFilters()

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Returns:

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

setFilters

public void setFilters(Collection<DashboardSearchFilter> filters)

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Parameters:

filters - The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

withFilters

public SearchDashboardsRequest withFilters(DashboardSearchFilter... filters)

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "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.

withFilters

public SearchDashboardsRequest withFilters(Collection<DashboardSearchFilter> filters)

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Parameters:

filters - The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "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.

setNextToken

public void setNextToken(String nextToken)

The token for the next set of results, or null if there are no more results.

Parameters:

nextToken - The token for the next set of results, or null if there are no more results.

getNextToken

public String getNextToken()

The token for the next set of results, or null if there are no more results.

Returns:

The token for the next set of results, or null if there are no more results.

withNextToken

public SearchDashboardsRequest withNextToken(String nextToken)

The token for the next set of results, or null if there are no more results.

Parameters:

nextToken - The token for the next set of results, or null if there are no more results.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to be returned per request.

Parameters:

maxResults - The maximum number of results to be returned per request.

getMaxResults

public Integer getMaxResults()

The maximum number of results to be returned per request.

Returns:

The maximum number of results to be returned per request.

withMaxResults

public SearchDashboardsRequest withMaxResults(Integer maxResults)

The maximum number of results to be returned per request.

Parameters:

maxResults - The maximum number of results to be returned per request.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SearchDashboardsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()