com.amazonaws.services.cloudsearch.model

## クラス UpdateSynonymOptionsRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.cloudsearch.model.UpdateSynonymOptionsRequest

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

      public class UpdateSynonymOptionsRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `UpdateSynonymOptions operation`.

  Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100KB.

  関連項目:
    `AmazonCloudSearch.updateSynonymOptions(UpdateSynonymOptionsRequest)`, 直列化された形式

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getDomainName()` A string that represents the name of a domain.
    `java.lang.String` | `getSynonyms()` Maps terms to their synonyms, serialized as a JSON document.
    `int` | `hashCode()`
    `void` | `setDomainName(java.lang.String domainName)` A string that represents the name of a domain.
    `void` | `setSynonyms(java.lang.String synonyms)` Maps terms to their synonyms, serialized as a JSON document.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `UpdateSynonymOptionsRequest` | `withDomainName(java.lang.String domainName)` A string that represents the name of a domain.
    `UpdateSynonymOptionsRequest` | `withSynonyms(java.lang.String synonyms)` Maps terms to their synonyms, serialized as a JSON document.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### UpdateSynonymOptionsRequest

          public UpdateSynonymOptionsRequest()

  - ### メソッドの詳細

    - #### getDomainName

          public java.lang.String getDomainName()

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+

      戻り値:
        A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    - #### setDomainName

          public void setDomainName(java.lang.String domainName)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+

      パラメータ:
        `domainName` - A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    - #### withDomainName

          public UpdateSynonymOptionsRequest withDomainName(java.lang.String domainName)

      A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

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

      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+

      パラメータ:
        `domainName` - A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

    - #### getSynonyms

          public java.lang.String getSynonyms()

      Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100KB. Example: `{ "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }`
      戻り値:
        Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100KB. Example: `{ "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }`

    - #### setSynonyms

          public void setSynonyms(java.lang.String synonyms)

      Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100KB. Example: `{ "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }`
      パラメータ:
        `synonyms` - Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100KB. Example: `{ "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }`

    - #### withSynonyms

          public UpdateSynonymOptionsRequest withSynonyms(java.lang.String synonyms)

      Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100KB. Example: `{ "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }`

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

      パラメータ:
        `synonyms` - Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100KB. Example: `{ "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }`

    - #### 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`