com.amazonaws.services.quicksight.model

Class WordCloudSortConfiguration

java.lang.Object

com.amazonaws.services.quicksight.model.WordCloudSortConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The sort configuration of a word cloud visual.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
WordCloudSortConfiguration()

Method Summary

Modifier and Type	Method and Description
WordCloudSortConfiguration	clone()
boolean	equals(Object obj)
ItemsLimitConfiguration	getCategoryItemsLimit() The limit on the number of groups that are displayed in a word cloud.
List<FieldSortOptions>	getCategorySort() The sort configuration of group by fields.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setCategoryItemsLimit(ItemsLimitConfiguration categoryItemsLimit) The limit on the number of groups that are displayed in a word cloud.
void	setCategorySort(Collection<FieldSortOptions> categorySort) The sort configuration of group by fields.
String	toString() Returns a string representation of this object.
WordCloudSortConfiguration	withCategoryItemsLimit(ItemsLimitConfiguration categoryItemsLimit) The limit on the number of groups that are displayed in a word cloud.
WordCloudSortConfiguration	withCategorySort(Collection<FieldSortOptions> categorySort) The sort configuration of group by fields.
WordCloudSortConfiguration	withCategorySort(FieldSortOptions... categorySort) The sort configuration of group by fields.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WordCloudSortConfiguration

public WordCloudSortConfiguration()

Method Detail

setCategoryItemsLimit

public void setCategoryItemsLimit(ItemsLimitConfiguration categoryItemsLimit)

The limit on the number of groups that are displayed in a word cloud.

Parameters:

categoryItemsLimit - The limit on the number of groups that are displayed in a word cloud.

getCategoryItemsLimit

public ItemsLimitConfiguration getCategoryItemsLimit()

The limit on the number of groups that are displayed in a word cloud.

Returns:

The limit on the number of groups that are displayed in a word cloud.

withCategoryItemsLimit

public WordCloudSortConfiguration withCategoryItemsLimit(ItemsLimitConfiguration categoryItemsLimit)

The limit on the number of groups that are displayed in a word cloud.

Parameters:

categoryItemsLimit - The limit on the number of groups that are displayed in a word cloud.

Returns:

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

getCategorySort

public List<FieldSortOptions> getCategorySort()

The sort configuration of group by fields.

Returns:

The sort configuration of group by fields.

setCategorySort

public void setCategorySort(Collection<FieldSortOptions> categorySort)

The sort configuration of group by fields.

Parameters:

categorySort - The sort configuration of group by fields.

withCategorySort

public WordCloudSortConfiguration withCategorySort(FieldSortOptions... categorySort)

The sort configuration of group by fields.

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

Parameters:

categorySort - The sort configuration of group by fields.

Returns:

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

withCategorySort

public WordCloudSortConfiguration withCategorySort(Collection<FieldSortOptions> categorySort)

The sort configuration of group by fields.

Parameters:

categorySort - The sort configuration of group by fields.

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 WordCloudSortConfiguration clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.