com.box.sdk.EnterpriseEventsRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of box-java-sdk Show documentation
The Box SDK for Java.
The newest version!
package com.box.sdk;

import static com.box.sdk.EventLog.ENTERPRISE_LIMIT;

import com.box.sdk.BoxEvent.EventType;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Date;

/**
 * Class describing request to get Admin Logs. You can use it's fluent interface to create new request like so:
 *  * {@code
 * new EnterpriseEventsRequest().position("stream_position").limit(50);
 * }
 * 
 */
public final class EnterpriseEventsRequest {
    private static final String ADMIN_LOGS_STREAM_TYPE = "admin_logs";
    private Date before;
    private Date after;
    private String position;
    private int limit = ENTERPRISE_LIMIT;
    private Collection types = new ArrayList<>();

    /**
     * The lower bound on the timestamp of the events returned.
     * @param date the lower bound on the timestamp of the events returned.
     * @return request being created.
     */
    public EnterpriseEventsRequest after(Date date) {
        this.after = date;
        return this;
    }

    /**
     * The upper bound on the timestamp of the events returned.
     * @param date the upper bound on the timestamp of the events returned.
     * @return request being created.
     */
    public EnterpriseEventsRequest before(Date date) {
        this.before = date;
        return this;
    }

    /**
     * The starting position of the event stream.
     * @param position the starting position of the event stream.
     * @return request being created.
     */
    public EnterpriseEventsRequest position(String position) {
        this.position = position;
        return this;
    }

    /**
     * The number of entries to be returned in the response.
     * @param limit the number of entries to be returned in the response.
     * @return request being created.
     */
    public EnterpriseEventsRequest limit(int limit) {
        this.limit = limit;
        return this;
    }

    /**
     * List of event types to filter by.
     * @param types list of event types to filter by.
     * @return request being created.
     */
    public EnterpriseEventsRequest types(EventType... types) {
        return typeNames(Arrays.stream(types)
            .map(EventType::toJSONString)
            .toArray(String[]::new)
        );
    }

    /**
     * List of event type names to filter by.
     * @param typeNames list of event type names to filter by.
     * @return request being created.
     */
    public EnterpriseEventsRequest typeNames(String... typeNames) {
        this.types = Arrays.asList(typeNames);
        return this;
    }

    Date getAfter() {
        return after;
    }

    Date getBefore() {
        return before;
    }

    String getPosition() {
        return position;
    }

    int getLimit() {
        return limit;
    }


    Collection getTypes() {
        return types;
    }

    String getStreamType() {
        return ADMIN_LOGS_STREAM_TYPE;
    }
}