Skip to content

StreamsServiceApi.md

Latest commit

 

History

History
369 lines (287 loc) · 14.3 KB

StreamsServiceApi.md

File metadata and controls

369 lines (287 loc) · 14.3 KB

StreamsServiceApi

All URIs are relative to http://localhost

Method HTTP request Description
streamsServiceCheckAWSCredentials POST /api/v3/streams/credentials Summary: Check AWS credentials Description: Service to verify AWS credentials.
streamsServiceCheckAzureEventHub POST /api/v3/streams/azure_eventhub Summary: Check Azure event hub Description: Service to check Azure event hub.
streamsServiceCheckAzureStorageString POST /api/v3/streams/azure_storage Summary: Check Azure storage string Description: Service to verify Azure storage connection.
streamsServiceGetAWSRegions GET /api/v3/streams/regions Summary: Get AWS regions Description: Service to get AWS regions.
streamsServiceListAWSStreams POST /api/v3/streams Summary: List AWS streams Description: Service to list AWS Kinesis streams.

streamsServiceCheckAWSCredentials

Streamsv3CheckAWSCredentialsResponse streamsServiceCheckAWSCredentials(streamsv3CheckAWSCredentialsRequest)

Summary: Check AWS credentials Description: Service to verify AWS credentials.

Example

// Import classes:
import com.ibm.security.ApiClient;
import com.ibm.security.ApiException;
import com.ibm.security.Configuration;
import com.ibm.security.auth.*;
import com.ibm.security.models.*;
import com.ibm.security.guardium.StreamsServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

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

    StreamsServiceApi apiInstance = new StreamsServiceApi(defaultClient);
    Streamsv3CheckAWSCredentialsRequest streamsv3CheckAWSCredentialsRequest = new Streamsv3CheckAWSCredentialsRequest(); // Streamsv3CheckAWSCredentialsRequest | 
    try {
      Streamsv3CheckAWSCredentialsResponse result = apiInstance.streamsServiceCheckAWSCredentials(streamsv3CheckAWSCredentialsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StreamsServiceApi#streamsServiceCheckAWSCredentials");
      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
streamsv3CheckAWSCredentialsRequest Streamsv3CheckAWSCredentialsRequest

Return type

Streamsv3CheckAWSCredentialsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

streamsServiceCheckAzureEventHub

Streamsv3CheckAzureEventHubResponse streamsServiceCheckAzureEventHub(streamsv3CheckAzureEventHubRequest)

Summary: Check Azure event hub Description: Service to check Azure event hub.

Example

// Import classes:
import com.ibm.security.ApiClient;
import com.ibm.security.ApiException;
import com.ibm.security.Configuration;
import com.ibm.security.auth.*;
import com.ibm.security.models.*;
import com.ibm.security.guardium.StreamsServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

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

    StreamsServiceApi apiInstance = new StreamsServiceApi(defaultClient);
    Streamsv3CheckAzureEventHubRequest streamsv3CheckAzureEventHubRequest = new Streamsv3CheckAzureEventHubRequest(); // Streamsv3CheckAzureEventHubRequest | 
    try {
      Streamsv3CheckAzureEventHubResponse result = apiInstance.streamsServiceCheckAzureEventHub(streamsv3CheckAzureEventHubRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StreamsServiceApi#streamsServiceCheckAzureEventHub");
      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
streamsv3CheckAzureEventHubRequest Streamsv3CheckAzureEventHubRequest

Return type

Streamsv3CheckAzureEventHubResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

streamsServiceCheckAzureStorageString

Streamsv3CheckAzureStorageStringResponse streamsServiceCheckAzureStorageString(streamsv3CheckAzureStorageStringRequest)

Summary: Check Azure storage string Description: Service to verify Azure storage connection.

Example

// Import classes:
import com.ibm.security.ApiClient;
import com.ibm.security.ApiException;
import com.ibm.security.Configuration;
import com.ibm.security.auth.*;
import com.ibm.security.models.*;
import com.ibm.security.guardium.StreamsServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // 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");

    StreamsServiceApi apiInstance = new StreamsServiceApi(defaultClient);
    Streamsv3CheckAzureStorageStringRequest streamsv3CheckAzureStorageStringRequest = new Streamsv3CheckAzureStorageStringRequest(); // Streamsv3CheckAzureStorageStringRequest | 
    try {
      Streamsv3CheckAzureStorageStringResponse result = apiInstance.streamsServiceCheckAzureStorageString(streamsv3CheckAzureStorageStringRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StreamsServiceApi#streamsServiceCheckAzureStorageString");
      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
streamsv3CheckAzureStorageStringRequest Streamsv3CheckAzureStorageStringRequest

Return type

Streamsv3CheckAzureStorageStringResponse

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

streamsServiceGetAWSRegions

Streamsv3GetAWSRegionsResponse streamsServiceGetAWSRegions()

Summary: Get AWS regions Description: Service to get AWS regions.

Example

// Import classes:
import com.ibm.security.ApiClient;
import com.ibm.security.ApiException;
import com.ibm.security.Configuration;
import com.ibm.security.auth.*;
import com.ibm.security.models.*;
import com.ibm.security.guardium.StreamsServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

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

    StreamsServiceApi apiInstance = new StreamsServiceApi(defaultClient);
    try {
      Streamsv3GetAWSRegionsResponse result = apiInstance.streamsServiceGetAWSRegions();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StreamsServiceApi#streamsServiceGetAWSRegions");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

Streamsv3GetAWSRegionsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

streamsServiceListAWSStreams

Streamsv3ListAWSStreamsResponse streamsServiceListAWSStreams(streamsv3ListAWSStreamsRequest)

Summary: List AWS streams Description: Service to list AWS Kinesis streams.

Example

// Import classes:
import com.ibm.security.ApiClient;
import com.ibm.security.ApiException;
import com.ibm.security.Configuration;
import com.ibm.security.auth.*;
import com.ibm.security.models.*;
import com.ibm.security.guardium.StreamsServiceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

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

    StreamsServiceApi apiInstance = new StreamsServiceApi(defaultClient);
    Streamsv3ListAWSStreamsRequest streamsv3ListAWSStreamsRequest = new Streamsv3ListAWSStreamsRequest(); // Streamsv3ListAWSStreamsRequest | 
    try {
      Streamsv3ListAWSStreamsResponse result = apiInstance.streamsServiceListAWSStreams(streamsv3ListAWSStreamsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling StreamsServiceApi#streamsServiceListAWSStreams");
      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
streamsv3ListAWSStreamsRequest Streamsv3ListAWSStreamsRequest

Return type

Streamsv3ListAWSStreamsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -