Skip to content

Latest commit

 

History

History
300 lines (187 loc) · 8.97 KB

StreamsServiceApi.md

File metadata and controls

300 lines (187 loc) · 8.97 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)

Example

import { createConfiguration, StreamsServiceApi } from '';
import type { StreamsServiceApiStreamsServiceCheckAWSCredentialsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new StreamsServiceApi(configuration);

const request: StreamsServiceApiStreamsServiceCheckAWSCredentialsRequest = {
  
  streamsv3CheckAWSCredentialsRequest: {
    accessKeyId: "accessKeyId_example",
    authType: "SECURITY_CREDENTIALS",
    id: "id_example",
    region: "region_example",
    roleArn: "roleArn_example",
    secretKeyId: "secretKeyId_example",
    streamName: "streamName_example",
    streamType: "AWS_KINESIS",
  },
};

const data = await apiInstance.streamsServiceCheckAWSCredentials(request);
console.log('API called successfully. Returned data:', data);

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

streamsServiceCheckAzureEventHub

Streamsv3CheckAzureEventHubResponse streamsServiceCheckAzureEventHub(streamsv3CheckAzureEventHubRequest)

Example

import { createConfiguration, StreamsServiceApi } from '';
import type { StreamsServiceApiStreamsServiceCheckAzureEventHubRequest } from '';

const configuration = createConfiguration();
const apiInstance = new StreamsServiceApi(configuration);

const request: StreamsServiceApiStreamsServiceCheckAzureEventHubRequest = {
  
  streamsv3CheckAzureEventHubRequest: {
    accessKeyId: "accessKeyId_example",
    id: "id_example",
    namespace: "namespace_example",
    secretKeyId: "secretKeyId_example",
    streamName: "streamName_example",
    streamType: "AWS_KINESIS",
  },
};

const data = await apiInstance.streamsServiceCheckAzureEventHub(request);
console.log('API called successfully. Returned data:', data);

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

streamsServiceCheckAzureStorageString

Streamsv3CheckAzureStorageStringResponse streamsServiceCheckAzureStorageString(streamsv3CheckAzureStorageStringRequest)

Example

import { createConfiguration, StreamsServiceApi } from '';
import type { StreamsServiceApiStreamsServiceCheckAzureStorageStringRequest } from '';

const configuration = createConfiguration();
const apiInstance = new StreamsServiceApi(configuration);

const request: StreamsServiceApiStreamsServiceCheckAzureStorageStringRequest = {
  
  streamsv3CheckAzureStorageStringRequest: {
    connectionString: "connectionString_example",
  },
};

const data = await apiInstance.streamsServiceCheckAzureStorageString(request);
console.log('API called successfully. Returned data:', data);

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

streamsServiceGetAWSRegions

Streamsv3GetAWSRegionsResponse streamsServiceGetAWSRegions()

Example

import { createConfiguration, StreamsServiceApi } from '';

const configuration = createConfiguration();
const apiInstance = new StreamsServiceApi(configuration);

const request = {};

const data = await apiInstance.streamsServiceGetAWSRegions(request);
console.log('API called successfully. Returned data:', data);

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

streamsServiceListAWSStreams

Streamsv3ListAWSStreamsResponse streamsServiceListAWSStreams(streamsv3ListAWSStreamsRequest)

Example

import { createConfiguration, StreamsServiceApi } from '';
import type { StreamsServiceApiStreamsServiceListAWSStreamsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new StreamsServiceApi(configuration);

const request: StreamsServiceApiStreamsServiceListAWSStreamsRequest = {
  
  streamsv3ListAWSStreamsRequest: {
    accessKeyId: "accessKeyId_example",
    authType: "SECURITY_CREDENTIALS",
    id: "id_example",
    region: [
      "region_example",
    ],
    roleArn: "roleArn_example",
    secretKeyId: "secretKeyId_example",
    streamType: "AWS_KINESIS",
  },
};

const data = await apiInstance.streamsServiceListAWSStreams(request);
console.log('API called successfully. Returned data:', data);

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]