controllers_v2.data_tiering_controller module

class controllers_v2.data_tiering_controller.DataTieringController(config=None, client=None, call_back=None)

Bases: cohesity_management_sdk.controllers_v2.base_controller.BaseController

A Controller to access Endpoints in the cohesity_management_sdk API.

create_cancel_data_tiering_analysis_group_run(id, run_id)

Does a POST request to /data-tiering/analysis-groups/{id}/runs/{runId}/cancel.

Cancel data tiering analysis run for given analysis group ID and run ID

Args:

id (string): Specifies a unique id of data tiering group. run_id (string): Specifies a unique run id of data tiering group

run.

Returns:

void: Response from the API. Request Accepted

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

create_cancel_data_tiering_task_run(id, run_id)

Does a POST request to /data-tiering/tasks/{id}/runs/{runId}/cancel.

Cancel data tiering task run for given data tiering task id and run id.

Args:

id (string): Specifies a unique id of data tiering task. run_id (string): Specifies a unique run id of data tiering task.

Returns:

void: Response from the API. Request Accepted

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

create_data_tiering_analysis_group(body)

Does a POST request to /data-tiering/analysis-groups.

Create a data tiering analysis group.

Args:

body (CommonDataTieringAnalysisGroupParams): Specifies the data

tiering analysis group.

Returns:

DataTieringAnalysisGroup: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

create_data_tiering_analysis_group_run(id)

Does a POST request to /data-tiering/analysis-groups/{id}/runs.

Create a data tiering analysis group run.

Args:

id (string): Specifies the id of the data tiering analysis group.

Returns:

void: Response from the API. Request Accepted

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

create_data_tiering_task(body)

Does a POST request to /data-tiering/tasks.

Create a data tiering task.

Args:

body (CreateOrUpdateDataTieringTaskRequest): Specifies the

parameters to create a data tiering task.

Returns:

DataTieringTask: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

create_data_tiering_task_run(id, body=None)

Does a POST request to /data-tiering/tasks/{id}/runs.

Create a data tiering tasks run.

Args:

id (string): Specifies the id of the data tiering tasks. body (RunOnceDataTieringTaskRequest, optional): Specifies the

request to run tiering task once.

Returns:

void: Response from the API. Request Accepted

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

delete_data_tiering_analysis_group(id)

Does a DELETE request to /data-tiering/analysis-groups/{id}.

Returns NoContentResponse if the data tiering analysis group is deleted.

Args:

id (string): Specifies a unique id of the data tiering analysis

group.

Returns:

void: Response from the API. No Content

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

delete_data_tiering_task(id)

Does a DELETE request to /data-tiering/tasks/{id}.

Returns Success if the data tiering task is deleted.

Args:

id (string): Specifies the id of the data tiering task.

Returns:

void: Response from the API. No Content

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

get_data_tiering_analysis_group_by_id(id)

Does a GET request to /data-tiering/analysis-groups/{id}.

Get data tiering analysis group by id.

Args:

id (string): Specifies a unique id of the data tiering analysis

group.

Returns:

DataTieringAnalysisGroup: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

get_data_tiering_analysis_groups(ids=None)

Does a GET request to /data-tiering/analysis-groups.

Get list of all data tiering analysis groups.

Args:

ids (list of string, optional): Filter by a list of Analysis Group

IDs.

Returns:

list of DataTieringAnalysisGroup: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

get_data_tiering_task_by_id(id)

Does a GET request to /data-tiering/tasks/{id}.

Get data tiering task by id.

Args:

id (string): Specifies the id of the data tiering task.

Returns:

DataTieringTask: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

get_data_tiering_tasks(ids=None)

Does a GET request to /data-tiering/tasks.

Get the list of data tiering tasks.

Args:

ids (list of string, optional): Filter by a list of data tiering

task ids.

Returns:

list of DataTieringTask: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

update_data_tiering_analysis_group_tags_config(id, body)

Does a PUT request to /data-tiering/analysis-groups/{id}/config.

Update data tiering analysis group config.

Args:

id (string): Specifies a unique id of the data tiering analysis

group.

body (DataTieringTagConfig): Specifies the data tiering analysis

Tags Config.

Returns:

DataTieringTagConfig: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

update_data_tiering_analysis_groups_state(body)

Does a POST request to /data-tiering/analysis-groups/states.

Perform actions like pause or resume on the data tiering analysis groups for the specified sources.

Args:

body (UpdateStateOfTheDataTieringGroups): Specifies the parameters

to perform an action of list of data tiering analysis groups.

Returns:

SpecifiesTheSummaryOfTheStateUpdationForTheMultipleDataTieringGroup

s: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

update_data_tiering_task(id, body)

Does a PUT request to /data-tiering/tasks/{id}.

Update a data tiering task.

Args:

id (string): Specifies the id of the data tiering task. body (CreateOrUpdateDataTieringTaskRequest): Specifies the

parameters to update a data tiering task.

Returns:

DataTieringTask: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.

update_data_tiering_tasks_state(body)

Does a POST request to /data-tiering/tasks/states.

Perform actions like pause or resume on the data tiering tasks.

Args:

body (UpdateStateOfTheDataTieringGroups): Specifies the parameters

to perform an action of list of data tiering tasks.

Returns:

SpecifiesTheSummaryOfTheStateUpdationForTheMultipleDataTieringGroup

s: Response from the API. Success

Raises:

APIException: When an error occurs while fetching the data from

the remote API. This exception includes the HTTP Response code, an error message, and the HTTP body that was received in the request.