Skip to content

Latest commit

 

History

History
223 lines (174 loc) · 15.8 KB

VirtualizationPoliciesApi.md

File metadata and controls

223 lines (174 loc) · 15.8 KB
Raw

VirtualizationPoliciesApi

All URIs are relative to /v3

Method HTTP request Description
getVirtualizationPolicyById GET /virtualization-policies/{policyId} Fetch a virtualization policy by Id.
listVirtualizationPolicies GET /virtualization-policies Fetch a list of all virtualization policies
searchVirtualizationPolicies POST /virtualization-policies/search Search Virtualization Policies.

getVirtualizationPolicyById

VirtualizationPolicy getVirtualizationPolicyById(policyId)

Fetch a virtualization policy 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.VirtualizationPoliciesApi;

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");

    VirtualizationPoliciesApi apiInstance = new VirtualizationPoliciesApi(defaultClient);
    String policyId = "policyId_example"; // String | The ID of the Virtualization Policy.
    try {
      VirtualizationPolicy result = apiInstance.getVirtualizationPolicyById(policyId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualizationPoliciesApi#getVirtualizationPolicyById");
      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
policyId String The ID of the Virtualization Policy.

Return type

VirtualizationPolicy

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Retuns a single virtualization policy -
404 Virtualization policy not found -

listVirtualizationPolicies

ListVirtualizationPoliciesResponse listVirtualizationPolicies(limit, cursor, sort)

Fetch a list of all virtualization policies

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.VirtualizationPoliciesApi;

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");

    VirtualizationPoliciesApi apiInstance = new VirtualizationPoliciesApi(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 a descending order.
    try {
      ListVirtualizationPoliciesResponse result = apiInstance.listVirtualizationPolicies(limit, cursor, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualizationPoliciesApi#listVirtualizationPolicies");
      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 a descending order. [optional] [enum: id, -id, name, -name, engine_id, -engine_id, policy_type, -policy_type, timezone_id, -timezone_id, default_policy, -default_policy, effective_type, -effective_type, data_duration, -data_duration, data_unit, -data_unit, log_duration, -log_duration, log_unit, -log_unit, num_of_daily, -num_of_daily, num_of_weekly, -num_of_weekly, day_of_week, -day_of_week, num_of_monthly, -num_of_monthly, day_of_month, -day_of_month, num_of_yearly, -num_of_yearly, day_of_year, -day_of_year, size, -size]

Return type

ListVirtualizationPoliciesResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

searchVirtualizationPolicies

SearchVirtualizationPoliciesResponse searchVirtualizationPolicies(limit, cursor, sort, searchBody)

Search Virtualization Policies.

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.VirtualizationPoliciesApi;

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");

    VirtualizationPoliciesApi apiInstance = new VirtualizationPoliciesApi(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 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 {
      SearchVirtualizationPoliciesResponse result = apiInstance.searchVirtualizationPolicies(limit, cursor, sort, searchBody);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling VirtualizationPoliciesApi#searchVirtualizationPolicies");
      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 a descending order. [optional] [enum: id, -id, name, -name, engine_id, -engine_id, policy_type, -policy_type, timezone_id, -timezone_id, default_policy, -default_policy, effective_type, -effective_type, data_duration, -data_duration, data_unit, -data_unit, log_duration, -log_duration, log_unit, -log_unit, num_of_daily, -num_of_daily, num_of_weekly, -num_of_weekly, day_of_week, -day_of_week, num_of_monthly, -num_of_monthly, day_of_month, -day_of_month, num_of_yearly, -num_of_yearly, day_of_year, -day_of_year, size, -size]
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

SearchVirtualizationPoliciesResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -