Skip to content

Latest commit

 

History

History
635 lines (496 loc) · 28.8 KB

TimeflowsApi.md

File metadata and controls

635 lines (496 loc) · 28.8 KB

TimeflowsApi

All URIs are relative to /v3

Method HTTP request Description
createTimeflowTags POST /timeflows/{timeflowId}/tags Create tags for a Timeflow.
deleteTimeflow DELETE /timeflows/{timeflowId} Delete a timeflow.
deleteTimeflowTags POST /timeflows/{timeflowId}/tags/delete Delete tags for a Timeflow.
getTimeflowById GET /timeflows/{timeflowId} Get a Timeflow by ID.
getTimeflowSnapshotDayRange GET /timeflows/{timeflowId}/timeflowSnapshotDayRange Returns the count of TimeFlow snapshots of the Timeflow aggregated by day.
getTimeflowTags GET /timeflows/{timeflowId}/tags Get tags for a Timeflow.
getTimeflows GET /timeflows Retrieve the list of timeflows.
searchTimeflows POST /timeflows/search Search timeflows.
updateTimeflow PATCH /timeflows/{timeflowId} Update values of a timeflow.

createTimeflowTags

TagsResponse createTimeflowTags(timeflowId, tagsRequest)

Create tags for a Timeflow.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    String timeflowId = "timeflowId_example"; // String | The ID of the timeflow.
    TagsRequest tagsRequest = new TagsRequest(); // TagsRequest | Tags information for Timeflow.
    try {
      TagsResponse result = apiInstance.createTimeflowTags(timeflowId, tagsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#createTimeflowTags");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
timeflowId String The ID of the timeflow.
tagsRequest TagsRequest Tags information for Timeflow.

Return type

TagsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -

deleteTimeflow

DeleteTimeflowResponse deleteTimeflow(timeflowId)

Delete a timeflow.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    String timeflowId = "timeflowId_example"; // String | The ID of the timeflow.
    try {
      DeleteTimeflowResponse result = apiInstance.deleteTimeflow(timeflowId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#deleteTimeflow");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
timeflowId String The ID of the timeflow.

Return type

DeleteTimeflowResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 OK -

deleteTimeflowTags

deleteTimeflowTags(timeflowId, deleteTag)

Delete tags for a Timeflow.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    String timeflowId = "timeflowId_example"; // String | The ID of the timeflow.
    DeleteTag deleteTag = new DeleteTag(); // DeleteTag | The parameters to delete tags
    try {
      apiInstance.deleteTimeflowTags(timeflowId, deleteTag);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#deleteTimeflowTags");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
timeflowId String The ID of the timeflow.
deleteTag DeleteTag The parameters to delete tags [optional]

Return type

null (empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
204 No Content -

getTimeflowById

Timeflow getTimeflowById(timeflowId)

Get a Timeflow by ID.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    String timeflowId = "timeflowId_example"; // String | The ID of the timeflow.
    try {
      Timeflow result = apiInstance.getTimeflowById(timeflowId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#getTimeflowById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
timeflowId String The ID of the timeflow.

Return type

Timeflow

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

getTimeflowSnapshotDayRange

SnapshotsDayRangesResponse getTimeflowSnapshotDayRange(timeflowId)

Returns the count of TimeFlow snapshots of the Timeflow aggregated by day.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    String timeflowId = "timeflowId_example"; // String | The ID of the timeflow.
    try {
      SnapshotsDayRangesResponse result = apiInstance.getTimeflowSnapshotDayRange(timeflowId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#getTimeflowSnapshotDayRange");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
timeflowId String The ID of the timeflow.

Return type

SnapshotsDayRangesResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

getTimeflowTags

TagsResponse getTimeflowTags(timeflowId)

Get tags for a Timeflow.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    String timeflowId = "timeflowId_example"; // String | The ID of the timeflow.
    try {
      TagsResponse result = apiInstance.getTimeflowTags(timeflowId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#getTimeflowTags");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
timeflowId String The ID of the timeflow.

Return type

TagsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Ok -

getTimeflows

ListTimeflowsResponse getTimeflows(limit, cursor, sort)

Retrieve the list of timeflows.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    Integer limit = 100; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
    String cursor = "cursor_example"; // String | Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.
    String sort = "id"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
    try {
      ListTimeflowsResponse result = apiInstance.getTimeflows(limit, cursor, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#getTimeflows");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
limit Integer Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. [optional] [default to 100]
cursor String Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. [optional]
sort String The field to sort results by. A property name with a prepended '-' signifies descending order. [optional] [enum: id, -id, engine_id, -engine_id, namespace, -namespace, name, -name, dataset_id, -dataset_id, creation_type, -creation_type, parent_snapshot_id, -parent_snapshot_id, parent_point_location, -parent_point_location, parent_point_timestamp, -parent_point_timestamp, parent_point_timeflow_id, -parent_point_timeflow_id, source_data_timestamp, -source_data_timestamp, oracle_incarnation_id, -oracle_incarnation_id, oracle_cdb_timeflow_id, -oracle_cdb_timeflow_id, oracle_tde_uuid, -oracle_tde_uuid, mssql_database_guid, -mssql_database_guid, creation_timestamp, -creation_timestamp, activation_timestamp, -activation_timestamp]

Return type

ListTimeflowsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

searchTimeflows

SearchTimeflowsResponse searchTimeflows(limit, cursor, sort, searchBody)

Search timeflows.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    Integer limit = 100; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.
    String cursor = "cursor_example"; // String | Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.
    String sort = "id"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
    SearchBody searchBody = new SearchBody(); // SearchBody | A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.  # Filter Expression Overview **Note: All keywords are case-insensitive**  ## Comparison Operators | Operator | Description | Example | | --- | --- | --- | | CONTAINS | Substring or membership testing for string and list attributes respectively. | field3 CONTAINS 'foobar', field4 CONTAINS TRUE  | | IN | Tests if field is a member of a list literal. List can contain a maximum of 100 values | field2 IN ['Goku', 'Vegeta'] | | GE | Tests if a field is greater than or equal to a literal value | field1 GE 1.2e-2 | | GT | Tests if a field is greater than a literal value | field1 GT 1.2e-2 | | LE | Tests if a field is less than or equal to a literal value | field1 LE 9000 | | LT | Tests if a field is less than a literal value | field1 LT 9.02 | | NE | Tests if a field is not equal to a literal value | field1 NE 42 | | EQ | Tests if a field is equal to a literal value | field1 EQ 42 |  ## Search Operator The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically `SEARCH '12'` would match an item with an attribute with an integer value of `123`.  ## Logical Operators Ordered by precedence. | Operator | Description | Example | | --- | --- | --- | | NOT | Logical NOT (Right associative) | NOT field1 LE 9000 | | AND | Logical AND (Left Associative) | field1 GT 9000 AND field2 EQ 'Goku' | | OR | Logical OR (Left Associative) | field1 GT 9000 OR field2 EQ 'Goku' |  ## Grouping Parenthesis `()` can be used to override operator precedence.  For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')  ## Literal Values | Literal      | Description | Examples | | --- | --- | --- | | Nil | Represents the absence of a value | nil, Nil, nIl, NIL | | Boolean | true/false boolean | true, false, True, False, TRUE, FALSE | | Number | Signed integer and floating point numbers. Also supports scientific notation. | 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2 | | String | Single or double quoted | \"foo\", \"bar\", \"foo bar\", 'foo', 'bar', 'foo bar' | | Datetime | Formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) | 2018-04-27T18:39:26.397237+00:00 | | List | Comma-separated literals wrapped in square brackets | [0], [0, 1], ['foo', \"bar\"] |  ## Limitations - A maximum of 8 unique identifiers may be used inside a filter expression. 
    try {
      SearchTimeflowsResponse result = apiInstance.searchTimeflows(limit, cursor, sort, searchBody);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#searchTimeflows");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
limit Integer Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100. [optional] [default to 100]
cursor String Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints. [optional]
sort String The field to sort results by. A property name with a prepended '-' signifies descending order. [optional] [enum: id, -id, engine_id, -engine_id, namespace, -namespace, name, -name, dataset_id, -dataset_id, creation_type, -creation_type, parent_snapshot_id, -parent_snapshot_id, parent_point_location, -parent_point_location, parent_point_timestamp, -parent_point_timestamp, parent_point_timeflow_id, -parent_point_timeflow_id, source_data_timestamp, -source_data_timestamp, oracle_incarnation_id, -oracle_incarnation_id, oracle_cdb_timeflow_id, -oracle_cdb_timeflow_id, oracle_tde_uuid, -oracle_tde_uuid, mssql_database_guid, -mssql_database_guid, creation_timestamp, -creation_timestamp, activation_timestamp, -activation_timestamp]
searchBody SearchBody A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension. # Filter Expression Overview Note: All keywords are case-insensitive ## Comparison Operators Operator

Return type

SearchTimeflowsResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -

updateTimeflow

UpdateTimeflowResponse updateTimeflow(timeflowId, updateTimeflowParameters)

Update values of a timeflow.

Example

// Import classes:
import com.delphix.dct.ApiClient;
import com.delphix.dct.ApiException;
import com.delphix.dct.Configuration;
import com.delphix.dct.auth.*;
import com.delphix.dct.models.*;
import com.delphix.dct.api.TimeflowsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v3");
    
    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    TimeflowsApi apiInstance = new TimeflowsApi(defaultClient);
    String timeflowId = "timeflowId_example"; // String | The ID of the timeflow.
    UpdateTimeflowParameters updateTimeflowParameters = new UpdateTimeflowParameters(); // UpdateTimeflowParameters | The new data to update a timeflow.
    try {
      UpdateTimeflowResponse result = apiInstance.updateTimeflow(timeflowId, updateTimeflowParameters);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling TimeflowsApi#updateTimeflow");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
timeflowId String The ID of the timeflow.
updateTimeflowParameters UpdateTimeflowParameters The new data to update a timeflow. [optional]

Return type

UpdateTimeflowResponse

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 OK -