com.atlan.api.RolesEndpoint Maven / Gradle / Ivy

Go to download
/* SPDX-License-Identifier: Apache-2.0
   Copyright 2022 Atlan Pte. Ltd. */
package com.atlan.api;

import com.atlan.AtlanClient;
import com.atlan.exception.AtlanException;
import com.atlan.model.admin.RoleResponse;
import com.atlan.net.ApiResource;
import com.atlan.net.RequestOptions;

/**
 * API endpoints for interacting with Atlan's roles.
 */
public class RolesEndpoint extends HeraclesEndpoint {

    private static final String endpoint = "/roles";

    public RolesEndpoint(AtlanClient client) {
        super(client);
    }

    // TODO: eventually provide a rich RQL object for the filter

    /**
     * Retrieves a list of the roles defined in Atlan.
     *
     * @param filter which roles to retrieve
     * @param sort property by which to sort the results
     * @param count whether to return the total number of records (true) or not (false)
     * @param offset starting point for results to return, for paging
     * @param limit maximum number of results to be returned
     * @return a list of roles that match the provided criteria
     * @throws AtlanException on any API communication issue
     */
    public RoleResponse list(String filter, String sort, boolean count, int offset, int limit) throws AtlanException {
        return list(filter, sort, count, offset, limit, null);
    }

    /**
     * Retrieves a list of the roles defined in Atlan.
     *
     * @param filter which roles to retrieve
     * @param sort property by which to sort the results
     * @param count whether to return the total number of records (true) or not (false)
     * @param offset starting point for results to return, for paging
     * @param limit maximum number of results to be returned
     * @param options to override default client settings
     * @return a list of roles that match the provided criteria
     * @throws AtlanException on any API communication issue
     */
    public RoleResponse list(String filter, String sort, boolean count, int offset, int limit, RequestOptions options)
            throws AtlanException {
        if (filter == null) {
            filter = "";
        }
        if (sort == null) {
            sort = "";
        }
        String url = String.format(
                "%s%s?filter=%s&sort=%s&count=%s&offset=%s&limit=%s",
                getBaseUrl(),
                endpoint,
                ApiResource.urlEncode(filter),
                ApiResource.urlEncode(sort),
                count,
                offset,
                limit);
        return ApiResource.request(client, ApiResource.RequestMethod.GET, url, "", RoleResponse.class, options);
    }

    /**
     * Retrieves a list of the roles defined in Atlan.
     *
     * @param filter which roles to retrieve
     * @return a list of roles that match the provided criteria
     * @throws AtlanException on any API communication issue
     */
    public RoleResponse list(String filter) throws AtlanException {
        return list(filter, null);
    }

    /**
     * Retrieves a list of the roles defined in Atlan.
     *
     * @param filter which roles to retrieve
     * @param options to override default client settings
     * @return a list of roles that match the provided criteria
     * @throws AtlanException on any API communication issue
     */
    public RoleResponse list(String filter, RequestOptions options) throws AtlanException {
        if (filter == null) {
            filter = "";
        }
        String url = String.format("%s%s?filter=%s", getBaseUrl(), endpoint, ApiResource.urlEncode(filter));
        return ApiResource.request(client, ApiResource.RequestMethod.GET, url, "", RoleResponse.class, options);
    }

    /**
     * Retrieve all roles defined in Atlan.
     *
     * @return a list of all the roles in Atlan
     * @throws AtlanException on any API communication issue
     */
    public RoleResponse list() throws AtlanException {
        return list((RequestOptions) null);
    }

    /**
     * Retrieve all roles defined in Atlan.
     *
     * @param options to override default client settings
     * @return a list of all the roles in Atlan
     * @throws AtlanException on any API communication issue
     */
    public RoleResponse list(RequestOptions options) throws AtlanException {
        String url = String.format("%s%s", getBaseUrl(), endpoint);
        return ApiResource.request(client, ApiResource.RequestMethod.GET, url, "", RoleResponse.class, options);
    }
}