WordCloudOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.WordCloudOptions

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The word cloud options for a word cloud visual.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WordCloudOptions()

Constructors
Constructor and Description
`WordCloudOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WordCloudOptions`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCloudLayout()` The cloud layout options (fluid, normal) of a word cloud.
`Integer`	`getMaximumStringLength()` The length limit of each word from 1-100.
`String`	`getWordCasing()` The word casing options (lower_case, existing_case) for the words in a word cloud.
`String`	`getWordOrientation()` The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
`String`	`getWordPadding()` The word padding options (none, small, medium, large) for the words in a word cloud.
`String`	`getWordScaling()` The word scaling options (emphasize, normal) for the words in a word cloud.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCloudLayout(String cloudLayout)` The cloud layout options (fluid, normal) of a word cloud.
`void`	`setMaximumStringLength(Integer maximumStringLength)` The length limit of each word from 1-100.
`void`	`setWordCasing(String wordCasing)` The word casing options (lower_case, existing_case) for the words in a word cloud.
`void`	`setWordOrientation(String wordOrientation)` The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
`void`	`setWordPadding(String wordPadding)` The word padding options (none, small, medium, large) for the words in a word cloud.
`void`	`setWordScaling(String wordScaling)` The word scaling options (emphasize, normal) for the words in a word cloud.
`String`	`toString()` Returns a string representation of this object.
`WordCloudOptions`	`withCloudLayout(String cloudLayout)` The cloud layout options (fluid, normal) of a word cloud.
`WordCloudOptions`	`withCloudLayout(WordCloudCloudLayout cloudLayout)` The cloud layout options (fluid, normal) of a word cloud.
`WordCloudOptions`	`withMaximumStringLength(Integer maximumStringLength)` The length limit of each word from 1-100.
`WordCloudOptions`	`withWordCasing(String wordCasing)` The word casing options (lower_case, existing_case) for the words in a word cloud.
`WordCloudOptions`	`withWordCasing(WordCloudWordCasing wordCasing)` The word casing options (lower_case, existing_case) for the words in a word cloud.
`WordCloudOptions`	`withWordOrientation(String wordOrientation)` The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
`WordCloudOptions`	`withWordOrientation(WordCloudWordOrientation wordOrientation)` The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
`WordCloudOptions`	`withWordPadding(String wordPadding)` The word padding options (none, small, medium, large) for the words in a word cloud.
`WordCloudOptions`	`withWordPadding(WordCloudWordPadding wordPadding)` The word padding options (none, small, medium, large) for the words in a word cloud.
`WordCloudOptions`	`withWordScaling(String wordScaling)` The word scaling options (emphasize, normal) for the words in a word cloud.
`WordCloudOptions`	`withWordScaling(WordCloudWordScaling wordScaling)` The word scaling options (emphasize, normal) for the words in a word cloud.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WordCloudOptions
```
public WordCloudOptions()
```
- Method Detail
  - setWordOrientation
```
public void setWordOrientation(String wordOrientation)
```
    The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
    
    Parameters:
    
    wordOrientation - The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
    
    See Also:
    
    WordCloudWordOrientation
  - getWordOrientation
```
public String getWordOrientation()
```
    The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
    
    Returns:
    
    The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
    
    See Also:
    
    WordCloudWordOrientation
  - withWordOrientation
```
public WordCloudOptions withWordOrientation(String wordOrientation)
```
    The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
    
    Parameters:
    
    wordOrientation - The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudWordOrientation
  - withWordOrientation
```
public WordCloudOptions withWordOrientation(WordCloudWordOrientation wordOrientation)
```
    The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
    
    Parameters:
    
    wordOrientation - The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudWordOrientation
  - setWordScaling
```
public void setWordScaling(String wordScaling)
```
    The word scaling options (emphasize, normal) for the words in a word cloud.
    
    Parameters:
    
    wordScaling - The word scaling options (emphasize, normal) for the words in a word cloud.
    
    See Also:
    
    WordCloudWordScaling
  - getWordScaling
```
public String getWordScaling()
```
    The word scaling options (emphasize, normal) for the words in a word cloud.
    
    Returns:
    
    The word scaling options (emphasize, normal) for the words in a word cloud.
    
    See Also:
    
    WordCloudWordScaling
  - withWordScaling
```
public WordCloudOptions withWordScaling(String wordScaling)
```
    The word scaling options (emphasize, normal) for the words in a word cloud.
    
    Parameters:
    
    wordScaling - The word scaling options (emphasize, normal) for the words in a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudWordScaling
  - withWordScaling
```
public WordCloudOptions withWordScaling(WordCloudWordScaling wordScaling)
```
    The word scaling options (emphasize, normal) for the words in a word cloud.
    
    Parameters:
    
    wordScaling - The word scaling options (emphasize, normal) for the words in a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudWordScaling
  - setCloudLayout
```
public void setCloudLayout(String cloudLayout)
```
    The cloud layout options (fluid, normal) of a word cloud.
    
    Parameters:
    
    cloudLayout - The cloud layout options (fluid, normal) of a word cloud.
    
    See Also:
    
    WordCloudCloudLayout
  - getCloudLayout
```
public String getCloudLayout()
```
    The cloud layout options (fluid, normal) of a word cloud.
    
    Returns:
    
    The cloud layout options (fluid, normal) of a word cloud.
    
    See Also:
    
    WordCloudCloudLayout
  - withCloudLayout
```
public WordCloudOptions withCloudLayout(String cloudLayout)
```
    The cloud layout options (fluid, normal) of a word cloud.
    
    Parameters:
    
    cloudLayout - The cloud layout options (fluid, normal) of a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudCloudLayout
  - withCloudLayout
```
public WordCloudOptions withCloudLayout(WordCloudCloudLayout cloudLayout)
```
    The cloud layout options (fluid, normal) of a word cloud.
    
    Parameters:
    
    cloudLayout - The cloud layout options (fluid, normal) of a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudCloudLayout
  - setWordCasing
```
public void setWordCasing(String wordCasing)
```
    The word casing options (lower_case, existing_case) for the words in a word cloud.
    
    Parameters:
    
    wordCasing - The word casing options (lower_case, existing_case) for the words in a word cloud.
    
    See Also:
    
    WordCloudWordCasing
  - getWordCasing
```
public String getWordCasing()
```
    The word casing options (lower_case, existing_case) for the words in a word cloud.
    
    Returns:
    
    The word casing options (lower_case, existing_case) for the words in a word cloud.
    
    See Also:
    
    WordCloudWordCasing
  - withWordCasing
```
public WordCloudOptions withWordCasing(String wordCasing)
```
    The word casing options (lower_case, existing_case) for the words in a word cloud.
    
    Parameters:
    
    wordCasing - The word casing options (lower_case, existing_case) for the words in a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudWordCasing
  - withWordCasing
```
public WordCloudOptions withWordCasing(WordCloudWordCasing wordCasing)
```
    The word casing options (lower_case, existing_case) for the words in a word cloud.
    
    Parameters:
    
    wordCasing - The word casing options (lower_case, existing_case) for the words in a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudWordCasing
  - setWordPadding
```
public void setWordPadding(String wordPadding)
```
    The word padding options (none, small, medium, large) for the words in a word cloud.
    
    Parameters:
    
    wordPadding - The word padding options (none, small, medium, large) for the words in a word cloud.
    
    See Also:
    
    WordCloudWordPadding
  - getWordPadding
```
public String getWordPadding()
```
    The word padding options (none, small, medium, large) for the words in a word cloud.
    
    Returns:
    
    The word padding options (none, small, medium, large) for the words in a word cloud.
    
    See Also:
    
    WordCloudWordPadding
  - withWordPadding
```
public WordCloudOptions withWordPadding(String wordPadding)
```
    The word padding options (none, small, medium, large) for the words in a word cloud.
    
    Parameters:
    
    wordPadding - The word padding options (none, small, medium, large) for the words in a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudWordPadding
  - withWordPadding
```
public WordCloudOptions withWordPadding(WordCloudWordPadding wordPadding)
```
    The word padding options (none, small, medium, large) for the words in a word cloud.
    
    Parameters:
    
    wordPadding - The word padding options (none, small, medium, large) for the words in a word cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WordCloudWordPadding
  - setMaximumStringLength
```
public void setMaximumStringLength(Integer maximumStringLength)
```
    The length limit of each word from 1-100.
    
    Parameters:
    
    maximumStringLength - The length limit of each word from 1-100.
  - getMaximumStringLength
```
public Integer getMaximumStringLength()
```
    The length limit of each word from 1-100.
    
    Returns:
    
    The length limit of each word from 1-100.
  - withMaximumStringLength
```
public WordCloudOptions withMaximumStringLength(Integer maximumStringLength)
```
    The length limit of each word from 1-100.
    
    Parameters:
    
    maximumStringLength - The length limit of each word from 1-100.
    
    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 WordCloudOptions 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.

Did this page help you?

Class WordCloudOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WordCloudOptions

Method Detail

setWordOrientation

getWordOrientation

withWordOrientation

withWordOrientation

setWordScaling

getWordScaling

withWordScaling

withWordScaling

setCloudLayout

getCloudLayout

withCloudLayout

withCloudLayout

setWordCasing

getWordCasing

withWordCasing

withWordCasing

setWordPadding

getWordPadding

withWordPadding

withWordPadding

setMaximumStringLength

getMaximumStringLength

withMaximumStringLength

toString

equals

hashCode

clone

marshall