com.softlayer.api.service.container.search.Result Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
There is a newer version: 0.3.4
package com.softlayer.api.service.container.search;

import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Entity;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;

/**
 * The SoftLayer_Container_Search_Result data type represents a result row from an execution of Search service. 
 *
 * @see SoftLayer_Container_Search_Result
 */
@ApiType("SoftLayer_Container_Search_Result")
public class Result extends Entity {

    /**
     * An array of terms that were matched in the resource object.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected List matchedTerms;

    public List getMatchedTerms() {
        if (matchedTerms == null) {
            matchedTerms = new ArrayList();
        }
        return matchedTerms;
    }

    protected boolean matchedTermsSpecified;

    public boolean isMatchedTermsSpecified() {
        return matchedTermsSpecified;
    }

    public void unsetMatchedTerms() {
        matchedTerms = null;
        matchedTermsSpecified = false;
    }

    /**
     * The score ratio of the result for relevance to the search criteria.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected BigDecimal relevanceScore;

    public BigDecimal getRelevanceScore() {
        return relevanceScore;
    }

    public void setRelevanceScore(BigDecimal relevanceScore) {
        relevanceScoreSpecified = true;
        this.relevanceScore = relevanceScore;
    }

    protected boolean relevanceScoreSpecified;

    public boolean isRelevanceScoreSpecified() {
        return relevanceScoreSpecified;
    }

    public void unsetRelevanceScore() {
        relevanceScore = null;
        relevanceScoreSpecified = false;
    }

    /**
     * A search results resource object that matched search criteria.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected Entity resource;

    public Entity getResource() {
        return resource;
    }

    public void setResource(Entity resource) {
        resourceSpecified = true;
        this.resource = resource;
    }

    protected boolean resourceSpecified;

    public boolean isResourceSpecified() {
        return resourceSpecified;
    }

    public void unsetResource() {
        resource = null;
        resourceSpecified = false;
    }

    /**
     * The type of the resource object that matched search criteria.
     */
    @ApiProperty(canBeNullOrNotSet = true)
    protected String resourceType;

    public String getResourceType() {
        return resourceType;
    }

    public void setResourceType(String resourceType) {
        resourceTypeSpecified = true;
        this.resourceType = resourceType;
    }

    protected boolean resourceTypeSpecified;

    public boolean isResourceTypeSpecified() {
        return resourceTypeSpecified;
    }

    public void unsetResourceType() {
        resourceType = null;
        resourceTypeSpecified = false;
    }

    public static class Mask extends com.softlayer.api.service.Entity.Mask {

        public Mask matchedTerms() {
            withLocalProperty("matchedTerms");
            return this;
        }

        public Mask relevanceScore() {
            withLocalProperty("relevanceScore");
            return this;
        }

        public com.softlayer.api.service.Entity.Mask resource() {
            return withSubMask("resource", com.softlayer.api.service.Entity.Mask.class);
        }

        public Mask resourceType() {
            withLocalProperty("resourceType");
            return this;
        }

    }

}