com.amazonaws.services.cloudsearchv2.model

Class LiteralOptions

java.lang.Object

com.amazonaws.services.cloudsearchv2.model.LiteralOptions

All Implemented Interfaces:

Serializable, Cloneable

public class LiteralOptions
extends Object
implements Serializable, Cloneable

Options for literal field. Present if IndexFieldType specifies the field is of type literal . All options are enabled by default.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LiteralOptions()

Method Summary

Methods

Modifier and Type	Method and Description
LiteralOptions	clone()
boolean	equals(Object obj)
String	getDefaultValue() A value to use for the field if the field isn't specified for a document.
Boolean	getFacetEnabled() Whether facet information can be returned for the field.
Boolean	getReturnEnabled() Whether the contents of the field can be returned in the search results.
Boolean	getSearchEnabled() Whether the contents of the field are searchable.
Boolean	getSortEnabled() Whether the field can be used to sort the search results.
String	getSourceField() A string that represents the name of an index field.
int	hashCode()
Boolean	isFacetEnabled() Whether facet information can be returned for the field.
Boolean	isReturnEnabled() Whether the contents of the field can be returned in the search results.
Boolean	isSearchEnabled() Whether the contents of the field are searchable.
Boolean	isSortEnabled() Whether the field can be used to sort the search results.
void	setDefaultValue(String defaultValue) A value to use for the field if the field isn't specified for a document.
void	setFacetEnabled(Boolean facetEnabled) Whether facet information can be returned for the field.
void	setReturnEnabled(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.
void	setSearchEnabled(Boolean searchEnabled) Whether the contents of the field are searchable.
void	setSortEnabled(Boolean sortEnabled) Whether the field can be used to sort the search results.
void	setSourceField(String sourceField) A string that represents the name of an index field.
String	toString() Returns a string representation of this object; useful for testing and debugging.
LiteralOptions	withDefaultValue(String defaultValue) A value to use for the field if the field isn't specified for a document.
LiteralOptions	withFacetEnabled(Boolean facetEnabled) Whether facet information can be returned for the field.
LiteralOptions	withReturnEnabled(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.
LiteralOptions	withSearchEnabled(Boolean searchEnabled) Whether the contents of the field are searchable.
LiteralOptions	withSortEnabled(Boolean sortEnabled) Whether the field can be used to sort the search results.
LiteralOptions	withSourceField(String sourceField) A string that represents the name of an index field.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LiteralOptions

public LiteralOptions()

Method Detail

getDefaultValue

public String getDefaultValue()

A value to use for the field if the field isn't specified for a document.

Constraints:
Length: 0 - 1024

Returns:

A value to use for the field if the field isn't specified for a document.

setDefaultValue

public void setDefaultValue(String defaultValue)

A value to use for the field if the field isn't specified for a document.

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - A value to use for the field if the field isn't specified for a document.

withDefaultValue

public LiteralOptions withDefaultValue(String defaultValue)

A value to use for the field if the field isn't specified for a document.

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

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - A value to use for the field if the field isn't specified for a document.

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceField

public String getSourceField()

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Returns:

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

setSourceField

public void setSourceField(String sourceField)

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

sourceField - A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

withSourceField

public LiteralOptions withSourceField(String sourceField)

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

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

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

sourceField - A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Returns:

A reference to this updated object so that method calls can be chained together.

isFacetEnabled

public Boolean isFacetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

setFacetEnabled

public void setFacetEnabled(Boolean facetEnabled)

Whether facet information can be returned for the field.

Parameters:

facetEnabled - Whether facet information can be returned for the field.

withFacetEnabled

public LiteralOptions withFacetEnabled(Boolean facetEnabled)

Whether facet information can be returned for the field.

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

Parameters:

facetEnabled - Whether facet information can be returned for the field.

Returns:

A reference to this updated object so that method calls can be chained together.

getFacetEnabled

public Boolean getFacetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

isSearchEnabled

public Boolean isSearchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

setSearchEnabled

public void setSearchEnabled(Boolean searchEnabled)

Whether the contents of the field are searchable.

Parameters:

searchEnabled - Whether the contents of the field are searchable.

withSearchEnabled

public LiteralOptions withSearchEnabled(Boolean searchEnabled)

Whether the contents of the field are searchable.

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

Parameters:

searchEnabled - Whether the contents of the field are searchable.

Returns:

A reference to this updated object so that method calls can be chained together.

getSearchEnabled

public Boolean getSearchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

isReturnEnabled

public Boolean isReturnEnabled()

Whether the contents of the field can be returned in the search results.

Returns:

Whether the contents of the field can be returned in the search results.

setReturnEnabled

public void setReturnEnabled(Boolean returnEnabled)

Whether the contents of the field can be returned in the search results.

Parameters:

returnEnabled - Whether the contents of the field can be returned in the search results.

withReturnEnabled

public LiteralOptions withReturnEnabled(Boolean returnEnabled)

Whether the contents of the field can be returned in the search results.

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

Parameters:

returnEnabled - Whether the contents of the field can be returned in the search results.

Returns:

A reference to this updated object so that method calls can be chained together.

getReturnEnabled

public Boolean getReturnEnabled()

Whether the contents of the field can be returned in the search results.

Returns:

Whether the contents of the field can be returned in the search results.

isSortEnabled

public Boolean isSortEnabled()

Whether the field can be used to sort the search results.

Returns:

Whether the field can be used to sort the search results.

setSortEnabled

public void setSortEnabled(Boolean sortEnabled)

Whether the field can be used to sort the search results.

Parameters:

sortEnabled - Whether the field can be used to sort the search results.

withSortEnabled

public LiteralOptions withSortEnabled(Boolean sortEnabled)

Whether the field can be used to sort the search results.

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

Parameters:

sortEnabled - Whether the field can be used to sort the search results.

Returns:

A reference to this updated object so that method calls can be chained together.

getSortEnabled

public Boolean getSortEnabled()

Whether the field can be used to sort the search results.

Returns:

Whether the field can be used to sort the search results.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public LiteralOptions clone()

Overrides:

clone in class Object