All Downloads are FREE. Search and download functionalities are using the official Maven repository.

gobblin.restli.throttling.PermitRequest Maven / Gradle / Ivy


package gobblin.restli.throttling;

import java.util.List;
import javax.annotation.Generated;
import com.linkedin.data.DataMap;
import com.linkedin.data.schema.PathSpec;
import com.linkedin.data.schema.RecordDataSchema;
import com.linkedin.data.template.DataTemplateUtil;
import com.linkedin.data.template.GetMode;
import com.linkedin.data.template.RecordTemplate;
import com.linkedin.data.template.SetMode;


/**
 * Used to request permits from a gobblin-throttling-service.
 * 
 */
@Generated(value = "com.linkedin.pegasus.generator.JavaCodeUtil", comments = "Rest.li Data Template. Generated from /Users/ibuenros/repos/gobblin/gobblin-restli/gobblin-throttling-service/gobblin-throttling-service-api/src/main/pegasus/gobblin/restli/throttling/PermitRequest.pdsc.", date = "Tue May 09 09:51:51 PDT 2017")
public class PermitRequest
    extends RecordTemplate
{

    private final static PermitRequest.Fields _fields = new PermitRequest.Fields();
    private final static RecordDataSchema SCHEMA = ((RecordDataSchema) DataTemplateUtil.parseSchema("{\"type\":\"record\",\"name\":\"PermitRequest\",\"namespace\":\"gobblin.restli.throttling\",\"doc\":\"Used to request permits from a gobblin-throttling-service.\",\"fields\":[{\"name\":\"resource\",\"type\":\"string\",\"doc\":\"Resource for which permits are needed.\"},{\"name\":\"permits\",\"type\":\"long\",\"doc\":\"Number of permits needed.\"},{\"name\":\"minPermits\",\"type\":\"long\",\"doc\":\"Minimum number of useful permits.\",\"optional\":true},{\"name\":\"requestorIdentifier\",\"type\":\"string\",\"doc\":\"Identifier of the service requesting the permits.\"}]}"));
    private final static RecordDataSchema.Field FIELD_Resource = SCHEMA.getField("resource");
    private final static RecordDataSchema.Field FIELD_Permits = SCHEMA.getField("permits");
    private final static RecordDataSchema.Field FIELD_MinPermits = SCHEMA.getField("minPermits");
    private final static RecordDataSchema.Field FIELD_RequestorIdentifier = SCHEMA.getField("requestorIdentifier");

    public PermitRequest() {
        super(new DataMap(), SCHEMA);
    }

    public PermitRequest(DataMap data) {
        super(data, SCHEMA);
    }

    public static PermitRequest.Fields fields() {
        return _fields;
    }

    /**
     * Existence checker for resource
     * 
     * @see Fields#resource
     */
    public boolean hasResource() {
        return contains(FIELD_Resource);
    }

    /**
     * Remover for resource
     * 
     * @see Fields#resource
     */
    public void removeResource() {
        remove(FIELD_Resource);
    }

    /**
     * Getter for resource
     * 
     * @see Fields#resource
     */
    public String getResource(GetMode mode) {
        return obtainDirect(FIELD_Resource, String.class, mode);
    }

    /**
     * Getter for resource
     * 
     * @see Fields#resource
     */
    public String getResource() {
        return getResource(GetMode.STRICT);
    }

    /**
     * Setter for resource
     * 
     * @see Fields#resource
     */
    public PermitRequest setResource(String value, SetMode mode) {
        putDirect(FIELD_Resource, String.class, String.class, value, mode);
        return this;
    }

    /**
     * Setter for resource
     * 
     * @see Fields#resource
     */
    public PermitRequest setResource(String value) {
        putDirect(FIELD_Resource, String.class, String.class, value, SetMode.DISALLOW_NULL);
        return this;
    }

    /**
     * Existence checker for permits
     * 
     * @see Fields#permits
     */
    public boolean hasPermits() {
        return contains(FIELD_Permits);
    }

    /**
     * Remover for permits
     * 
     * @see Fields#permits
     */
    public void removePermits() {
        remove(FIELD_Permits);
    }

    /**
     * Getter for permits
     * 
     * @see Fields#permits
     */
    public Long getPermits(GetMode mode) {
        return obtainDirect(FIELD_Permits, Long.class, mode);
    }

    /**
     * Getter for permits
     * 
     * @see Fields#permits
     */
    public Long getPermits() {
        return getPermits(GetMode.STRICT);
    }

    /**
     * Setter for permits
     * 
     * @see Fields#permits
     */
    public PermitRequest setPermits(Long value, SetMode mode) {
        putDirect(FIELD_Permits, Long.class, Long.class, value, mode);
        return this;
    }

    /**
     * Setter for permits
     * 
     * @see Fields#permits
     */
    public PermitRequest setPermits(Long value) {
        putDirect(FIELD_Permits, Long.class, Long.class, value, SetMode.DISALLOW_NULL);
        return this;
    }

    /**
     * Setter for permits
     * 
     * @see Fields#permits
     */
    public PermitRequest setPermits(long value) {
        putDirect(FIELD_Permits, Long.class, Long.class, value, SetMode.DISALLOW_NULL);
        return this;
    }

    /**
     * Existence checker for minPermits
     * 
     * @see Fields#minPermits
     */
    public boolean hasMinPermits() {
        return contains(FIELD_MinPermits);
    }

    /**
     * Remover for minPermits
     * 
     * @see Fields#minPermits
     */
    public void removeMinPermits() {
        remove(FIELD_MinPermits);
    }

    /**
     * Getter for minPermits
     * 
     * @see Fields#minPermits
     */
    public Long getMinPermits(GetMode mode) {
        return obtainDirect(FIELD_MinPermits, Long.class, mode);
    }

    /**
     * Getter for minPermits
     * 
     * @see Fields#minPermits
     */
    public Long getMinPermits() {
        return getMinPermits(GetMode.STRICT);
    }

    /**
     * Setter for minPermits
     * 
     * @see Fields#minPermits
     */
    public PermitRequest setMinPermits(Long value, SetMode mode) {
        putDirect(FIELD_MinPermits, Long.class, Long.class, value, mode);
        return this;
    }

    /**
     * Setter for minPermits
     * 
     * @see Fields#minPermits
     */
    public PermitRequest setMinPermits(Long value) {
        putDirect(FIELD_MinPermits, Long.class, Long.class, value, SetMode.DISALLOW_NULL);
        return this;
    }

    /**
     * Setter for minPermits
     * 
     * @see Fields#minPermits
     */
    public PermitRequest setMinPermits(long value) {
        putDirect(FIELD_MinPermits, Long.class, Long.class, value, SetMode.DISALLOW_NULL);
        return this;
    }

    /**
     * Existence checker for requestorIdentifier
     * 
     * @see Fields#requestorIdentifier
     */
    public boolean hasRequestorIdentifier() {
        return contains(FIELD_RequestorIdentifier);
    }

    /**
     * Remover for requestorIdentifier
     * 
     * @see Fields#requestorIdentifier
     */
    public void removeRequestorIdentifier() {
        remove(FIELD_RequestorIdentifier);
    }

    /**
     * Getter for requestorIdentifier
     * 
     * @see Fields#requestorIdentifier
     */
    public String getRequestorIdentifier(GetMode mode) {
        return obtainDirect(FIELD_RequestorIdentifier, String.class, mode);
    }

    /**
     * Getter for requestorIdentifier
     * 
     * @see Fields#requestorIdentifier
     */
    public String getRequestorIdentifier() {
        return getRequestorIdentifier(GetMode.STRICT);
    }

    /**
     * Setter for requestorIdentifier
     * 
     * @see Fields#requestorIdentifier
     */
    public PermitRequest setRequestorIdentifier(String value, SetMode mode) {
        putDirect(FIELD_RequestorIdentifier, String.class, String.class, value, mode);
        return this;
    }

    /**
     * Setter for requestorIdentifier
     * 
     * @see Fields#requestorIdentifier
     */
    public PermitRequest setRequestorIdentifier(String value) {
        putDirect(FIELD_RequestorIdentifier, String.class, String.class, value, SetMode.DISALLOW_NULL);
        return this;
    }

    @Override
    public PermitRequest clone()
        throws CloneNotSupportedException
    {
        return ((PermitRequest) super.clone());
    }

    @Override
    public PermitRequest copy()
        throws CloneNotSupportedException
    {
        return ((PermitRequest) super.copy());
    }

    public static class Fields
        extends PathSpec
    {


        public Fields(List path, String name) {
            super(path, name);
        }

        public Fields() {
            super();
        }

        /**
         * Resource for which permits are needed.
         * 
         */
        public PathSpec resource() {
            return new PathSpec(getPathComponents(), "resource");
        }

        /**
         * Number of permits needed.
         * 
         */
        public PathSpec permits() {
            return new PathSpec(getPathComponents(), "permits");
        }

        /**
         * Minimum number of useful permits.
         * 
         */
        public PathSpec minPermits() {
            return new PathSpec(getPathComponents(), "minPermits");
        }

        /**
         * Identifier of the service requesting the permits.
         * 
         */
        public PathSpec requestorIdentifier() {
            return new PathSpec(getPathComponents(), "requestorIdentifier");
        }

    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy