com.recombee.api_client.api_requests.AddManualReqlSegment 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;

/**
 * Adds a new Segment into a Manual ReQL Segmentation.
 * The new Segment is defined by a [ReQL](https://docs.recombee.com/reql.html) filter that returns `true` for an item in case that this item belongs to the segment.
 */
public class AddManualReqlSegment extends Request {

    /**
     * ID of the Segmentation to which the new Segment should be added
     */
    protected String segmentationId;
    /**
     * ID of the newly created Segment
     */
    protected String segmentId;
    /**
     * ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
     */
    protected String filter;
    /**
     * Human-readable name of the Segment that is shown in the Recombee Admin UI.
     */
    protected String title;

    /**
     * Construct the request
     * @param segmentationId ID of the Segmentation to which the new Segment should be added
     * @param segmentId ID of the newly created Segment
     * @param filter ReQL filter that returns `true` for items that belong to this Segment. Otherwise returns `false`.
     */
    public AddManualReqlSegment (String segmentationId,String segmentId,String filter) {
        this.segmentationId = segmentationId;
        this.segmentId = segmentId;
        this.filter = filter;
        this.timeout = 10000;
    }

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

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

    public String getSegmentId() {
         return this.segmentId;
    }

    public String getFilter() {
         return this.filter;
    }

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

    /**
     * @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/manual-reql/%s/segments/%s", this.segmentationId,this.segmentId);
    }

    /**
     * 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("filter", this.filter);
        if (this.title!=null) {
            params.put("title", this.title);
        }
        return params;
    }

}