com.amazonaws.services.cloudsearch.model

## クラス IndexField

- java.lang.Object
- - com.amazonaws.services.cloudsearch.model.IndexField

- すべての実装されたインタフェース:
    java.io.Serializable

      public class IndexField
      extends java.lang.Object
      implements java.io.Serializable

  Defines a field in the index, including its name, type, and the source of its data. The `IndexFieldType` indicates which of the options will be present. It is invalid to specify options for a type other than the `IndexFieldType` .

  関連項目:
    直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `IndexField()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getIndexFieldName()` The name of a field in the search index.
    `java.lang.String` | `getIndexFieldType()` The type of field.
    `LiteralOptions` | `getLiteralOptions()` Options for literal field.
    `java.util.List<SourceAttribute>` | `getSourceAttributes()` An optional list of source attributes that provide data for this index field.
    `TextOptions` | `getTextOptions()` Options for text field.
    `UIntOptions` | `getUIntOptions()` Options for an unsigned integer field.
    `int` | `hashCode()`
    `void` | `setIndexFieldName(java.lang.String indexFieldName)` The name of a field in the search index.
    `void` | `setIndexFieldType(IndexFieldType indexFieldType)` The type of field.
    `void` | `setIndexFieldType(java.lang.String indexFieldType)` The type of field.
    `void` | `setLiteralOptions(LiteralOptions literalOptions)` Options for literal field.
    `void` | `setSourceAttributes(java.util.Collection<SourceAttribute> sourceAttributes)` An optional list of source attributes that provide data for this index field.
    `void` | `setTextOptions(TextOptions textOptions)` Options for text field.
    `void` | `setUIntOptions(UIntOptions uIntOptions)` Options for an unsigned integer field.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `IndexField` | `withIndexFieldName(java.lang.String indexFieldName)` The name of a field in the search index.
    `IndexField` | `withIndexFieldType(IndexFieldType indexFieldType)` The type of field.
    `IndexField` | `withIndexFieldType(java.lang.String indexFieldType)` The type of field.
    `IndexField` | `withLiteralOptions(LiteralOptions literalOptions)` Options for literal field.
    `IndexField` | `withSourceAttributes(java.util.Collection<SourceAttribute> sourceAttributes)` An optional list of source attributes that provide data for this index field.
    `IndexField` | `withSourceAttributes(SourceAttribute... sourceAttributes)` An optional list of source attributes that provide data for this index field.
    `IndexField` | `withTextOptions(TextOptions textOptions)` Options for text field.
    `IndexField` | `withUIntOptions(UIntOptions uIntOptions)` Options for an unsigned integer field.

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### IndexField

          public IndexField()

  - ### メソッドの詳細

    - #### getIndexFieldName

          public java.lang.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 names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

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

      戻り値:
        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 names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

    - #### setIndexFieldName

          public void setIndexFieldName(java.lang.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 names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

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

      パラメータ:
        `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 names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

    - #### withIndexFieldName

          public IndexField withIndexFieldName(java.lang.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 names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

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

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

      パラメータ:
        `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 names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.

    - #### getIndexFieldType

          public java.lang.String getIndexFieldType()

      The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

      Constraints:
      Allowed Values: uint, literal, text

      戻り値:
        The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
      関連項目:
        `IndexFieldType`

    - #### setIndexFieldType

          public void setIndexFieldType(java.lang.String indexFieldType)

      The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

      Constraints:
      Allowed Values: uint, literal, text

      パラメータ:
        `indexFieldType` - The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
      関連項目:
        `IndexFieldType`

    - #### withIndexFieldType

          public IndexField withIndexFieldType(java.lang.String indexFieldType)

      The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

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

      Constraints:
      Allowed Values: uint, literal, text

      パラメータ:
        `indexFieldType` - The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
      関連項目:
        `IndexFieldType`

    - #### setIndexFieldType

          public void setIndexFieldType(IndexFieldType indexFieldType)

      The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

      Constraints:
      Allowed Values: uint, literal, text

      パラメータ:
        `indexFieldType` - The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
      関連項目:
        `IndexFieldType`

    - #### withIndexFieldType

          public IndexField withIndexFieldType(IndexFieldType indexFieldType)

      The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

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

      Constraints:
      Allowed Values: uint, literal, text

      パラメータ:
        `indexFieldType` - The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
      関連項目:
        `IndexFieldType`

    - #### getUIntOptions

          public UIntOptions getUIntOptions()

      Options for an unsigned integer field. Present if `IndexFieldType` specifies the field is of type unsigned integer.
      戻り値:
        Options for an unsigned integer field. Present if `IndexFieldType` specifies the field is of type unsigned integer.

    - #### setUIntOptions

          public void setUIntOptions(UIntOptions uIntOptions)

      Options for an unsigned integer field. Present if `IndexFieldType` specifies the field is of type unsigned integer.
      パラメータ:
        `uIntOptions` - Options for an unsigned integer field. Present if `IndexFieldType` specifies the field is of type unsigned integer.

    - #### withUIntOptions

          public IndexField withUIntOptions(UIntOptions uIntOptions)

      Options for an unsigned integer field. Present if `IndexFieldType` specifies the field is of type unsigned integer.

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

      パラメータ:
        `uIntOptions` - Options for an unsigned integer field. Present if `IndexFieldType` specifies the field is of type unsigned integer.

    - #### getLiteralOptions

          public LiteralOptions getLiteralOptions()

      Options for literal field. Present if `IndexFieldType` specifies the field is of type literal.
      戻り値:
        Options for literal field. Present if `IndexFieldType` specifies the field is of type literal.

    - #### setLiteralOptions

          public void setLiteralOptions(LiteralOptions literalOptions)

      Options for literal field. Present if `IndexFieldType` specifies the field is of type literal.
      パラメータ:
        `literalOptions` - Options for literal field. Present if `IndexFieldType` specifies the field is of type literal.

    - #### withLiteralOptions

          public IndexField withLiteralOptions(LiteralOptions literalOptions)

      Options for literal field. Present if `IndexFieldType` specifies the field is of type literal.

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

      パラメータ:
        `literalOptions` - Options for literal field. Present if `IndexFieldType` specifies the field is of type literal.

    - #### getTextOptions

          public TextOptions getTextOptions()

      Options for text field. Present if `IndexFieldType` specifies the field is of type text.
      戻り値:
        Options for text field. Present if `IndexFieldType` specifies the field is of type text.

    - #### setTextOptions

          public void setTextOptions(TextOptions textOptions)

      Options for text field. Present if `IndexFieldType` specifies the field is of type text.
      パラメータ:
        `textOptions` - Options for text field. Present if `IndexFieldType` specifies the field is of type text.

    - #### withTextOptions

          public IndexField withTextOptions(TextOptions textOptions)

      Options for text field. Present if `IndexFieldType` specifies the field is of type text.

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

      パラメータ:
        `textOptions` - Options for text field. Present if `IndexFieldType` specifies the field is of type text.

    - #### getSourceAttributes

          public java.util.List<SourceAttribute> getSourceAttributes()

      An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this `IndexField`. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an `IndexField`.
      戻り値:
        An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this `IndexField`. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an `IndexField`.

    - #### setSourceAttributes

          public void setSourceAttributes(java.util.Collection<SourceAttribute> sourceAttributes)

      An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this `IndexField`. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an `IndexField`.
      パラメータ:
        `sourceAttributes` - An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this `IndexField`. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an `IndexField`.

    - #### withSourceAttributes

          public IndexField withSourceAttributes(SourceAttribute... sourceAttributes)

      An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this `IndexField`. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an `IndexField`.

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

      パラメータ:
        `sourceAttributes` - An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this `IndexField`. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an `IndexField`.

    - #### withSourceAttributes

          public IndexField withSourceAttributes(java.util.Collection<SourceAttribute> sourceAttributes)

      An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this `IndexField`. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an `IndexField`.

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

      パラメータ:
        `sourceAttributes` - An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this `IndexField`. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an `IndexField`.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`