All URIs are relative to http://localhost/v3
| Method | HTTP request | Description |
|---|---|---|
| createReportingSchedule | POST /reporting/schedule | Create a new report schedule. |
| createReportingScheduleTags | POST /reporting/schedule/{reportId}/tags | Create tags for a report schedule. |
| deleteReportingSchedule | DELETE /reporting/schedule/{reportId} | Delete report schedule by ID. |
| deleteReportingScheduleTag | POST /reporting/schedule/{reportId}/tags/delete | Delete tags for a report schedule. |
| getApiUsageReport | GET /reporting/api-usage-report | Gets the report of API usage metrics over a given time period. This API returns at the most 10000 results in the response to protect against the server running out of memory. Users might not hit this limit with the default report without any 'apiUsageReportGroupByParam' param but can hit this limit if the groupBy is by too granular like by 'client_name' or 'user_agent' only. Hence it is advisable to use startDate and endDate to 'limit' the scope of the report. |
| getAuditLogsSummaryReport | GET /reporting/audit-logs-summary-report | Gets the audit log summary report. |
| getEngineGlobalObjectStateReport | GET /reporting/engine-global-object-state-report | Get the masking engine global object state report. |
| getEnginePerformanceAnalyticsReport | GET /reporting/engine-performance-analytic-report | Gets the performance analytics report for engines. |
| getMaskingExecutionMetricsReport | GET /reporting/masking-execution-metrics | Get the masking execution metrics report. |
| getProductInfo | GET /reporting/product_info | Returns the DCT Product Information. |
| getReportingScheduleById | GET /reporting/schedule/{reportId} | Returns a report schedule by ID. |
| getReportingScheduleTags | GET /reporting/schedule/{reportId}/tags | Get tags for a report schedule. |
| getReportingSchedules | GET /reporting/schedule | List all report schedules. |
| getVirtualizationStorageSummaryReport | GET /reporting/virtualization-storage-summary-report | Gets the storage summary report for virtualization engines. |
| searchEngineGlobalObjectStateReport | POST /reporting/engine-global-object-state-report/search | Search the masking engine global object state report. |
| searchEnginePerformanceAnalyticTrends | POST /reporting/engine-performance-analytic-trends/search | Search the performance analytic trend data for engines. |
| searchEnginePerformanceAnalyticsReport | POST /reporting/engine-performance-analytic-report/search | Search the performance analytic report for engines. |
| searchMaskingExecutionMetricsReport | POST /reporting/masking-execution-metrics/search | Search the Masking execution metrics report. |
| searchReportingSchedules | POST /reporting/schedule/search | Search for report schedules. |
| searchVirtualizationStorageSummaryReport | POST /reporting/virtualization-storage-summary-report/search | Search the storage summary report for virtualization engines. |
| updateReportingSchedule | PUT /reporting/schedule/{reportId} | Update a reporting schedule by ID. |
ReportingSchedule createReportingSchedule(reportingScheduleCreateParameters)
Create a new report schedule.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
ReportingScheduleCreateParameters reportingScheduleCreateParameters = new ReportingScheduleCreateParameters(); // ReportingScheduleCreateParameters | The parameters to create a reporting schedule.
try {
ReportingSchedule result = apiInstance.createReportingSchedule(reportingScheduleCreateParameters);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#createReportingSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| reportingScheduleCreateParameters | ReportingScheduleCreateParameters | The parameters to create a reporting schedule. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns the newly created schedule for a report. | - |
TagsResponse createReportingScheduleTags(reportId, tagsRequest)
Create tags for a report schedule.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer reportId = 56; // Integer | The ID of the report schedule.
TagsRequest tagsRequest = new TagsRequest(); // TagsRequest | Tags information for report schedule.
try {
TagsResponse result = apiInstance.createReportingScheduleTags(reportId, tagsRequest);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#createReportingScheduleTags");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| reportId | Integer | The ID of the report schedule. | |
| tagsRequest | TagsRequest | Tags information for report schedule. |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 201 | Created | - |
deleteReportingSchedule(reportId)
Delete report schedule by ID.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer reportId = 56; // Integer | The ID of the report schedule.
try {
apiInstance.deleteReportingSchedule(reportId);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#deleteReportingSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| reportId | Integer | The ID of the report schedule. |
null (empty response body)
- Content-Type: Not defined
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
deleteReportingScheduleTag(reportId, deleteTag)
Delete tags for a report schedule.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer reportId = 56; // Integer | The ID of the report schedule.
DeleteTag deleteTag = new DeleteTag(); // DeleteTag | The parameters to delete tags
try {
apiInstance.deleteReportingScheduleTag(reportId, deleteTag);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#deleteReportingScheduleTag");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| reportId | Integer | The ID of the report schedule. | |
| deleteTag | DeleteTag | The parameters to delete tags | [optional] |
null (empty response body)
- Content-Type: application/json
- Accept: Not defined
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
ApiUsageReportResponse getApiUsageReport(startDate, endDate, apiMetricKind, groupBy, clientName, userAgent, dctVersion)
Gets the report of API usage metrics over a given time period. This API returns at the most 10000 results in the response to protect against the server running out of memory. Users might not hit this limit with the default report without any 'apiUsageReportGroupByParam' param but can hit this limit if the groupBy is by too granular like by 'client_name' or 'user_agent' only. Hence it is advisable to use startDate and endDate to 'limit' the scope of the report.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
OffsetDateTime startDate = OffsetDateTime.now(); // OffsetDateTime | Report start date/time. Defaults to first API request.
OffsetDateTime endDate = OffsetDateTime.now(); // OffsetDateTime | Report end date/time. Defaults to current time.
String apiMetricKind = "automation"; // String | Restrict the list to API usage metric of the given kind
List<String> groupBy = Arrays.asList(); // List<String> | The field to group results by.
List<String> clientName = Arrays.asList(); // List<String> | The Client names to be included in the report.
List<String> userAgent = Arrays.asList(); // List<String> | The UserAgent names to be included in the report.
List<String> dctVersion = Arrays.asList(); // List<String> | The DCT versions to be included in the report.
try {
ApiUsageReportResponse result = apiInstance.getApiUsageReport(startDate, endDate, apiMetricKind, groupBy, clientName, userAgent, dctVersion);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getApiUsageReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| startDate | OffsetDateTime | Report start date/time. Defaults to first API request. | [optional] |
| endDate | OffsetDateTime | Report end date/time. Defaults to current time. | [optional] |
| apiMetricKind | String | Restrict the list to API usage metric of the given kind | [optional] [enum: automation, governance] |
| groupBy | List<String> | The field to group results by. | [optional] [enum: api_endpoint, api_method, kind, client_name, user_agent, dct_version] |
| clientName | List<String> | The Client names to be included in the report. | [optional] |
| userAgent | List<String> | The UserAgent names to be included in the report. | [optional] |
| dctVersion | List<String> | The DCT versions to be included in the report. | [optional] |
- Content-Type: Not defined
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of API usage metrics. | - |
AuditLogsSummaryReportResponse getAuditLogsSummaryReport(limit, cursor, sort)
Gets the audit log summary report.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "account_first_name"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
try {
AuditLogsSummaryReportResponse result = apiInstance.getAuditLogsSummaryReport(limit, cursor, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getAuditLogsSummaryReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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: account_id, -account_id, account_first_name, -account_first_name, account_last_name, -account_last_name, vdb_refreshes, -vdb_refreshes, masking_jobs, -masking_jobs] |
AuditLogsSummaryReportResponse
- Content-Type: Not defined
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of aggregated audit log entries for each account. | - |
GetEngineGlobalObjectStateReportResponse getEngineGlobalObjectStateReport(limit, cursor, sort)
Get the masking engine global object state report.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "engine_id"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
try {
GetEngineGlobalObjectStateReportResponse result = apiInstance.getEngineGlobalObjectStateReport(limit, cursor, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getEngineGlobalObjectStateReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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: engine_id, -engine_id, engine_name, -engine_name, jobs_count, -jobs_count, connectors_count, -connectors_count, rulesets_count, -rulesets_count, global_object_revision_hash, -global_object_revision_hash] |
GetEngineGlobalObjectStateReportResponse
- Content-Type: Not defined
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of GlobalObjectState data. | - |
EnginePerformanceAnalyticReportResponse getEnginePerformanceAnalyticsReport(limit, cursor, sort)
Gets the performance analytics report for engines.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "engine_name"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
try {
EnginePerformanceAnalyticReportResponse result = apiInstance.getEnginePerformanceAnalyticsReport(limit, cursor, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getEnginePerformanceAnalyticsReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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: engine_id, -engine_id, engine_name, -engine_name, cpu_cores_count, -cpu_cores_count, cpu_utilization, -cpu_utilization, total_memory, -total_memory, average_disk_latency_read, -average_disk_latency_read, average_disk_latency_write, -average_disk_latency_write, average_disk_latency_total, -average_disk_latency_total, average_disk_throughput_read, -average_disk_throughput_read, average_disk_throughput_write, -average_disk_throughput_write, average_disk_throughput_total, -average_disk_throughput_total, average_disk_iops_read, -average_disk_iops_read, average_disk_iops_write, -average_disk_iops_write, average_disk_iops_total, -average_disk_iops_total, average_nfs_latency_read, -average_nfs_latency_read, average_nfs_latency_write, -average_nfs_latency_write, average_nfs_latency_total, -average_nfs_latency_total, average_nfs_throughput_read, -average_nfs_throughput_read, average_nfs_throughput_write, -average_nfs_throughput_write, average_nfs_throughput_total, -average_nfs_throughput_total, average_nfs_iops_read, -average_nfs_iops_read, average_nfs_iops_write, -average_nfs_iops_write, average_nfs_iops_total, -average_nfs_iops_total, average_iscsi_latency_read, -average_iscsi_latency_read, average_iscsi_latency_write, -average_iscsi_latency_write, average_iscsi_latency_total, -average_iscsi_latency_total, average_iscsi_throughput_read, -average_iscsi_throughput_read, average_iscsi_throughput_write, -average_iscsi_throughput_write, average_iscsi_throughput_total, -average_iscsi_throughput_total, average_iscsi_iops_read, -average_iscsi_iops_read, average_iscsi_iops_write, -average_iscsi_iops_write, average_iscsi_iops_total, -average_iscsi_iops_total, average_network_throughput_transmit, -average_network_throughput_transmit, average_network_throughput_receive, -average_network_throughput_receive] |
EnginePerformanceAnalyticReportResponse
- Content-Type: Not defined
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of performance analytics data of engines. | - |
MaskingExecutionMetricsReportResponse getMaskingExecutionMetricsReport(limit, cursor, sort)
Get the masking execution metrics report.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "name"; // String | The field to sort results by. A property name with a prepended '-' signifies a descending order.
try {
MaskingExecutionMetricsReportResponse result = apiInstance.getMaskingExecutionMetricsReport(limit, cursor, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getMaskingExecutionMetricsReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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 a descending order. | [optional] [enum: id, -id, masking_job_name, -masking_job_name, connector_type, -connector_type, ruleset_name, -ruleset_name, rows_masked, -rows_masked, rows_total, -rows_total, bytes_masked, -bytes_masked, bytes_total, -bytes_total, duration, -duration, tables_files_count, -tables_files_count, masked_tables_files_count, -masked_tables_files_count, columns_fields_count, -columns_fields_count, masked_columns_fields_count, -masked_columns_fields_count, masking_job_type, -masking_job_type] |
MaskingExecutionMetricsReportResponse
- Content-Type: Not defined
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of Masking execution metrics. | - |
ProductInfo getProductInfo()
Returns the DCT Product Information.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
try {
ProductInfo result = apiInstance.getProductInfo();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getProductInfo");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
ReportingSchedule getReportingScheduleById(reportId)
Returns a report schedule by ID.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer reportId = 56; // Integer | The ID of the report schedule.
try {
ReportingSchedule result = apiInstance.getReportingScheduleById(reportId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getReportingScheduleById");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| reportId | Integer | The ID of the report schedule. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
TagsResponse getReportingScheduleTags(reportId)
Get tags for a report schedule.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer reportId = 56; // Integer | The ID of the report schedule.
try {
TagsResponse result = apiInstance.getReportingScheduleTags(reportId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getReportingScheduleTags");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| reportId | Integer | The ID of the report schedule. |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Ok | - |
ListReportingScheduleResponse getReportingSchedules(limit, cursor, sort)
List all report schedules.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(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 = "report_id"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
try {
ListReportingScheduleResponse result = apiInstance.getReportingSchedules(limit, cursor, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getReportingSchedules");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| 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: report_id, -report_id, report_type, -report_type, cron_expression, -cron_expression, time_zone, -time_zone, message, -message, file_format, -file_format, enabled, -enabled, sort_column, -sort_column] |
- Content-Type: Not defined
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
VirtualizationStorageSummaryReportResponse getVirtualizationStorageSummaryReport(limit, cursor, sort)
Gets the storage summary report for virtualization engines.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "engine_id"; // String | The field to sort results by. A property name with a prepended '-' signifies descending order.
try {
VirtualizationStorageSummaryReportResponse result = apiInstance.getVirtualizationStorageSummaryReport(limit, cursor, sort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#getVirtualizationStorageSummaryReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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: engine_id, -engine_id, engine_name, -engine_name, engine_hostname, -engine_hostname, total_capacity, -total_capacity, free_storage, -free_storage, used_storage, -used_storage, used_percentage, -used_percentage, dsource_count, -dsource_count, vdb_count, -vdb_count, total_object_count, -total_object_count] |
VirtualizationStorageSummaryReportResponse
- Content-Type: Not defined
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of storage summary data of virtualization engines. | - |
SearchEngineGlobalObjectStateReportResponse searchEngineGlobalObjectStateReport(limit, cursor, sort, searchBody)
Search the masking engine global object state report.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "engine_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 {
SearchEngineGlobalObjectStateReportResponse result = apiInstance.searchEngineGlobalObjectStateReport(limit, cursor, sort, searchBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#searchEngineGlobalObjectStateReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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: engine_id, -engine_id, engine_name, -engine_name, jobs_count, -jobs_count, connectors_count, -connectors_count, rulesets_count, -rulesets_count, global_object_revision_hash, -global_object_revision_hash] |
| 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 |
SearchEngineGlobalObjectStateReportResponse
- Content-Type: application/json
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of searched GlobalObjectState data. | - |
EnginePerformanceAnalyticTrendResponse searchEnginePerformanceAnalyticTrends(limit, cursor, sort, searchBody)
Search the performance analytic trend data for engines.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "engine_name"; // 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 {
EnginePerformanceAnalyticTrendResponse result = apiInstance.searchEnginePerformanceAnalyticTrends(limit, cursor, sort, searchBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#searchEnginePerformanceAnalyticTrends");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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: engine_id, -engine_id, trend_type, -trend_type, aggregation_period, -aggregation_period] |
| 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 |
EnginePerformanceAnalyticTrendResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of performance analytic trends data of engines. | - |
EnginePerformanceAnalyticReportResponse searchEnginePerformanceAnalyticsReport(limit, cursor, sort, searchBody)
Search the performance analytic report for engines.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "engine_name"; // 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 {
EnginePerformanceAnalyticReportResponse result = apiInstance.searchEnginePerformanceAnalyticsReport(limit, cursor, sort, searchBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#searchEnginePerformanceAnalyticsReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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: engine_id, -engine_id, engine_name, -engine_name, cpu_cores_count, -cpu_cores_count, cpu_utilization, -cpu_utilization, total_memory, -total_memory, average_disk_latency_read, -average_disk_latency_read, average_disk_latency_write, -average_disk_latency_write, average_disk_latency_total, -average_disk_latency_total, average_disk_throughput_read, -average_disk_throughput_read, average_disk_throughput_write, -average_disk_throughput_write, average_disk_throughput_total, -average_disk_throughput_total, average_disk_iops_read, -average_disk_iops_read, average_disk_iops_write, -average_disk_iops_write, average_disk_iops_total, -average_disk_iops_total, average_nfs_latency_read, -average_nfs_latency_read, average_nfs_latency_write, -average_nfs_latency_write, average_nfs_latency_total, -average_nfs_latency_total, average_nfs_throughput_read, -average_nfs_throughput_read, average_nfs_throughput_write, -average_nfs_throughput_write, average_nfs_throughput_total, -average_nfs_throughput_total, average_nfs_iops_read, -average_nfs_iops_read, average_nfs_iops_write, -average_nfs_iops_write, average_nfs_iops_total, -average_nfs_iops_total, average_iscsi_latency_read, -average_iscsi_latency_read, average_iscsi_latency_write, -average_iscsi_latency_write, average_iscsi_latency_total, -average_iscsi_latency_total, average_iscsi_throughput_read, -average_iscsi_throughput_read, average_iscsi_throughput_write, -average_iscsi_throughput_write, average_iscsi_throughput_total, -average_iscsi_throughput_total, average_iscsi_iops_read, -average_iscsi_iops_read, average_iscsi_iops_write, -average_iscsi_iops_write, average_iscsi_iops_total, -average_iscsi_iops_total, average_network_throughput_transmit, -average_network_throughput_transmit, average_network_throughput_receive, -average_network_throughput_receive] |
| 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 |
EnginePerformanceAnalyticReportResponse
- Content-Type: application/json
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of performance analytics data of engines. | - |
MaskingExecutionMetricsReportResponse searchMaskingExecutionMetricsReport(limit, cursor, sort, searchBody)
Search the Masking execution metrics report.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "name"; // String | The field to sort results by. A property name with a prepended '-' signifies a 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 {
MaskingExecutionMetricsReportResponse result = apiInstance.searchMaskingExecutionMetricsReport(limit, cursor, sort, searchBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#searchMaskingExecutionMetricsReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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 a descending order. | [optional] [enum: id, -id, masking_job_name, -masking_job_name, connector_type, -connector_type, ruleset_name, -ruleset_name, rows_masked, -rows_masked, rows_total, -rows_total, bytes_masked, -bytes_masked, bytes_total, -bytes_total, duration, -duration, tables_files_count, -tables_files_count, masked_tables_files_count, -masked_tables_files_count, columns_fields_count, -columns_fields_count, masked_columns_fields_count, -masked_columns_fields_count, masking_job_type, -masking_job_type] |
| 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 |
MaskingExecutionMetricsReportResponse
- Content-Type: application/json
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Search Masking execution metrics. | - |
SearchReportingScheduleResponse searchReportingSchedules(limit, cursor, sort, searchBody)
Search for report schedules.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(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 = "report_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 {
SearchReportingScheduleResponse result = apiInstance.searchReportingSchedules(limit, cursor, sort, searchBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#searchReportingSchedules");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| 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: report_id, -report_id, report_type, -report_type, cron_expression, -cron_expression, time_zone, -time_zone, message, -message, file_format, -file_format, enabled, -enabled, sort_column, -sort_column] |
| 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 |
SearchReportingScheduleResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
VirtualizationStorageSummaryReportResponse searchVirtualizationStorageSummaryReport(limit, cursor, sort, searchBody)
Search the storage summary report for virtualization engines.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer limit = 10000; // Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000.
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 = "engine_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 {
VirtualizationStorageSummaryReportResponse result = apiInstance.searchVirtualizationStorageSummaryReport(limit, cursor, sort, searchBody);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#searchVirtualizationStorageSummaryReport");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| limit | Integer | Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 10000. | [optional] [default to 10000] |
| 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: engine_id, -engine_id, engine_name, -engine_name, engine_hostname, -engine_hostname, total_capacity, -total_capacity, free_storage, -free_storage, used_storage, -used_storage, used_percentage, -used_percentage, dsource_count, -dsource_count, vdb_count, -vdb_count, total_object_count, -total_object_count] |
| 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 |
VirtualizationStorageSummaryReportResponse
- Content-Type: application/json
- Accept: application/json, text/csv
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a list of storage summary data of virtualization engines. | - |
ReportingSchedule updateReportingSchedule(reportId, reportingSchedule)
Update a reporting schedule by ID.
// 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.ReportingApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost/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");
ReportingApi apiInstance = new ReportingApi(defaultClient);
Integer reportId = 56; // Integer | The ID of the report schedule.
ReportingSchedule reportingSchedule = new ReportingSchedule(); // ReportingSchedule |
try {
ReportingSchedule result = apiInstance.updateReportingSchedule(reportId, reportingSchedule);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReportingApi#updateReportingSchedule");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| reportId | Integer | The ID of the report schedule. | |
| reportingSchedule | ReportingSchedule | [optional] |
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |