Package com.ants.platform.client.resources.projects

Class ProjectsClient

java.lang.Object

com.ants.platform.client.resources.projects.ProjectsClient

public class ProjectsClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
ProjectsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Project	create(CreateProjectRequest request)	Create a new project (requires organization-scoped API key)
Project	create(CreateProjectRequest request, RequestOptions requestOptions)	Create a new project (requires organization-scoped API key)
ApiKeyResponse	createApiKey(String projectId)	Create a new API key for a project (requires organization-scoped API key)
ApiKeyResponse	createApiKey(String projectId, CreateApiKeyRequest request)	Create a new API key for a project (requires organization-scoped API key)
ApiKeyResponse	createApiKey(String projectId, CreateApiKeyRequest request, RequestOptions requestOptions)	Create a new API key for a project (requires organization-scoped API key)
ProjectDeletionResponse	delete(String projectId)	Delete a project by ID (requires organization-scoped API key).
ProjectDeletionResponse	delete(String projectId, RequestOptions requestOptions)	Delete a project by ID (requires organization-scoped API key).
ApiKeyDeletionResponse	deleteApiKey(String projectId, String apiKeyId)	Delete an API key for a project (requires organization-scoped API key)
ApiKeyDeletionResponse	deleteApiKey(String projectId, String apiKeyId, RequestOptions requestOptions)	Delete an API key for a project (requires organization-scoped API key)
Projects	get()	Get Project associated with API key
Projects	get(RequestOptions requestOptions)	Get Project associated with API key
ApiKeyList	getApiKeys(String projectId)	Get all API keys for a project (requires organization-scoped API key)
ApiKeyList	getApiKeys(String projectId, RequestOptions requestOptions)	Get all API keys for a project (requires organization-scoped API key)
Project	update(String projectId, UpdateProjectRequest request)	Update a project by ID (requires organization-scoped API key).
Project	update(String projectId, UpdateProjectRequest request, RequestOptions requestOptions)	Update a project by ID (requires organization-scoped API key).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

clientOptions

protected final ClientOptions clientOptions

Constructor Details

ProjectsClient

public ProjectsClient(ClientOptions clientOptions)

Method Details

get

public Projects get()

Get Project associated with API key

get

public Projects get(RequestOptions requestOptions)

Get Project associated with API key

create

public Project create(CreateProjectRequest request)

Create a new project (requires organization-scoped API key)

create

public Project create(CreateProjectRequest request,
 RequestOptions requestOptions)

Create a new project (requires organization-scoped API key)

update

public Project update(String projectId,
 UpdateProjectRequest request)

Update a project by ID (requires organization-scoped API key).

update

public Project update(String projectId,
 UpdateProjectRequest request,
 RequestOptions requestOptions)

Update a project by ID (requires organization-scoped API key).

delete

public ProjectDeletionResponse delete(String projectId)

Delete a project by ID (requires organization-scoped API key). Project deletion is processed asynchronously.

delete

public ProjectDeletionResponse delete(String projectId,
 RequestOptions requestOptions)

Delete a project by ID (requires organization-scoped API key). Project deletion is processed asynchronously.

getApiKeys

public ApiKeyList getApiKeys(String projectId)

Get all API keys for a project (requires organization-scoped API key)

getApiKeys

public ApiKeyList getApiKeys(String projectId,
 RequestOptions requestOptions)

Get all API keys for a project (requires organization-scoped API key)

createApiKey

public ApiKeyResponse createApiKey(String projectId)

Create a new API key for a project (requires organization-scoped API key)

createApiKey

public ApiKeyResponse createApiKey(String projectId,
 CreateApiKeyRequest request)

Create a new API key for a project (requires organization-scoped API key)

createApiKey

public ApiKeyResponse createApiKey(String projectId,
 CreateApiKeyRequest request,
 RequestOptions requestOptions)

Create a new API key for a project (requires organization-scoped API key)

deleteApiKey

public ApiKeyDeletionResponse deleteApiKey(String projectId,
 String apiKeyId)

Delete an API key for a project (requires organization-scoped API key)

deleteApiKey

public ApiKeyDeletionResponse deleteApiKey(String projectId,
 String apiKeyId,
 RequestOptions requestOptions)

Delete an API key for a project (requires organization-scoped API key)