com.recombee.api_client.api_requests.CreatePropertyBasedSegmentation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-client Show documentation
A client library for easy use of the Recombee recommendation API
The newest version!
package com.recombee.api_client.api_requests;

/*
 This file is auto-generated, do not edit
*/

import java.util.Date;
import java.util.Map;
import java.util.HashMap;

import com.recombee.api_client.bindings.Logic;
import com.recombee.api_client.util.HTTPMethod;

/**
 * Creates a Segmentation that splits the items into segments based on values of a particular item property.
 * A segment is created for each unique value of the property.
 * In case of `set` properties, a segment is created for each value in the set. Item belongs to all these segments.
 */
public class CreatePropertyBasedSegmentation extends Request {

    /**
     * ID of the newly created Segmentation
     */
    protected String segmentationId;
    /**
     * What type of data should be segmented. Currently only `items` are supported.
     */
    protected String sourceType;
    /**
     * Name of the property on which the Segmentation should be based
     */
    protected String propertyName;
    /**
     * Human-readable name that is shown in the Recombee Admin UI.
     */
    protected String title;
    /**
     * Description that is shown in the Recombee Admin UI.
     */
    protected String description;

    /**
     * Construct the request
     * @param segmentationId ID of the newly created Segmentation
     * @param sourceType What type of data should be segmented. Currently only `items` are supported.
     * @param propertyName Name of the property on which the Segmentation should be based
     */
    public CreatePropertyBasedSegmentation (String segmentationId,String sourceType,String propertyName) {
        this.segmentationId = segmentationId;
        this.sourceType = sourceType;
        this.propertyName = propertyName;
        this.timeout = 10000;
    }

    /**
     * @param title Human-readable name that is shown in the Recombee Admin UI.
     */
    public CreatePropertyBasedSegmentation setTitle(String title) {
         this.title = title;
         return this;
    }

    /**
     * @param description Description that is shown in the Recombee Admin UI.
     */
    public CreatePropertyBasedSegmentation setDescription(String description) {
         this.description = description;
         return this;
    }

    public String getSegmentationId() {
         return this.segmentationId;
    }

    public String getSourceType() {
         return this.sourceType;
    }

    public String getPropertyName() {
         return this.propertyName;
    }

    public String getTitle() {
         return this.title;
    }

    public String getDescription() {
         return this.description;
    }

    /**
     * @return Used HTTP method
     */
    @Override
    public HTTPMethod getHTTPMethod() {
        return HTTPMethod.PUT;
    }

    /**
     * @return URI to the endpoint including path parameters
     */
    @Override
    public String getPath() {
        return String.format("/segmentations/property-based/%s", this.segmentationId);
    }

    /**
     * Get query parameters
     * @return Values of query parameters (name of parameter: value of the parameter)
     */
    @Override
    public Map getQueryParameters() {
        HashMap params = new HashMap();
        return params;
    }

    /**
     * Get body parameters
     * @return Values of body parameters (name of parameter: value of the parameter)
     */
    @Override
    public Map getBodyParameters() {
        HashMap params = new HashMap();
        params.put("sourceType", this.sourceType);
        params.put("propertyName", this.propertyName);
        if (this.title!=null) {
            params.put("title", this.title);
        }
        if (this.description!=null) {
            params.put("description", this.description);
        }
        return params;
    }

}