controllers_v2.test_data_management_controller module¶
-
class
controllers_v2.test_data_management_controller.
TestDataManagementController
(config=None, client=None, call_back=None)[source]¶ Bases:
cohesity_management_sdk.controllers_v2.base_controller.BaseController
A Controller to access Endpoints in the cohesity_management_sdk API.
-
create_tdm_task
(body)[source]¶ Does a POST request to /tdm/tasks.
Create a task for the Test Data Management (TDM) workflow.
- Args:
- body (CreateTdmTaskRequest): Specifies the parameters to create a
TDM task.
- Returns:
TdmTask: 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.
-
delete_tdm_snapshot_by_id
(id)[source]¶ Does a DELETE request to /tdm/snapshots/{id}.
Delete a snapshot by specifying its ID.
- Args:
id (string): Specifies the ID of the snapshot.
- 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_tdm_object_by_id
(id)[source]¶ Does a GET request to /tdm/objects/{id}.
Get a TDM object by specifying its ID.
- Args:
id (string): Specifies the ID of the TDM object.
- Returns:
TdmObject: 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_tdm_objects
(ids=None, environments=None, name=None, task_ids=None, statuses=None)[source]¶ Does a GET request to /tdm/objects.
Get all TDM objects matching specified optional filter criteria.
- Args:
- ids (list of string, optional): Get the objects matching specifies
IDs.
- environments (list of Environment24Enum, optional): Get the
objects matching specified environments.
name (string, optional): Get the objects matching specified name. task_ids (list of string, optional): Get the objects belonging to
the specified TDM task IDs.
- statuses (list of Status19Enum, optional): Get the objects
matching specified statuses.
- Returns:
TdmObjects: 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_tdm_task_by_id
(id)[source]¶ Does a GET request to /tdm/tasks/{id}.
Get a TDM task by ID.
- Args:
id (string): Specifies the ID of the TDM task.
- Returns:
TdmTask: 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_tdm_tasks
(ids=None, actions=None, environments=None, created_after_usecs=None, created_before_usecs=None, statuses=None, object_ids=None)[source]¶ Does a GET request to /tdm/tasks.
Get all the TDM tasks matching specified optional filter criteria.
- Args:
- ids (list of string, optional): Get the tasks matching specified
IDs.
- actions (list of Actions2Enum, optional): Get the tasks matching
specified actions.
- environments (list of Environment24Enum, optional): Get the tasks
matching specified environments.
- created_after_usecs (long|int, optional): Get the tasks created
after the specified time (in usecs from epoch).
- created_before_usecs (long|int, optional): Get the tasks created
before the specified time (in usecs from epoch).
- statuses (list of Status19Enum, optional): Get the tasks matching
specified statuses.
- object_ids (list of string, optional): Get the tasks for the
specified TDM object IDs.
- Returns:
TdmTasks: 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_tdm_timeline_events_by_object_id
(id, created_after=None, created_before=None)[source]¶ Does a GET request to /tdm/objects/{id}/timeline-events.
Get the collection of timeline events of a TDM object by specifying its ID.
- Args:
id (string): Specifies the ID of the TDM object. created_after (long|int, optional): Get the events created after
the specified time (in usecs from epoch).
- created_before (long|int, optional): Get the events created before
the specified time (in usecs from epoch).
- Returns:
TdmObjectTimelineEvents: 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_tdm_snapshot_by_id
(id, body)[source]¶ Does a PUT request to /tdm/snapshots/{id}.
Update the details of a snapshot by specifying its ID.
- Args:
id (string): Specifies the ID of the snapshot. body (CommonTdmCloneSnapshotParams): Specifies the parameters to
update the snapshot.
- Returns:
TdmSnapshot: 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.
-