com.amazonaws.services.cloudsearchv2.model

Class DefineIndexFieldRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchv2.model.DefineIndexFieldRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DefineIndexFieldRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DefineIndexField operation.

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType . If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide .

See Also:

AmazonCloudSearch.defineIndexField(DefineIndexFieldRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DefineIndexFieldRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DefineIndexFieldRequest	clone()
boolean	equals(Object obj)
String	getDomainName() A string that represents the name of a domain.
IndexField	getIndexField() The index field and field options you want to configure.
int	hashCode()
void	setDomainName(String domainName) A string that represents the name of a domain.
void	setIndexField(IndexField indexField) The index field and field options you want to configure.
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) The index field and field options you want to configure.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, 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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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

Returns:

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

setDomainName

public void setDomainName(String domainName)

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

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

Parameters:

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

withDomainName

public DefineIndexFieldRequest withDomainName(String domainName)

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

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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:

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

getIndexField

public IndexField getIndexField()

The index field and field options you want to configure.

Returns:

The index field and field options you want to configure.

setIndexField

public void setIndexField(IndexField indexField)

The index field and field options you want to configure.

Parameters:

indexField - The index field and field options you want to configure.

withIndexField

public DefineIndexFieldRequest withIndexField(IndexField indexField)

The index field and field options you want to configure.

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

Parameters:

indexField - The index field and field options you want to configure.

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

clone

public DefineIndexFieldRequest clone()

Overrides:

clone in class AmazonWebServiceRequest