Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.cloudsearchv2.model
Class IndexField

java.lang.Object
  extended by com.amazonaws.services.cloudsearchv2.model.IndexField
All Implemented Interfaces:
Serializable
public class IndexField
extends Object
implements Serializable

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType .

See Also:
Serialized Form

Constructor Summary
IndexField()
           
 
Method Summary
 boolean equals(Object obj)
           
 DateArrayOptions getDateArrayOptions()
          Options for a field that contains an array of dates.
 DateOptions getDateOptions()
          Options for a date field.
 DoubleArrayOptions getDoubleArrayOptions()
          Options for a field that contains an array of double-precision 64-bit floating point values.
 DoubleOptions getDoubleOptions()
          Options for a double-precision 64-bit floating point field.
 String getIndexFieldName()
          The name of a field in the search index.
 String getIndexFieldType()
          The type of field.
 IntArrayOptions getIntArrayOptions()
          Options for a field that contains an array of 64-bit signed integers.
 IntOptions getIntOptions()
          Options for a 64-bit signed integer field.
 LatLonOptions getLatLonOptions()
          Options for a latlon field.
 LiteralArrayOptions getLiteralArrayOptions()
          Options for a field that contains an array of literal strings.
 LiteralOptions getLiteralOptions()
          Options for literal field.
 TextArrayOptions getTextArrayOptions()
          Options for a field that contains an array of text strings.
 TextOptions getTextOptions()
          Options for text field.
 int hashCode()
           
 void setDateArrayOptions(DateArrayOptions dateArrayOptions)
          Options for a field that contains an array of dates.
 void setDateOptions(DateOptions dateOptions)
          Options for a date field.
 void setDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
          Options for a field that contains an array of double-precision 64-bit floating point values.
 void setDoubleOptions(DoubleOptions doubleOptions)
          Options for a double-precision 64-bit floating point field.
 void setIndexFieldName(String indexFieldName)
          The name of a field in the search index.
 void setIndexFieldType(IndexFieldType indexFieldType)
          The type of field.
 void setIndexFieldType(String indexFieldType)
          The type of field.
 void setIntArrayOptions(IntArrayOptions intArrayOptions)
          Options for a field that contains an array of 64-bit signed integers.
 void setIntOptions(IntOptions intOptions)
          Options for a 64-bit signed integer field.
 void setLatLonOptions(LatLonOptions latLonOptions)
          Options for a latlon field.
 void setLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
          Options for a field that contains an array of literal strings.
 void setLiteralOptions(LiteralOptions literalOptions)
          Options for literal field.
 void setTextArrayOptions(TextArrayOptions textArrayOptions)
          Options for a field that contains an array of text strings.
 void setTextOptions(TextOptions textOptions)
          Options for text field.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 IndexField withDateArrayOptions(DateArrayOptions dateArrayOptions)
          Options for a field that contains an array of dates.
 IndexField withDateOptions(DateOptions dateOptions)
          Options for a date field.
 IndexField withDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
          Options for a field that contains an array of double-precision 64-bit floating point values.
 IndexField withDoubleOptions(DoubleOptions doubleOptions)
          Options for a double-precision 64-bit floating point field.
 IndexField withIndexFieldName(String indexFieldName)
          The name of a field in the search index.
 IndexField withIndexFieldType(IndexFieldType indexFieldType)
          The type of field.
 IndexField withIndexFieldType(String indexFieldType)
          The type of field.
 IndexField withIntArrayOptions(IntArrayOptions intArrayOptions)
          Options for a field that contains an array of 64-bit signed integers.
 IndexField withIntOptions(IntOptions intOptions)
          Options for a 64-bit signed integer field.
 IndexField withLatLonOptions(LatLonOptions latLonOptions)
          Options for a latlon field.
 IndexField withLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
          Options for a field that contains an array of literal strings.
 IndexField withLiteralOptions(LiteralOptions literalOptions)
          Options for literal field.
 IndexField withTextArrayOptions(TextArrayOptions textArrayOptions)
          Options for a field that contains an array of text strings.
 IndexField withTextOptions(TextOptions textOptions)
          Options for text field.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IndexField

public IndexField()
Method Detail

getIndexFieldName

public String getIndexFieldName()
The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name "score" is reserved and cannot be specified as field or expression name.

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

Returns:
The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name "score" is reserved and cannot be specified as field or expression name.

setIndexFieldName

public void setIndexFieldName(String indexFieldName)
The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name "score" is reserved and cannot be specified as field or expression name.

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

Parameters:
indexFieldName - The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name "score" is reserved and cannot be specified as field or expression name.

withIndexFieldName

public IndexField withIndexFieldName(String indexFieldName)
The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name "score" is reserved and cannot be specified as field or expression name.

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:
indexFieldName - The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The name "score" is reserved and cannot be specified as field or expression name.
Returns:
A reference to this updated object so that method calls can be chained together.

getIndexFieldType

public String getIndexFieldType()
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array

Returns:
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
See Also:
IndexFieldType

setIndexFieldType

public void setIndexFieldType(String indexFieldType)
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array

Parameters:
indexFieldType - The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
See Also:
IndexFieldType

withIndexFieldType

public IndexField withIndexFieldType(String indexFieldType)
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

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

Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array

Parameters:
indexFieldType - The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
IndexFieldType

setIndexFieldType

public void setIndexFieldType(IndexFieldType indexFieldType)
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array

Parameters:
indexFieldType - The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
See Also:
IndexFieldType

withIndexFieldType

public IndexField withIndexFieldType(IndexFieldType indexFieldType)
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

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

Constraints:
Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array

Parameters:
indexFieldType - The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Returns:
A reference to this updated object so that method calls can be chained together.
See Also:
IndexFieldType

getIntOptions

public IntOptions getIntOptions()
Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

Returns:
Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

setIntOptions

public void setIntOptions(IntOptions intOptions)
Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

Parameters:
intOptions - Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

withIntOptions

public IndexField withIntOptions(IntOptions intOptions)
Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

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

Parameters:
intOptions - Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getDoubleOptions

public DoubleOptions getDoubleOptions()
Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

Returns:
Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

setDoubleOptions

public void setDoubleOptions(DoubleOptions doubleOptions)
Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

Parameters:
doubleOptions - Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

withDoubleOptions

public IndexField withDoubleOptions(DoubleOptions doubleOptions)
Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

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

Parameters:
doubleOptions - Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getLiteralOptions

public LiteralOptions getLiteralOptions()
Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

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

setLiteralOptions

public void setLiteralOptions(LiteralOptions literalOptions)
Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

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

withLiteralOptions

public IndexField withLiteralOptions(LiteralOptions literalOptions)
Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

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

Parameters:
literalOptions - Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getTextOptions

public TextOptions getTextOptions()
Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

Returns:
Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

setTextOptions

public void setTextOptions(TextOptions textOptions)
Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

Parameters:
textOptions - Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

withTextOptions

public IndexField withTextOptions(TextOptions textOptions)
Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

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

Parameters:
textOptions - Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getDateOptions

public DateOptions getDateOptions()
Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

Returns:
Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

setDateOptions

public void setDateOptions(DateOptions dateOptions)
Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

Parameters:
dateOptions - Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

withDateOptions

public IndexField withDateOptions(DateOptions dateOptions)
Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

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

Parameters:
dateOptions - Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getLatLonOptions

public LatLonOptions getLatLonOptions()
Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

Returns:
Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

setLatLonOptions

public void setLatLonOptions(LatLonOptions latLonOptions)
Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

Parameters:
latLonOptions - Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

withLatLonOptions

public IndexField withLatLonOptions(LatLonOptions latLonOptions)
Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

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

Parameters:
latLonOptions - Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getIntArrayOptions

public IntArrayOptions getIntArrayOptions()
Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

Returns:
Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

setIntArrayOptions

public void setIntArrayOptions(IntArrayOptions intArrayOptions)
Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

Parameters:
intArrayOptions - Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

withIntArrayOptions

public IndexField withIntArrayOptions(IntArrayOptions intArrayOptions)
Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

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

Parameters:
intArrayOptions - Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getDoubleArrayOptions

public DoubleArrayOptions getDoubleArrayOptions()
Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

Returns:
Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

setDoubleArrayOptions

public void setDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

Parameters:
doubleArrayOptions - Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

withDoubleArrayOptions

public IndexField withDoubleArrayOptions(DoubleArrayOptions doubleArrayOptions)
Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

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

Parameters:
doubleArrayOptions - Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getLiteralArrayOptions

public LiteralArrayOptions getLiteralArrayOptions()
Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

Returns:
Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

setLiteralArrayOptions

public void setLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

Parameters:
literalArrayOptions - Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

withLiteralArrayOptions

public IndexField withLiteralArrayOptions(LiteralArrayOptions literalArrayOptions)
Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

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

Parameters:
literalArrayOptions - Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getTextArrayOptions

public TextArrayOptions getTextArrayOptions()
Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

Returns:
Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

setTextArrayOptions

public void setTextArrayOptions(TextArrayOptions textArrayOptions)
Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

Parameters:
textArrayOptions - Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

withTextArrayOptions

public IndexField withTextArrayOptions(TextArrayOptions textArrayOptions)
Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

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

Parameters:
textArrayOptions - Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

getDateArrayOptions

public DateArrayOptions getDateArrayOptions()
Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

Returns:
Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

setDateArrayOptions

public void setDateArrayOptions(DateArrayOptions dateArrayOptions)
Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

Parameters:
dateArrayOptions - Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

withDateArrayOptions

public IndexField withDateArrayOptions(DateArrayOptions dateArrayOptions)
Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

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

Parameters:
dateArrayOptions - Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.
Returns:
A reference to this updated object so that method calls can be chained together.

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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2016. All rights reserved.