Package com.softlayer.api.service.container.search

Class Result

java.lang.Object

com.softlayer.api.Type

com.softlayer.api.service.Entity

com.softlayer.api.service.container.search.Result

@ApiType("SoftLayer_Container_Search_Result")
public class Result
extends Entity

The SoftLayer_Container_Search_Result data type represents a result row from an execution of Search service.

See Also:

SoftLayer_Container_Search_Result

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Result.Mask

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	matchedTerms	An array of terms that were matched in the resource object.
protected boolean	matchedTermsSpecified
protected BigDecimal	relevanceScore	The score ratio of the result for relevance to the search criteria.
protected boolean	relevanceScoreSpecified
protected Entity	resource	A search results resource object that matched search criteria.
protected boolean	resourceSpecified
protected String	resourceType	The type of the resource object that matched search criteria.
protected boolean	resourceTypeSpecified

Fields inherited from class com.softlayer.api.Type

unknownProperties

Constructor Summary

Constructors

Constructor	Description
Result()

Method Summary

Modifier and Type	Method	Description
List<String>	getMatchedTerms()
BigDecimal	getRelevanceScore()
Entity	getResource()
String	getResourceType()
boolean	isMatchedTermsSpecified()
boolean	isRelevanceScoreSpecified()
boolean	isResourceSpecified()
boolean	isResourceTypeSpecified()
void	setRelevanceScore(BigDecimal relevanceScore)
void	setResource(Entity resource)
void	setResourceType(String resourceType)
void	unsetMatchedTerms()
void	unsetRelevanceScore()
void	unsetResource()
void	unsetResourceType()

Methods inherited from class com.softlayer.api.Type

getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

matchedTerms

@ApiProperty(canBeNullOrNotSet=true)
protected List<String> matchedTerms

An array of terms that were matched in the resource object.

matchedTermsSpecified

protected boolean matchedTermsSpecified

relevanceScore

@ApiProperty(canBeNullOrNotSet=true)
protected BigDecimal relevanceScore

The score ratio of the result for relevance to the search criteria.

relevanceScoreSpecified

protected boolean relevanceScoreSpecified

resource

@ApiProperty(canBeNullOrNotSet=true)
protected Entity resource

A search results resource object that matched search criteria.

resourceSpecified

protected boolean resourceSpecified

resourceType

@ApiProperty(canBeNullOrNotSet=true)
protected String resourceType

The type of the resource object that matched search criteria.

resourceTypeSpecified

protected boolean resourceTypeSpecified

Constructor Detail

Result

public Result()

Method Detail

getMatchedTerms

public List<String> getMatchedTerms()

isMatchedTermsSpecified

public boolean isMatchedTermsSpecified()

unsetMatchedTerms

public void unsetMatchedTerms()

getRelevanceScore

public BigDecimal getRelevanceScore()

setRelevanceScore

public void setRelevanceScore(BigDecimal relevanceScore)

isRelevanceScoreSpecified

public boolean isRelevanceScoreSpecified()

unsetRelevanceScore

public void unsetRelevanceScore()

getResource

public Entity getResource()

setResource

public void setResource(Entity resource)

isResourceSpecified

public boolean isResourceSpecified()

unsetResource

public void unsetResource()

getResourceType

public String getResourceType()

setResourceType

public void setResourceType(String resourceType)

isResourceTypeSpecified

public boolean isResourceTypeSpecified()

unsetResourceType

public void unsetResourceType()