Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Generated by delombok at Thu Oct 10 18:56:32 UTC 2024
/* 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.*;
import com.atlan.model.core.AtlanObject;
import com.atlan.net.ApiResource;
import com.atlan.net.RequestOptions;
import java.util.ArrayList;
import java.util.List;
/**
* API endpoints for interacting with Atlan's groups.
*/
public class GroupsEndpoint extends HeraclesEndpoint {
private static final String endpoint = "/groups";
public GroupsEndpoint(AtlanClient client) {
super(client);
}
// TODO: eventually provide a rich RQL object for the filter
/**
* Retrieve groups defined in Atlan.
*
* @param request containing details about which groups to retrieve
* @return a list of the groups in Atlan
* @throws AtlanException on any API communication issue
*/
public GroupResponse list(GroupRequest request) throws AtlanException {
return list(request, null);
}
/**
* Retrieve groups defined in Atlan.
*
* @param request containing details about which groups to retrieve
* @param options to override default client settings
* @return a list of the groups in Atlan
* @throws AtlanException on any API communication issue
*/
public GroupResponse list(GroupRequest request, RequestOptions options) throws AtlanException {
List queryParams = new ArrayList<>();
if (request.getFilter() != null) {
queryParams.add("filter=" + ApiResource.urlEncode(request.getFilter()));
}
if (request.getSort() != null) {
queryParams.add("sort=" + ApiResource.urlEncode(request.getSort()));
}
queryParams.add("count=" + request.getCount());
queryParams.add("offset=" + request.getOffset());
queryParams.add("limit=" + request.getLimit());
String url = String.format("%s%s?%s", getBaseUrl(), endpoint, String.join("&", queryParams));
GroupResponse response = ApiResource.request(client, ApiResource.RequestMethod.GET, url, "", GroupResponse.class, options);
response.setClient(client);
response.setRequest(request);
return response;
}
/**
* Retrieves a list of the groups defined in Atlan.
*
* @param filter which groups 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 groups that match the provided criteria
* @throws AtlanException on any API communication issue
*/
public GroupResponse 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 groups defined in Atlan.
*
* @param filter which groups 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 groups that match the provided criteria
* @throws AtlanException on any API communication issue
*/
public GroupResponse list(String filter, String sort, boolean count, int offset, int limit, RequestOptions options) throws AtlanException {
return list(GroupRequest.builder().filter(filter).sort(sort).count(count).offset(offset).limit(limit).build(), options);
}
/**
* Retrieves a list of the groups defined in Atlan.
*
* @param filter which groups to retrieve
* @return a list of groups that match the provided criteria
* @throws AtlanException on any API communication issue
*/
public GroupResponse list(String filter) throws AtlanException {
return list(filter, null);
}
/**
* Retrieves a list of the groups defined in Atlan.
*
* @param filter which groups to retrieve
* @param options to override default client settings
* @return a list of groups that match the provided criteria
* @throws AtlanException on any API communication issue
*/
public GroupResponse list(String filter, RequestOptions options) throws AtlanException {
return list(GroupRequest.builder().filter(filter).build(), options);
}
/**
* Retrieve all groups defined in Atlan.
*
* @return a list of all the groups in Atlan
* @throws AtlanException on any API communication issue
*/
public List list() throws AtlanException {
return list((RequestOptions) null);
}
/**
* Retrieve all groups defined in Atlan.
*
* @param options to override default client settings
* @return a list of all the groups in Atlan
* @throws AtlanException on any API communication issue
*/
public List list(RequestOptions options) throws AtlanException {
return list(20, options);
}
/**
* Retrieve all groups defined in Atlan.
*
* @param pageSize maximum number of groups to retrieve per request
* @param options to override default client settings
* @return a list of all the groups in Atlan
* @throws AtlanException on any API communication issue
*/
public List list(int pageSize, RequestOptions options) throws AtlanException {
List groups = new ArrayList<>();
GroupResponse response = list(GroupRequest.builder().limit(pageSize).build(), options);
if (response != null) {
for (AtlanGroup group : response) {
groups.add(group);
}
}
return groups;
}
/**
* Retrieves all groups with a name that contains the provided string.
* (This could include a complete group name, in which case there should be at
* most a single item in the returned list, or could be a partial group name
* to retrieve all groups with that naming convention.)
*
* @param alias name (as it appears in the UI) on which to filter the groups
* @return all groups whose name (in the UI) contains the provided string
* @throws AtlanException on any error during API invocation
*/
public List get(String alias) throws AtlanException {
return get(alias, null);
}
/**
* Retrieves all groups with a name that contains the provided string.
* (This could include a complete group name, in which case there should be at
* most a single item in the returned list, or could be a partial group name
* to retrieve all groups with that naming convention.)
*
* @param alias name (as it appears in the UI) on which to filter the groups
* @param options to override default client settings
* @return all groups whose name (in the UI) contains the provided string
* @throws AtlanException on any error during API invocation
*/
public List get(String alias, RequestOptions options) throws AtlanException {
GroupResponse response = list("{\"$and\":[{\"alias\":{\"$ilike\":\"%" + alias + "%\"}}]}", options);
if (response != null && response.getRecords() != null) {
return response.getRecords();
} else {
return null;
}
}
/**
* Create a new group.
*
* @param group the details of the new group
* @return the unique identifier (GUID) of the group that was created, or null if none was created
* @throws AtlanException on any API communication issue
*/
public String create(AtlanGroup group) throws AtlanException {
return create(group, (RequestOptions) null);
}
/**
* Create a new group.
*
* @param group the details of the new group
* @param options to override default client settings
* @return the unique identifier (GUID) of the group that was created, or null if none was created
* @throws AtlanException on any API communication issue
*/
public String create(AtlanGroup group, RequestOptions options) throws AtlanException {
CreateGroupResponse response = create(group, null, options);
if (response != null) {
return response.getGroup();
}
return null;
}
/**
* Create a new group and associate the provided users with it.
*
* @param group the details of the new group
* @param userIds list of unique identifiers (GUIDs) of users to associate with the group
* @return details of the created group and user associations
* @throws AtlanException on any API communication issue
*/
public CreateGroupResponse create(AtlanGroup group, List userIds) throws AtlanException {
return create(group, userIds, null);
}
/**
* Create a new group and associate the provided users with it.
*
* @param group the details of the new group
* @param userIds list of unique identifiers (GUIDs) of users to associate with the group
* @param options to override default client settings
* @return details of the created group and user associations
* @throws AtlanException on any API communication issue
*/
public CreateGroupResponse create(AtlanGroup group, List userIds, RequestOptions options) throws AtlanException {
String url = String.format("%s%s", getBaseUrl(), endpoint);
CreateGroupRequest.CreateGroupRequestBuilder cgr = CreateGroupRequest.builder().group(group);
if (userIds != null && !userIds.isEmpty()) {
cgr = cgr.users(userIds);
}
return ApiResource.request(client, ApiResource.RequestMethod.POST, url, cgr.build(), CreateGroupResponse.class, options);
}
/**
* Update a group.
*
* @param id unique identifier (GUID) of the group to update
* @param group the details to update on the group
* @throws AtlanException on any API communication issue
*/
public void update(String id, AtlanGroup group) throws AtlanException {
update(id, group, null);
}
/**
* Update a group.
*
* @param id unique identifier (GUID) of the group to update
* @param group the details to update on the group
* @param options to override default client settings
* @throws AtlanException on any API communication issue
*/
public void update(String id, AtlanGroup group, RequestOptions options) throws AtlanException {
String url = String.format("%s%s/%s", getBaseUrl(), endpoint, id);
ApiResource.request(client, ApiResource.RequestMethod.POST, url, group, options);
}
/**
* Retrieves the members (users) of a group.
*
* @param id unique identifier (GUID) of the group from which to retrieve members
* @param request containing details about which members to retrieve
* @return list of users that are members of the group
* @throws AtlanException on any API communication issue
*/
public UserResponse listMembers(String id, UserRequest request) throws AtlanException {
return listMembers(id, request, null);
}
/**
* Retrieves the members (users) of a group.
*
* @param id unique identifier (GUID) of the group from which to retrieve members
* @param request containing details about which members to retrieve
* @param options to override default client settings
* @return list of users that are members of the group
* @throws AtlanException on any API communication issue
*/
public UserResponse listMembers(String id, UserRequest request, RequestOptions options) throws AtlanException {
List queryParams = new ArrayList<>();
queryParams.add("offset=" + request.getOffset());
queryParams.add("limit=" + request.getLimit());
queryParams.add("sort=" + ApiResource.urlEncode(request.getSort()));
if (request.getFilter() != null) {
queryParams.add("filter=" + ApiResource.urlEncode(request.getFilter()));
}
if (request.getColumns() != null && !request.getColumns().isEmpty()) {
queryParams.add("columns=" + String.join(",", request.getColumns()));
}
String url = String.format("%s%s/%s/members?%s", getBaseUrl(), endpoint, id, String.join("&", queryParams));
UserResponse response = ApiResource.request(client, ApiResource.RequestMethod.GET, url, "", UserResponse.class, options);
response.setClient(client);
response.setRequest(request);
return response;
}
/**
* Retrieves the members (users) of a group.
*
* @param id unique identifier (GUID) of the group from which to retrieve members
* @return list of users that are members of the group
* @throws AtlanException on any API communication issue
*/
public UserResponse listMembers(String id) throws AtlanException {
return listMembers(id, (RequestOptions) null);
}
/**
* Retrieves the members (users) of a group.
*
* @param id unique identifier (GUID) of the group from which to retrieve members
* @param options to override default client settings
* @return list of users that are members of the group
* @throws AtlanException on any API communication issue
*/
public UserResponse listMembers(String id, RequestOptions options) throws AtlanException {
return listMembers(id, UserRequest.builder().build(), options);
}
/**
* Remove one or more users from a group.
*
* @param id unique identifier (GUID) of the group from which to remove users
* @param userIds unique identifiers (GUIDs) of the users to remove from the group
* @throws AtlanException on any API communication issue
*/
public void removeMembers(String id, List userIds) throws AtlanException {
removeMembers(id, userIds, null);
}
/**
* Remove one or more users from a group.
*
* @param id unique identifier (GUID) of the group from which to remove users
* @param userIds unique identifiers (GUIDs) of the users to remove from the group
* @param options to override default client settings
* @throws AtlanException on any API communication issue
*/
public void removeMembers(String id, List userIds, RequestOptions options) throws AtlanException {
String url = String.format("%s%s/%s/members/remove", getBaseUrl(), endpoint, id);
RemoveFromGroupRequest rfgr = RemoveFromGroupRequest.builder().users(userIds).build();
ApiResource.request(client, ApiResource.RequestMethod.POST, url, rfgr, options);
}
/**
* Delete a group.
*
* @param id unique identifier (GUID) of the group to delete
* @throws AtlanException on any API communication issue
*/
public void purge(String id) throws AtlanException {
purge(id, null);
}
/**
* Delete a group.
*
* @param id unique identifier (GUID) of the group to delete
* @param options to override default client settings
* @throws AtlanException on any API communication issue
*/
public void purge(String id, RequestOptions options) throws AtlanException {
String url = String.format("%s%s/%s/delete", getBaseUrl(), endpoint, id);
ApiResource.request(client, ApiResource.RequestMethod.POST, url, "", options);
}
/**
* Request class for creating a group.
*/
static final class CreateGroupRequest extends AtlanObject {
private static final long serialVersionUID = 2L;
AtlanGroup group;
List users;
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static abstract class CreateGroupRequestBuilder> extends AtlanObject.AtlanObjectBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private AtlanGroup group;
@java.lang.SuppressWarnings("all")
@lombok.Generated
private List users;
/**
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B group(final AtlanGroup group) {
this.group = group;
return self();
}
/**
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B users(final List users) {
this.users = users;
return self();
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected abstract B self();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public abstract C build();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "GroupsEndpoint.CreateGroupRequest.CreateGroupRequestBuilder(super=" + super.toString() + ", group=" + this.group + ", users=" + this.users + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class CreateGroupRequestBuilderImpl extends GroupsEndpoint.CreateGroupRequest.CreateGroupRequestBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private CreateGroupRequestBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected GroupsEndpoint.CreateGroupRequest.CreateGroupRequestBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public GroupsEndpoint.CreateGroupRequest build() {
return new GroupsEndpoint.CreateGroupRequest(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected CreateGroupRequest(final GroupsEndpoint.CreateGroupRequest.CreateGroupRequestBuilder b) {
super(b);
this.group = b.group;
this.users = b.users;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static GroupsEndpoint.CreateGroupRequest.CreateGroupRequestBuilder builder() {
return new GroupsEndpoint.CreateGroupRequest.CreateGroupRequestBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public AtlanGroup getGroup() {
return this.group;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getUsers() {
return this.users;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public boolean equals(final java.lang.Object o) {
if (o == this) return true;
if (!(o instanceof GroupsEndpoint.CreateGroupRequest)) return false;
final GroupsEndpoint.CreateGroupRequest other = (GroupsEndpoint.CreateGroupRequest) o;
if (!other.canEqual((java.lang.Object) this)) return false;
final java.lang.Object this$group = this.getGroup();
final java.lang.Object other$group = other.getGroup();
if (this$group == null ? other$group != null : !this$group.equals(other$group)) return false;
final java.lang.Object this$users = this.getUsers();
final java.lang.Object other$users = other.getUsers();
if (this$users == null ? other$users != null : !this$users.equals(other$users)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof GroupsEndpoint.CreateGroupRequest;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = 1;
final java.lang.Object $group = this.getGroup();
result = result * PRIME + ($group == null ? 43 : $group.hashCode());
final java.lang.Object $users = this.getUsers();
result = result * PRIME + ($users == null ? 43 : $users.hashCode());
return result;
}
}
/**
* Request class for removing users from a group.
*/
static final class RemoveFromGroupRequest extends AtlanObject {
private static final long serialVersionUID = 2L;
List users;
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static abstract class RemoveFromGroupRequestBuilder> extends AtlanObject.AtlanObjectBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private List users;
/**
* @return {@code this}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public B users(final List users) {
this.users = users;
return self();
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected abstract B self();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public abstract C build();
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public java.lang.String toString() {
return "GroupsEndpoint.RemoveFromGroupRequest.RemoveFromGroupRequestBuilder(super=" + super.toString() + ", users=" + this.users + ")";
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
private static final class RemoveFromGroupRequestBuilderImpl extends GroupsEndpoint.RemoveFromGroupRequest.RemoveFromGroupRequestBuilder {
@java.lang.SuppressWarnings("all")
@lombok.Generated
private RemoveFromGroupRequestBuilderImpl() {
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected GroupsEndpoint.RemoveFromGroupRequest.RemoveFromGroupRequestBuilderImpl self() {
return this;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public GroupsEndpoint.RemoveFromGroupRequest build() {
return new GroupsEndpoint.RemoveFromGroupRequest(this);
}
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected RemoveFromGroupRequest(final GroupsEndpoint.RemoveFromGroupRequest.RemoveFromGroupRequestBuilder b) {
super(b);
this.users = b.users;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public static GroupsEndpoint.RemoveFromGroupRequest.RemoveFromGroupRequestBuilder builder() {
return new GroupsEndpoint.RemoveFromGroupRequest.RemoveFromGroupRequestBuilderImpl();
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getUsers() {
return this.users;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public boolean equals(final java.lang.Object o) {
if (o == this) return true;
if (!(o instanceof GroupsEndpoint.RemoveFromGroupRequest)) return false;
final GroupsEndpoint.RemoveFromGroupRequest other = (GroupsEndpoint.RemoveFromGroupRequest) o;
if (!other.canEqual((java.lang.Object) this)) return false;
final java.lang.Object this$users = this.getUsers();
final java.lang.Object other$users = other.getUsers();
if (this$users == null ? other$users != null : !this$users.equals(other$users)) return false;
return true;
}
@java.lang.SuppressWarnings("all")
@lombok.Generated
protected boolean canEqual(final java.lang.Object other) {
return other instanceof GroupsEndpoint.RemoveFromGroupRequest;
}
@java.lang.Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public int hashCode() {
final int PRIME = 59;
int result = 1;
final java.lang.Object $users = this.getUsers();
result = result * PRIME + ($users == null ? 43 : $users.hashCode());
return result;
}
}
}
