StagingSourcesApi

All URIs are relative to /v3

Method	HTTP request	Description
createStagingSourceTags	POST /staging-sources/{stagingSourceId}/tags	Create tags for a Staging Source.
deleteStagingSourceTags	POST /staging-sources/{stagingSourceId}/tags/delete	Delete tags for a Staging Source.
getStagingSourceById	GET /staging-sources/{stagingSourceId}	Get a staging source by ID.
getStagingSourceTags	GET /staging-sources/{stagingSourceId}/tags	Get tags for a Staging Source.
getStagingSources	GET /staging-sources	List all staging sources.
searchStagingSources	POST /staging-sources/search	Search for Staging Sources.

createStagingSourceTags

TagsResponse createStagingSourceTags(stagingSourceId, tagsRequest)

Create tags for a Staging Source.

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

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

    StagingSourcesApi apiInstance = new StagingSourcesApi(defaultClient);
    String stagingSourceId = "stagingSourceId_example"; // String | The ID of the staging Source.
    TagsRequest tagsRequest = new TagsRequest(); // TagsRequest | Tags information for Staging Source.
    try {
      TagsResponse result = apiInstance.createStagingSourceTags(stagingSourceId, tagsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StagingSourcesApi#createStagingSourceTags");
      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
stagingSourceId	String	The ID of the staging Source.
tagsRequest	TagsRequest	Tags information for Staging Source.

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	-

deleteStagingSourceTags

deleteStagingSourceTags(stagingSourceId, deleteTag)

Delete tags for a Staging Source.

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

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

    StagingSourcesApi apiInstance = new StagingSourcesApi(defaultClient);
    String stagingSourceId = "stagingSourceId_example"; // String | The ID of the staging Source.
    DeleteTag deleteTag = new DeleteTag(); // DeleteTag | The parameters to delete tags
    try {
      apiInstance.deleteStagingSourceTags(stagingSourceId, deleteTag);
    } catch (ApiException e) {
      System.err.println("Exception when calling StagingSourcesApi#deleteStagingSourceTags");
      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
stagingSourceId	String	The ID of the staging Source.
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	-

getStagingSourceById

StagingSource getStagingSourceById(stagingSourceId)

Get a staging source 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.StagingSourcesApi;

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

    StagingSourcesApi apiInstance = new StagingSourcesApi(defaultClient);
    String stagingSourceId = "stagingSourceId_example"; // String | The ID of the staging Source.
    try {
      StagingSource result = apiInstance.getStagingSourceById(stagingSourceId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StagingSourcesApi#getStagingSourceById");
      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
stagingSourceId	String	The ID of the staging Source.

Return type

StagingSource

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

getStagingSourceTags

TagsResponse getStagingSourceTags(stagingSourceId)

Get tags for a Staging Source.

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

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

    StagingSourcesApi apiInstance = new StagingSourcesApi(defaultClient);
    String stagingSourceId = "stagingSourceId_example"; // String | The ID of the staging Source.
    try {
      TagsResponse result = apiInstance.getStagingSourceTags(stagingSourceId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StagingSourcesApi#getStagingSourceTags");
      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
stagingSourceId	String	The ID of the staging Source.

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	-

getStagingSources

ListStagingSourcesResponse getStagingSources(limit, cursor, sort)

List all staging sources.

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

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

    StagingSourcesApi apiInstance = new StagingSourcesApi(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 {
      ListStagingSourcesResponse result = apiInstance.getStagingSources(limit, cursor, sort);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StagingSourcesApi#getStagingSources");
      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, name, -name, database_type, -database_type, database_name, -database_name, database_version, -database_version, environment_id, -environment_id, data_uuid, -data_uuid, ip_address, -ip_address, fqdn, -fqdn, repository, -repository, oracle_config_type, -oracle_config_type, cdb_type, -cdb_type, dsource_id, -dsource_id]

Return type

ListStagingSourcesResponse

Authorization

ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

searchStagingSources

SearchStagingSourcesResponse searchStagingSources(limit, cursor, sort, searchBody)

Search for Staging Sources.

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

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

    StagingSourcesApi apiInstance = new StagingSourcesApi(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 {
      SearchStagingSourcesResponse result = apiInstance.searchStagingSources(limit, cursor, sort, searchBody);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StagingSourcesApi#searchStagingSources");
      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, name, -name, database_type, -database_type, database_name, -database_name, database_version, -database_version, environment_id, -environment_id, data_uuid, -data_uuid, ip_address, -ip_address, fqdn, -fqdn, repository, -repository, oracle_config_type, -oracle_config_type, cdb_type, -cdb_type, dsource_id, -dsource_id]
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

SearchStagingSourcesResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

Files

StagingSourcesApi.md

Latest commit

History

StagingSourcesApi.md

File metadata and controls

StagingSourcesApi

createStagingSourceTags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteStagingSourceTags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getStagingSourceById

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getStagingSourceTags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getStagingSources

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

searchStagingSources

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details