com.amazonaws.services.cloudsearch.model

Class UpdateDefaultSearchFieldRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearch.model.UpdateDefaultSearchFieldRequest

All Implemented Interfaces:

Serializable

public class UpdateDefaultSearchFieldRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateDefaultSearchField operation.

Configures the default search field for the search domain. The default search field is used when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.

See Also:

AmazonCloudSearch.updateDefaultSearchField(UpdateDefaultSearchFieldRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateDefaultSearchFieldRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDefaultSearchField() The IndexField to use for search requests issued with the q parameter.
String	getDomainName() A string that represents the name of a domain.
int	hashCode()
void	setDefaultSearchField(String defaultSearchField) The IndexField to use for search requests issued with the q parameter.
void	setDomainName(String domainName) A string that represents the name of a domain.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateDefaultSearchFieldRequest	withDefaultSearchField(String defaultSearchField) The IndexField to use for search requests issued with the q parameter.
UpdateDefaultSearchFieldRequest	withDomainName(String domainName) A string that represents the name of a domain.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateDefaultSearchFieldRequest

public UpdateDefaultSearchFieldRequest()

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

getDefaultSearchField

public String getDefaultSearchField()

The IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.

Returns:

The IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.

setDefaultSearchField

public void setDefaultSearchField(String defaultSearchField)

The IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.

Parameters:

defaultSearchField - The IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.

withDefaultSearchField

public UpdateDefaultSearchFieldRequest withDefaultSearchField(String defaultSearchField)

The IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.

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

Parameters:

defaultSearchField - The IndexField to use for search requests issued with the q parameter. The default is an empty string, which automatically searches all text fields.

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