com.amazonaws.services.cloudsearch.model

Class DefineIndexFieldRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearch.model.DefineIndexFieldRequest

All Implemented Interfaces:

Serializable

public class DefineIndexFieldRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DefineIndexField operation.

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.

See Also:

AmazonCloudSearch.defineIndexField(DefineIndexFieldRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefineIndexFieldRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDomainName() A string that represents the name of a domain.
IndexField	getIndexField() Defines a field in the index, including its name, type, and the source of its data.
int	hashCode()
void	setDomainName(String domainName) A string that represents the name of a domain.
void	setIndexField(IndexField indexField) Defines a field in the index, including its name, type, and the source of its data.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DefineIndexFieldRequest	withDomainName(String domainName) A string that represents the name of a domain.
DefineIndexFieldRequest	withIndexField(IndexField indexField) Defines a field in the index, including its name, type, and the source of its data.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefineIndexFieldRequest

public DefineIndexFieldRequest()

Method Detail

getDomainName

public 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\-]+

Returns:

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(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\-]+

Parameters:

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 DefineIndexFieldRequest withDomainName(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\-]+

Parameters:

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 updated object so that method calls can be chained together.

getIndexField

public IndexField getIndexField()

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.

Returns:

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.

setIndexField

public void setIndexField(IndexField indexField)

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.

Parameters:

indexField - 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.

withIndexField

public DefineIndexFieldRequest withIndexField(IndexField indexField)

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.

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

Parameters:

indexField - 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.

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