com.codedx.client.api

Class MetadataApi

java.lang.Object

com.codedx.client.api.MetadataApi

public class MetadataApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
MetadataApi()
MetadataApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Metadata	createMetadataField(Metadata metadata) Create Project Metadata Field Creates a project metadata field.
com.squareup.okhttp.Call	createMetadataFieldAsync(Metadata metadata, ApiCallback<Metadata> callback) Create Project Metadata Field (asynchronously) Creates a project metadata field.
com.squareup.okhttp.Call	createMetadataFieldCall(Metadata metadata, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for createMetadataField
ApiResponse<Metadata>	createMetadataFieldWithHttpInfo(Metadata metadata) Create Project Metadata Field Creates a project metadata field.
void	deleteMetadata(java.lang.Integer fieldId, java.lang.Boolean force) Delete Project Metadata Field
com.squareup.okhttp.Call	deleteMetadataAsync(java.lang.Integer fieldId, java.lang.Boolean force, ApiCallback<java.lang.Void> callback) Delete Project Metadata Field (asynchronously)
com.squareup.okhttp.Call	deleteMetadataCall(java.lang.Integer fieldId, java.lang.Boolean force, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for deleteMetadata
ApiResponse<java.lang.Void>	deleteMetadataWithHttpInfo(java.lang.Integer fieldId, java.lang.Boolean force) Delete Project Metadata Field
java.util.List<Metadata>	getAllMetadata() Get Project Metadata Fields (list) Returns a list of metadata fields
com.squareup.okhttp.Call	getAllMetadataAsync(ApiCallback<java.util.List<Metadata>> callback) Get Project Metadata Fields (list) (asynchronously) Returns a list of metadata fields
com.squareup.okhttp.Call	getAllMetadataCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getAllMetadata
ApiResponse<java.util.List<Metadata>>	getAllMetadataWithHttpInfo() Get Project Metadata Fields (list) Returns a list of metadata fields
ApiClient	getApiClient()
Metadata	getMetadata(java.lang.Integer fieldId) Get Project Metadata Fields (single) Returns a single Project Metadata Field
com.squareup.okhttp.Call	getMetadataAsync(java.lang.Integer fieldId, ApiCallback<Metadata> callback) Get Project Metadata Fields (single) (asynchronously) Returns a single Project Metadata Field
com.squareup.okhttp.Call	getMetadataCall(java.lang.Integer fieldId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getMetadata
java.util.List<MetadataValue>	getMetadataValue(java.lang.Integer projectId) Get Project Metadata Field Values Load the Metadata Field values for a given project
com.squareup.okhttp.Call	getMetadataValueAsync(java.lang.Integer projectId, ApiCallback<java.util.List<MetadataValue>> callback) Get Project Metadata Field Values (asynchronously) Load the Metadata Field values for a given project
com.squareup.okhttp.Call	getMetadataValueCall(java.lang.Integer projectId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getMetadataValue
ApiResponse<java.util.List<MetadataValue>>	getMetadataValueWithHttpInfo(java.lang.Integer projectId) Get Project Metadata Field Values Load the Metadata Field values for a given project
ApiResponse<Metadata>	getMetadataWithHttpInfo(java.lang.Integer fieldId) Get Project Metadata Fields (single) Returns a single Project Metadata Field
Metadata	modifyMetadata(java.lang.Integer fieldId, Metadata metadata) Modify Project Metadata Field Update the name, type, and/or values to match the value specified in the request body.
com.squareup.okhttp.Call	modifyMetadataAsync(java.lang.Integer fieldId, Metadata metadata, ApiCallback<Metadata> callback) Modify Project Metadata Field (asynchronously) Update the name, type, and/or values to match the value specified in the request body.
com.squareup.okhttp.Call	modifyMetadataCall(java.lang.Integer fieldId, Metadata metadata, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for modifyMetadata
ApiResponse<Metadata>	modifyMetadataWithHttpInfo(java.lang.Integer fieldId, Metadata metadata) Modify Project Metadata Field Update the name, type, and/or values to match the value specified in the request body.
void	setApiClient(ApiClient apiClient)
java.util.List<MetadataValue>	updateMetadataValue(java.lang.Integer projectId, java.util.List<MetadataUpdate> metadata) Update Project Metadata Field Values Update the project metadata values for a given project.
com.squareup.okhttp.Call	updateMetadataValueAsync(java.lang.Integer projectId, java.util.List<MetadataUpdate> metadata, ApiCallback<java.util.List<MetadataValue>> callback) Update Project Metadata Field Values (asynchronously) Update the project metadata values for a given project.
com.squareup.okhttp.Call	updateMetadataValueCall(java.lang.Integer projectId, java.util.List<MetadataUpdate> metadata, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for updateMetadataValue
ApiResponse<java.util.List<MetadataValue>>	updateMetadataValueWithHttpInfo(java.lang.Integer projectId, java.util.List<MetadataUpdate> metadata) Update Project Metadata Field Values Update the project metadata values for a given project.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataApi

public MetadataApi()

MetadataApi

public MetadataApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createMetadataFieldCall

public com.squareup.okhttp.Call createMetadataFieldCall(Metadata metadata,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for createMetadataField

Parameters:

metadata - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

createMetadataField

public Metadata createMetadataField(Metadata metadata)
                             throws ApiException

Create Project Metadata Field Creates a project metadata field. The request body should contain a Project Metadata Field object, excluding anys ids that should be generated by the API itself.

Parameters:

metadata - (required)

Returns:

Metadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createMetadataFieldWithHttpInfo

public ApiResponse<Metadata> createMetadataFieldWithHttpInfo(Metadata metadata)
                                                      throws ApiException

Create Project Metadata Field Creates a project metadata field. The request body should contain a Project Metadata Field object, excluding anys ids that should be generated by the API itself.

Parameters:

metadata - (required)

Returns:

ApiResponse<Metadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

createMetadataFieldAsync

public com.squareup.okhttp.Call createMetadataFieldAsync(Metadata metadata,
                                                         ApiCallback<Metadata> callback)
                                                  throws ApiException

Create Project Metadata Field (asynchronously) Creates a project metadata field. The request body should contain a Project Metadata Field object, excluding anys ids that should be generated by the API itself.

Parameters:

metadata - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

deleteMetadataCall

public com.squareup.okhttp.Call deleteMetadataCall(java.lang.Integer fieldId,
                                                   java.lang.Boolean force,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for deleteMetadata

Parameters:

fieldId - The ID of the metadata field. (required)

force - If set to `true`, this method will delete the field even if one or more projects had a value configured for that field. Defaults to `false`. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteMetadata

public void deleteMetadata(java.lang.Integer fieldId,
                           java.lang.Boolean force)
                    throws ApiException

Delete Project Metadata Field

Parameters:

fieldId - The ID of the metadata field. (required)

force - If set to `true`, this method will delete the field even if one or more projects had a value configured for that field. Defaults to `false`. (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteMetadataWithHttpInfo

public ApiResponse<java.lang.Void> deleteMetadataWithHttpInfo(java.lang.Integer fieldId,
                                                              java.lang.Boolean force)
                                                       throws ApiException

Delete Project Metadata Field

Parameters:

fieldId - The ID of the metadata field. (required)

force - If set to `true`, this method will delete the field even if one or more projects had a value configured for that field. Defaults to `false`. (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

deleteMetadataAsync

public com.squareup.okhttp.Call deleteMetadataAsync(java.lang.Integer fieldId,
                                                    java.lang.Boolean force,
                                                    ApiCallback<java.lang.Void> callback)
                                             throws ApiException

Delete Project Metadata Field (asynchronously)

Parameters:

fieldId - The ID of the metadata field. (required)

force - If set to `true`, this method will delete the field even if one or more projects had a value configured for that field. Defaults to `false`. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getAllMetadataCall

public com.squareup.okhttp.Call getAllMetadataCall(ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getAllMetadata

Parameters:

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getAllMetadata

public java.util.List<Metadata> getAllMetadata()
                                        throws ApiException

Get Project Metadata Fields (list) Returns a list of metadata fields

Returns:

List<Metadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAllMetadataWithHttpInfo

public ApiResponse<java.util.List<Metadata>> getAllMetadataWithHttpInfo()
                                                                 throws ApiException

Get Project Metadata Fields (list) Returns a list of metadata fields

Returns:

ApiResponse<List<Metadata>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getAllMetadataAsync

public com.squareup.okhttp.Call getAllMetadataAsync(ApiCallback<java.util.List<Metadata>> callback)
                                             throws ApiException

Get Project Metadata Fields (list) (asynchronously) Returns a list of metadata fields

Parameters:

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getMetadataCall

public com.squareup.okhttp.Call getMetadataCall(java.lang.Integer fieldId,
                                                ProgressResponseBody.ProgressListener progressListener,
                                                ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                         throws ApiException

Build call for getMetadata

Parameters:

fieldId - The ID of the metadata field. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMetadata

public Metadata getMetadata(java.lang.Integer fieldId)
                     throws ApiException

Get Project Metadata Fields (single) Returns a single Project Metadata Field

Parameters:

fieldId - The ID of the metadata field. (required)

Returns:

Metadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMetadataWithHttpInfo

public ApiResponse<Metadata> getMetadataWithHttpInfo(java.lang.Integer fieldId)
                                              throws ApiException

Get Project Metadata Fields (single) Returns a single Project Metadata Field

Parameters:

fieldId - The ID of the metadata field. (required)

Returns:

ApiResponse<Metadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMetadataAsync

public com.squareup.okhttp.Call getMetadataAsync(java.lang.Integer fieldId,
                                                 ApiCallback<Metadata> callback)
                                          throws ApiException

Get Project Metadata Fields (single) (asynchronously) Returns a single Project Metadata Field

Parameters:

fieldId - The ID of the metadata field. (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

getMetadataValueCall

public com.squareup.okhttp.Call getMetadataValueCall(java.lang.Integer projectId,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for getMetadataValue

Parameters:

projectId - The ID of the project. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getMetadataValue

public java.util.List<MetadataValue> getMetadataValue(java.lang.Integer projectId)
                                               throws ApiException

Get Project Metadata Field Values Load the Metadata Field values for a given project

Parameters:

projectId - The ID of the project. (required)

Returns:

List<MetadataValue>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMetadataValueWithHttpInfo

public ApiResponse<java.util.List<MetadataValue>> getMetadataValueWithHttpInfo(java.lang.Integer projectId)
                                                                        throws ApiException

Get Project Metadata Field Values Load the Metadata Field values for a given project

Parameters:

projectId - The ID of the project. (required)

Returns:

ApiResponse<List<MetadataValue>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

getMetadataValueAsync

public com.squareup.okhttp.Call getMetadataValueAsync(java.lang.Integer projectId,
                                                      ApiCallback<java.util.List<MetadataValue>> callback)
                                               throws ApiException

Get Project Metadata Field Values (asynchronously) Load the Metadata Field values for a given project

Parameters:

projectId - The ID of the project. (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

modifyMetadataCall

public com.squareup.okhttp.Call modifyMetadataCall(java.lang.Integer fieldId,
                                                   Metadata metadata,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for modifyMetadata

Parameters:

fieldId - The ID of the metadata field. (required)

metadata - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

modifyMetadata

public Metadata modifyMetadata(java.lang.Integer fieldId,
                               Metadata metadata)
                        throws ApiException

Modify Project Metadata Field Update the name, type, and/or values to match the value specified in the request body. When adding values to the values array, be sure to include all existing values. With this method, you may omit fields that you wish to leave unchanged.

Parameters:

fieldId - The ID of the metadata field. (required)

metadata - (required)

Returns:

Metadata

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

modifyMetadataWithHttpInfo

public ApiResponse<Metadata> modifyMetadataWithHttpInfo(java.lang.Integer fieldId,
                                                        Metadata metadata)
                                                 throws ApiException

Modify Project Metadata Field Update the name, type, and/or values to match the value specified in the request body. When adding values to the values array, be sure to include all existing values. With this method, you may omit fields that you wish to leave unchanged.

Parameters:

fieldId - The ID of the metadata field. (required)

metadata - (required)

Returns:

ApiResponse<Metadata>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

modifyMetadataAsync

public com.squareup.okhttp.Call modifyMetadataAsync(java.lang.Integer fieldId,
                                                    Metadata metadata,
                                                    ApiCallback<Metadata> callback)
                                             throws ApiException

Modify Project Metadata Field (asynchronously) Update the name, type, and/or values to match the value specified in the request body. When adding values to the values array, be sure to include all existing values. With this method, you may omit fields that you wish to leave unchanged.

Parameters:

fieldId - The ID of the metadata field. (required)

metadata - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

updateMetadataValueCall

public com.squareup.okhttp.Call updateMetadataValueCall(java.lang.Integer projectId,
                                                        java.util.List<MetadataUpdate> metadata,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for updateMetadataValue

Parameters:

projectId - The ID of the project. (required)

metadata - (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

updateMetadataValue

public java.util.List<MetadataValue> updateMetadataValue(java.lang.Integer projectId,
                                                         java.util.List<MetadataUpdate> metadata)
                                                  throws ApiException

Update Project Metadata Field Values Update the project metadata values for a given project. Values are given for fields which have been previously defined as Project Metadata Fields.

Parameters:

projectId - The ID of the project. (required)

metadata - (required)

Returns:

List<MetadataValue>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateMetadataValueWithHttpInfo

public ApiResponse<java.util.List<MetadataValue>> updateMetadataValueWithHttpInfo(java.lang.Integer projectId,
                                                                                  java.util.List<MetadataUpdate> metadata)
                                                                           throws ApiException

Update Project Metadata Field Values Update the project metadata values for a given project. Values are given for fields which have been previously defined as Project Metadata Fields.

Parameters:

projectId - The ID of the project. (required)

metadata - (required)

Returns:

ApiResponse<List<MetadataValue>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

updateMetadataValueAsync

public com.squareup.okhttp.Call updateMetadataValueAsync(java.lang.Integer projectId,
                                                         java.util.List<MetadataUpdate> metadata,
                                                         ApiCallback<java.util.List<MetadataValue>> callback)
                                                  throws ApiException

Update Project Metadata Field Values (asynchronously) Update the project metadata values for a given project. Values are given for fields which have been previously defined as Project Metadata Fields.

Parameters:

projectId - The ID of the project. (required)

metadata - (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object