Cloudera Documentation

Cloudera Streams Messaging Manager REST API Reference

AggregatedMetricOperations

getAllConsumerGroupMetrics

Get all consumer group details.


/api/v2/admin/metrics/aggregated/groups

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/groups?duration=&from=&to=&state=&includeProducerMetrics=&includeAssignments="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        Boolean includeProducerMetrics = true; // Boolean | Include Producer Metrics
        Boolean includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info
        try {
            array[AggrConsumerMetrics] result = apiInstance.getAllConsumerGroupMetrics(duration, from, to, state, includeProducerMetrics, includeAssignments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getAllConsumerGroupMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        Boolean includeProducerMetrics = true; // Boolean | Include Producer Metrics
        Boolean includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info
        try {
            array[AggrConsumerMetrics] result = apiInstance.getAllConsumerGroupMetrics(duration, from, to, state, includeProducerMetrics, includeAssignments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getAllConsumerGroupMetrics");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Client (optional)
Boolean *includeProducerMetrics = true; // Include Producer Metrics (optional)
Boolean *includeAssignments = true; // Include Individual ConsumerInstance to TopicPartition Assignment Info (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get all consumer group details.
[apiInstance getAllConsumerGroupMetricsWith:duration
    from:from
    to:to
    state:state
    includeProducerMetrics:includeProducerMetrics
    includeAssignments:includeAssignments
              completionHandler: ^(array[AggrConsumerMetrics] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example, // {{String}} State of the Client
  'includeProducerMetrics': true, // {{Boolean}} Include Producer Metrics
  'includeAssignments': true // {{Boolean}} Include Individual ConsumerInstance to TopicPartition Assignment Info
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllConsumerGroupMetrics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllConsumerGroupMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Client (optional) 
            var includeProducerMetrics = true;  // Boolean | Include Producer Metrics (optional) 
            var includeAssignments = true;  // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info (optional) 

            try
            {
                // Get all consumer group details.
                array[AggrConsumerMetrics] result = apiInstance.getAllConsumerGroupMetrics(duration, from, to, state, includeProducerMetrics, includeAssignments);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getAllConsumerGroupMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Client
$includeProducerMetrics = true; // Boolean | Include Producer Metrics
$includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info

try {
    $result = $api_instance->getAllConsumerGroupMetrics($duration, $from, $to, $state, $includeProducerMetrics, $includeAssignments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getAllConsumerGroupMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Client
my $includeProducerMetrics = true; # Boolean | Include Producer Metrics
my $includeAssignments = true; # Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info

eval { 
    my $result = $api_instance->getAllConsumerGroupMetrics(duration => $duration, from => $from, to => $to, state => $state, includeProducerMetrics => $includeProducerMetrics, includeAssignments => $includeAssignments);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getAllConsumerGroupMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Client (optional)
includeProducerMetrics = true # Boolean | Include Producer Metrics (optional)
includeAssignments = true # Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info (optional)

try: 
    # Get all consumer group details.
    api_response = api_instance.get_all_consumer_group_metrics(duration=duration, from=from, to=to, state=state, includeProducerMetrics=includeProducerMetrics, includeAssignments=includeAssignments)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getAllConsumerGroupMetrics: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Client
includeProducerMetrics
Boolean
Include Producer Metrics
includeAssignments
Boolean
Include Individual ConsumerInstance to TopicPartition Assignment Info

Responses

Status: 200 - successful operation


getAllProducerMetrics

Get producer metrics for all the alive producers


/api/v2/admin/metrics/aggregated/producers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/producers?duration=&from=&to=&state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        try {
            array[AggrProducerMetrics] result = apiInstance.getAllProducerMetrics(duration, from, to, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getAllProducerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        try {
            array[AggrProducerMetrics] result = apiInstance.getAllProducerMetrics(duration, from, to, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getAllProducerMetrics");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Client (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get producer metrics for all the alive producers
[apiInstance getAllProducerMetricsWith:duration
    from:from
    to:to
    state:state
              completionHandler: ^(array[AggrProducerMetrics] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example // {{String}} State of the Client
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllProducerMetrics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllProducerMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Client (optional) 

            try
            {
                // Get producer metrics for all the alive producers
                array[AggrProducerMetrics] result = apiInstance.getAllProducerMetrics(duration, from, to, state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getAllProducerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Client

try {
    $result = $api_instance->getAllProducerMetrics($duration, $from, $to, $state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getAllProducerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Client

eval { 
    my $result = $api_instance->getAllProducerMetrics(duration => $duration, from => $from, to => $to, state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getAllProducerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Client (optional)

try: 
    # Get producer metrics for all the alive producers
    api_response = api_instance.get_all_producer_metrics(duration=duration, from=from, to=to, state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getAllProducerMetrics: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Client

Responses

Status: 200 - successful operation


getBrokerDetails1

Get broker details with metrics for a given brokerId


/api/v2/admin/metrics/aggregated/brokers/{brokerId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/brokers/{brokerId}?duration=&from=&to=&includeClientDetails="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        Integer brokerId = 56; // Integer | Broker setId
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        Boolean includeClientDetails = true; // Boolean | Flag to request client details
        try {
            BrokerDetails result = apiInstance.getBrokerDetails1(brokerId, duration, from, to, includeClientDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getBrokerDetails1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        Integer brokerId = 56; // Integer | Broker setId
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        Boolean includeClientDetails = true; // Boolean | Flag to request client details
        try {
            BrokerDetails result = apiInstance.getBrokerDetails1(brokerId, duration, from, to, includeClientDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getBrokerDetails1");
            e.printStackTrace();
        }
    }
}
Integer *brokerId = 56; // Broker setId
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
Boolean *includeClientDetails = true; // Flag to request client details (optional) (default to false)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get broker details with metrics for a given brokerId
[apiInstance getBrokerDetails1With:brokerId
    duration:duration
    from:from
    to:to
    includeClientDetails:includeClientDetails
              completionHandler: ^(BrokerDetails output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var brokerId = 56; // {{Integer}} Broker setId
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'includeClientDetails': true // {{Boolean}} Flag to request client details
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokerDetails1(brokerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokerDetails1Example
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var brokerId = 56;  // Integer | Broker setId
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var includeClientDetails = true;  // Boolean | Flag to request client details (optional)  (default to false)

            try
            {
                // Get broker details with metrics for a given brokerId
                BrokerDetails result = apiInstance.getBrokerDetails1(brokerId, duration, from, to, includeClientDetails);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getBrokerDetails1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$brokerId = 56; // Integer | Broker setId
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$includeClientDetails = true; // Boolean | Flag to request client details

try {
    $result = $api_instance->getBrokerDetails1($brokerId, $duration, $from, $to, $includeClientDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getBrokerDetails1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $brokerId = 56; # Integer | Broker setId
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $includeClientDetails = true; # Boolean | Flag to request client details

eval { 
    my $result = $api_instance->getBrokerDetails1(brokerId => $brokerId, duration => $duration, from => $from, to => $to, includeClientDetails => $includeClientDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getBrokerDetails1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
brokerId = 56 # Integer | Broker setId
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
includeClientDetails = true # Boolean | Flag to request client details (optional) (default to false)

try: 
    # Get broker details with metrics for a given brokerId
    api_response = api_instance.get_broker_details1(brokerId, duration=duration, from=from, to=to, includeClientDetails=includeClientDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getBrokerDetails1: %s\n" % e)

Parameters

Path parameters
Name Description
brokerId*
Integer (int32)
Broker setId
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
includeClientDetails
Boolean
Flag to request client details

Responses

Status: 200 - successful operation


getClusterWithBrokerMetrics

Get cluster with broker metrics


/api/v2/admin/metrics/aggregated/brokers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/brokers?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ClusterWithBrokerMetrics result = apiInstance.getClusterWithBrokerMetrics(duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getClusterWithBrokerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ClusterWithBrokerMetrics result = apiInstance.getClusterWithBrokerMetrics(duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getClusterWithBrokerMetrics");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get cluster with broker metrics
[apiInstance getClusterWithBrokerMetricsWith:duration
    from:from
    to:to
              completionHandler: ^(ClusterWithBrokerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClusterWithBrokerMetrics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getClusterWithBrokerMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get cluster with broker metrics
                ClusterWithBrokerMetrics result = apiInstance.getClusterWithBrokerMetrics(duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getClusterWithBrokerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getClusterWithBrokerMetrics($duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getClusterWithBrokerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getClusterWithBrokerMetrics(duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getClusterWithBrokerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get cluster with broker metrics
    api_response = api_instance.get_cluster_with_broker_metrics(duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getClusterWithBrokerMetrics: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


getClusterWithTopicMetrics

Get cluster with topic metrics


/api/v2/admin/metrics/aggregated/topics

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/topics?duration=&from=&to=&state=&includeClientDetails=&includePartitionDetails="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        Boolean includeClientDetails = true; // Boolean | Flag to request client details
        Boolean includePartitionDetails = true; // Boolean | Flag to request partition metrics
        try {
            ClusterWithTopicMetrics result = apiInstance.getClusterWithTopicMetrics(duration, from, to, state, includeClientDetails, includePartitionDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getClusterWithTopicMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        Boolean includeClientDetails = true; // Boolean | Flag to request client details
        Boolean includePartitionDetails = true; // Boolean | Flag to request partition metrics
        try {
            ClusterWithTopicMetrics result = apiInstance.getClusterWithTopicMetrics(duration, from, to, state, includeClientDetails, includePartitionDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getClusterWithTopicMetrics");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Client (optional)
Boolean *includeClientDetails = true; // Flag to request client details (optional) (default to false)
Boolean *includePartitionDetails = true; // Flag to request partition metrics (optional) (default to false)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get cluster with topic metrics
[apiInstance getClusterWithTopicMetricsWith:duration
    from:from
    to:to
    state:state
    includeClientDetails:includeClientDetails
    includePartitionDetails:includePartitionDetails
              completionHandler: ^(ClusterWithTopicMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example, // {{String}} State of the Client
  'includeClientDetails': true, // {{Boolean}} Flag to request client details
  'includePartitionDetails': true // {{Boolean}} Flag to request partition metrics
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClusterWithTopicMetrics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getClusterWithTopicMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Client (optional) 
            var includeClientDetails = true;  // Boolean | Flag to request client details (optional)  (default to false)
            var includePartitionDetails = true;  // Boolean | Flag to request partition metrics (optional)  (default to false)

            try
            {
                // Get cluster with topic metrics
                ClusterWithTopicMetrics result = apiInstance.getClusterWithTopicMetrics(duration, from, to, state, includeClientDetails, includePartitionDetails);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getClusterWithTopicMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Client
$includeClientDetails = true; // Boolean | Flag to request client details
$includePartitionDetails = true; // Boolean | Flag to request partition metrics

try {
    $result = $api_instance->getClusterWithTopicMetrics($duration, $from, $to, $state, $includeClientDetails, $includePartitionDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getClusterWithTopicMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Client
my $includeClientDetails = true; # Boolean | Flag to request client details
my $includePartitionDetails = true; # Boolean | Flag to request partition metrics

eval { 
    my $result = $api_instance->getClusterWithTopicMetrics(duration => $duration, from => $from, to => $to, state => $state, includeClientDetails => $includeClientDetails, includePartitionDetails => $includePartitionDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getClusterWithTopicMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Client (optional)
includeClientDetails = true # Boolean | Flag to request client details (optional) (default to false)
includePartitionDetails = true # Boolean | Flag to request partition metrics (optional) (default to false)

try: 
    # Get cluster with topic metrics
    api_response = api_instance.get_cluster_with_topic_metrics(duration=duration, from=from, to=to, state=state, includeClientDetails=includeClientDetails, includePartitionDetails=includePartitionDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getClusterWithTopicMetrics: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Client
includeClientDetails
Boolean
Flag to request client details
includePartitionDetails
Boolean
Flag to request partition metrics

Responses

Status: 200 - successful operation


getConsumerGroupMetrics

Get consumer group details for the given groupName.


/api/v2/admin/metrics/aggregated/groups/{groupName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/groups/{groupName}?duration=&from=&to=&state=&includeProducerMetrics=&includeAssignments="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String groupName = groupName_example; // String | Name of the consumer group
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Producer
        Boolean includeProducerMetrics = true; // Boolean | Include Producer Metrics
        Boolean includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info
        try {
            AggrConsumerMetrics result = apiInstance.getConsumerGroupMetrics(groupName, duration, from, to, state, includeProducerMetrics, includeAssignments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getConsumerGroupMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String groupName = groupName_example; // String | Name of the consumer group
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Producer
        Boolean includeProducerMetrics = true; // Boolean | Include Producer Metrics
        Boolean includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info
        try {
            AggrConsumerMetrics result = apiInstance.getConsumerGroupMetrics(groupName, duration, from, to, state, includeProducerMetrics, includeAssignments);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getConsumerGroupMetrics");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // Name of the consumer group
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Producer (optional)
Boolean *includeProducerMetrics = true; // Include Producer Metrics (optional)
Boolean *includeAssignments = true; // Include Individual ConsumerInstance to TopicPartition Assignment Info (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get consumer group details for the given groupName.
[apiInstance getConsumerGroupMetricsWith:groupName
    duration:duration
    from:from
    to:to
    state:state
    includeProducerMetrics:includeProducerMetrics
    includeAssignments:includeAssignments
              completionHandler: ^(AggrConsumerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var groupName = groupName_example; // {{String}} Name of the consumer group
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example, // {{String}} State of the Producer
  'includeProducerMetrics': true, // {{Boolean}} Include Producer Metrics
  'includeAssignments': true // {{Boolean}} Include Individual ConsumerInstance to TopicPartition Assignment Info
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupMetrics(groupName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var groupName = groupName_example;  // String | Name of the consumer group
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Producer (optional) 
            var includeProducerMetrics = true;  // Boolean | Include Producer Metrics (optional) 
            var includeAssignments = true;  // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info (optional) 

            try
            {
                // Get consumer group details for the given groupName.
                AggrConsumerMetrics result = apiInstance.getConsumerGroupMetrics(groupName, duration, from, to, state, includeProducerMetrics, includeAssignments);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getConsumerGroupMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$groupName = groupName_example; // String | Name of the consumer group
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Producer
$includeProducerMetrics = true; // Boolean | Include Producer Metrics
$includeAssignments = true; // Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info

try {
    $result = $api_instance->getConsumerGroupMetrics($groupName, $duration, $from, $to, $state, $includeProducerMetrics, $includeAssignments);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getConsumerGroupMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $groupName = groupName_example; # String | Name of the consumer group
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Producer
my $includeProducerMetrics = true; # Boolean | Include Producer Metrics
my $includeAssignments = true; # Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info

eval { 
    my $result = $api_instance->getConsumerGroupMetrics(groupName => $groupName, duration => $duration, from => $from, to => $to, state => $state, includeProducerMetrics => $includeProducerMetrics, includeAssignments => $includeAssignments);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getConsumerGroupMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
groupName = groupName_example # String | Name of the consumer group
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Producer (optional)
includeProducerMetrics = true # Boolean | Include Producer Metrics (optional)
includeAssignments = true # Boolean | Include Individual ConsumerInstance to TopicPartition Assignment Info (optional)

try: 
    # Get consumer group details for the given groupName.
    api_response = api_instance.get_consumer_group_metrics(groupName, duration=duration, from=from, to=to, state=state, includeProducerMetrics=includeProducerMetrics, includeAssignments=includeAssignments)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getConsumerGroupMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
String
Name of the consumer group
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Producer
includeProducerMetrics
Boolean
Include Producer Metrics
includeAssignments
Boolean
Include Individual ConsumerInstance to TopicPartition Assignment Info

Responses

Status: 200 - successful operation


getProducerMetrics

Get producer metrics for the given producerClientId


/api/v2/admin/metrics/aggregated/producers/{producerClientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/producers/{producerClientId}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String producerClientId = producerClientId_example; // String | Producer client identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            AggrProducerMetrics result = apiInstance.getProducerMetrics(producerClientId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getProducerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String producerClientId = producerClientId_example; // String | Producer client identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            AggrProducerMetrics result = apiInstance.getProducerMetrics(producerClientId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getProducerMetrics");
            e.printStackTrace();
        }
    }
}
String *producerClientId = producerClientId_example; // Producer client identifier
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get producer metrics for the given producerClientId
[apiInstance getProducerMetricsWith:producerClientId
    duration:duration
    from:from
    to:to
              completionHandler: ^(AggrProducerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var producerClientId = producerClientId_example; // {{String}} Producer client identifier
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducerMetrics(producerClientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProducerMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var producerClientId = producerClientId_example;  // String | Producer client identifier
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get producer metrics for the given producerClientId
                AggrProducerMetrics result = apiInstance.getProducerMetrics(producerClientId, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getProducerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$producerClientId = producerClientId_example; // String | Producer client identifier
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getProducerMetrics($producerClientId, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getProducerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $producerClientId = producerClientId_example; # String | Producer client identifier
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getProducerMetrics(producerClientId => $producerClientId, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getProducerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
producerClientId = producerClientId_example # String | Producer client identifier
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get producer metrics for the given producerClientId
    api_response = api_instance.get_producer_metrics(producerClientId, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getProducerMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
producerClientId*
String
Producer client identifier
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


getTopicMetrics

Get topic metrics for the given topic


/api/v2/admin/metrics/aggregated/topics/{topicName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/aggregated/topics/{topicName}?duration=&from=&to=&state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AggregatedMetricOperationsApi;

import java.io.File;
import java.util.*;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String topicName = topicName_example; // String | Name of the topic
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        try {
            AggrTopicMetrics result = apiInstance.getTopicMetrics(topicName, duration, from, to, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getTopicMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AggregatedMetricOperationsApi;

public class AggregatedMetricOperationsApiExample {

    public static void main(String[] args) {
        AggregatedMetricOperationsApi apiInstance = new AggregatedMetricOperationsApi();
        String topicName = topicName_example; // String | Name of the topic
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String state = state_example; // String | State of the Client
        try {
            AggrTopicMetrics result = apiInstance.getTopicMetrics(topicName, duration, from, to, state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AggregatedMetricOperationsApi#getTopicMetrics");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Name of the topic
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *state = state_example; // State of the Client (optional)

AggregatedMetricOperationsApi *apiInstance = [[AggregatedMetricOperationsApi alloc] init];

// Get topic metrics for the given topic
[apiInstance getTopicMetricsWith:topicName
    duration:duration
    from:from
    to:to
    state:state
              completionHandler: ^(AggrTopicMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AggregatedMetricOperationsApi()
var topicName = topicName_example; // {{String}} Name of the topic
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'state': state_example // {{String}} State of the Client
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicMetrics(topicName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicMetricsExample
    {
        public void main()
        {

            var apiInstance = new AggregatedMetricOperationsApi();
            var topicName = topicName_example;  // String | Name of the topic
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var state = state_example;  // String | State of the Client (optional) 

            try
            {
                // Get topic metrics for the given topic
                AggrTopicMetrics result = apiInstance.getTopicMetrics(topicName, duration, from, to, state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AggregatedMetricOperationsApi.getTopicMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAggregatedMetricOperationsApi();
$topicName = topicName_example; // String | Name of the topic
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$state = state_example; // String | State of the Client

try {
    $result = $api_instance->getTopicMetrics($topicName, $duration, $from, $to, $state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AggregatedMetricOperationsApi->getTopicMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AggregatedMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::AggregatedMetricOperationsApi->new();
my $topicName = topicName_example; # String | Name of the topic
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $state = state_example; # String | State of the Client

eval { 
    my $result = $api_instance->getTopicMetrics(topicName => $topicName, duration => $duration, from => $from, to => $to, state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AggregatedMetricOperationsApi->getTopicMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AggregatedMetricOperationsApi()
topicName = topicName_example # String | Name of the topic
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
state = state_example # String | State of the Client (optional)

try: 
    # Get topic metrics for the given topic
    api_response = api_instance.get_topic_metrics(topicName, duration=duration, from=from, to=to, state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AggregatedMetricOperationsApi->getTopicMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Name of the topic
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
state
String
State of the Client

Responses

Status: 200 - successful operation


AlertNotifications

getAlertNotifications

Get the Alert notifications from the given `offset`, up to the given `limit`. If the offset is `-1`, it will return `limit` number of latest notifications, If the offset is `-2`, it will return `limit` number of earliest notifications.Default value of offset param is -1.


/api/v1/admin/alert/notifications

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alert/notifications?limit=&startOffset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        Integer limit = 56; // Integer | limit value should be greater than zero
        Long startOffset = 789; // Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)
        try {
            AlertNotifications result = apiInstance.getAlertNotifications(limit, startOffset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        Integer limit = 56; // Integer | limit value should be greater than zero
        Long startOffset = 789; // Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)
        try {
            AlertNotifications result = apiInstance.getAlertNotifications(limit, startOffset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotifications");
            e.printStackTrace();
        }
    }
}
Integer *limit = 56; // limit value should be greater than zero (optional)
Long *startOffset = 789; // start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications) (optional) (default to -1)

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Get the Alert notifications from the given `offset`, up to the given `limit`. If the offset is `-1`, it will return `limit` number of latest notifications, If the offset is `-2`, it will return `limit` number of earliest notifications.Default value of offset param is -1.
[apiInstance getAlertNotificationsWith:limit
    startOffset:startOffset
              completionHandler: ^(AlertNotifications output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var opts = { 
  'limit': 56, // {{Integer}} limit value should be greater than zero
  'startOffset': 789 // {{Long}} start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertNotifications(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertNotificationsExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var limit = 56;  // Integer | limit value should be greater than zero (optional) 
            var startOffset = 789;  // Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications) (optional)  (default to -1)

            try
            {
                // Get the Alert notifications from the given `offset`, up to the given `limit`. If the offset is `-1`, it will return `limit` number of latest notifications, If the offset is `-2`, it will return `limit` number of earliest notifications.Default value of offset param is -1.
                AlertNotifications result = apiInstance.getAlertNotifications(limit, startOffset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.getAlertNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$limit = 56; // Integer | limit value should be greater than zero
$startOffset = 789; // Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)

try {
    $result = $api_instance->getAlertNotifications($limit, $startOffset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->getAlertNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $limit = 56; # Integer | limit value should be greater than zero
my $startOffset = 789; # Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)

eval { 
    my $result = $api_instance->getAlertNotifications(limit => $limit, startOffset => $startOffset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->getAlertNotifications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
limit = 56 # Integer | limit value should be greater than zero (optional)
startOffset = 789 # Long | start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications) (optional) (default to -1)

try: 
    # Get the Alert notifications from the given `offset`, up to the given `limit`. If the offset is `-1`, it will return `limit` number of latest notifications, If the offset is `-2`, it will return `limit` number of earliest notifications.Default value of offset param is -1.
    api_response = api_instance.get_alert_notifications(limit=limit, startOffset=startOffset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->getAlertNotifications: %s\n" % e)

Parameters

Query parameters
Name Description
limit
Integer (int32)
limit value should be greater than zero
startOffset
Long (int64)
start offset should be greater than or equal to -2 (-2 is to fetch earliest notifications/ -1 is to fetch latest notifications)

Responses

Status: 200 - successful operation


getAlertNotificationsByEntityType

Get all the Alert notifications for a given entity type


/api/v1/admin/alert/notifications/entity/{entityType}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alert/notifications/entity/{entityType}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        String entityType = entityType_example; // String | Type of the entity
        try {
            map['String', array[AlertNotificationContext]] result = apiInstance.getAlertNotificationsByEntityType(entityType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotificationsByEntityType");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        String entityType = entityType_example; // String | Type of the entity
        try {
            map['String', array[AlertNotificationContext]] result = apiInstance.getAlertNotificationsByEntityType(entityType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotificationsByEntityType");
            e.printStackTrace();
        }
    }
}
String *entityType = entityType_example; // Type of the entity

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Get all the Alert notifications for a given entity type
[apiInstance getAlertNotificationsByEntityTypeWith:entityType
              completionHandler: ^(map['String', array[AlertNotificationContext]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var entityType = entityType_example; // {{String}} Type of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertNotificationsByEntityType(entityType, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertNotificationsByEntityTypeExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var entityType = entityType_example;  // String | Type of the entity

            try
            {
                // Get all the Alert notifications for a given entity type
                map['String', array[AlertNotificationContext]] result = apiInstance.getAlertNotificationsByEntityType(entityType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.getAlertNotificationsByEntityType: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$entityType = entityType_example; // String | Type of the entity

try {
    $result = $api_instance->getAlertNotificationsByEntityType($entityType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityType: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $entityType = entityType_example; # String | Type of the entity

eval { 
    my $result = $api_instance->getAlertNotificationsByEntityType(entityType => $entityType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityType: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
entityType = entityType_example # String | Type of the entity

try: 
    # Get all the Alert notifications for a given entity type
    api_response = api_instance.get_alert_notifications_by_entity_type(entityType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityType: %s\n" % e)

Parameters

Path parameters
Name Description
entityType*
String
Type of the entity
Required

Responses

Status: 200 - successful operation


getAlertNotificationsByEntityTypeAndName

Get the Alert notifications for the given entity type and resource name


/api/v1/admin/alert/notifications/entity/{entityType}/{entityName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alert/notifications/entity/{entityType}/{entityName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        String entityType = entityType_example; // String | Type of the entity
        String entityName = entityName_example; // String | Name of the entity
        try {
            array[AlertNotificationContext] result = apiInstance.getAlertNotificationsByEntityTypeAndName(entityType, entityName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotificationsByEntityTypeAndName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        String entityType = entityType_example; // String | Type of the entity
        String entityName = entityName_example; // String | Name of the entity
        try {
            array[AlertNotificationContext] result = apiInstance.getAlertNotificationsByEntityTypeAndName(entityType, entityName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#getAlertNotificationsByEntityTypeAndName");
            e.printStackTrace();
        }
    }
}
String *entityType = entityType_example; // Type of the entity
String *entityName = entityName_example; // Name of the entity

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Get the Alert notifications for the given entity type and resource name
[apiInstance getAlertNotificationsByEntityTypeAndNameWith:entityType
    entityName:entityName
              completionHandler: ^(array[AlertNotificationContext] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var entityType = entityType_example; // {{String}} Type of the entity
var entityName = entityName_example; // {{String}} Name of the entity

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertNotificationsByEntityTypeAndName(entityType, entityName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertNotificationsByEntityTypeAndNameExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var entityType = entityType_example;  // String | Type of the entity
            var entityName = entityName_example;  // String | Name of the entity

            try
            {
                // Get the Alert notifications for the given entity type and resource name
                array[AlertNotificationContext] result = apiInstance.getAlertNotificationsByEntityTypeAndName(entityType, entityName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.getAlertNotificationsByEntityTypeAndName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$entityType = entityType_example; // String | Type of the entity
$entityName = entityName_example; // String | Name of the entity

try {
    $result = $api_instance->getAlertNotificationsByEntityTypeAndName($entityType, $entityName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityTypeAndName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $entityType = entityType_example; # String | Type of the entity
my $entityName = entityName_example; # String | Name of the entity

eval { 
    my $result = $api_instance->getAlertNotificationsByEntityTypeAndName(entityType => $entityType, entityName => $entityName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityTypeAndName: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
entityType = entityType_example # String | Type of the entity
entityName = entityName_example # String | Name of the entity

try: 
    # Get the Alert notifications for the given entity type and resource name
    api_response = api_instance.get_alert_notifications_by_entity_type_and_name(entityType, entityName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->getAlertNotificationsByEntityTypeAndName: %s\n" % e)

Parameters

Path parameters
Name Description
entityType*
String
Type of the entity
Required
entityName*
String
Name of the entity
Required

Responses

Status: 200 - successful operation


markAlertNotifications

Mark the Alert notifications as read


/api/v1/admin/alert/notifications/read

Usage and SDK Samples

curl -X PUT\
"//api/v1/admin/alert/notifications/read?offsets="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        array[Long] offsets = ; // array[Long] | notification offset
        try {
            apiInstance.markAlertNotifications(offsets);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#markAlertNotifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        array[Long] offsets = ; // array[Long] | notification offset
        try {
            apiInstance.markAlertNotifications(offsets);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#markAlertNotifications");
            e.printStackTrace();
        }
    }
}
array[Long] *offsets = ; // notification offset (optional)

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Mark the Alert notifications as read
[apiInstance markAlertNotificationsWith:offsets
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var opts = { 
  'offsets':  // {{array[Long]}} notification offset
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.markAlertNotifications(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class markAlertNotificationsExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var offsets = new array[Long](); // array[Long] | notification offset (optional) 

            try
            {
                // Mark the Alert notifications as read
                apiInstance.markAlertNotifications(offsets);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.markAlertNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$offsets = ; // array[Long] | notification offset

try {
    $api_instance->markAlertNotifications($offsets);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->markAlertNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $offsets = []; # array[Long] | notification offset

eval { 
    $api_instance->markAlertNotifications(offsets => $offsets);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->markAlertNotifications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
offsets =  # array[Long] | notification offset (optional)

try: 
    # Mark the Alert notifications as read
    api_instance.mark_alert_notifications(offsets=offsets)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->markAlertNotifications: %s\n" % e)

Parameters

Query parameters
Name Description
offsets
array[Long] (int64)
notification offset

Responses

Status: default - successful operation


unmarkAlertNotifications

Mark the alert notifications as unread


/api/v1/admin/alert/notifications/unread

Usage and SDK Samples

curl -X PUT\
"//api/v1/admin/alert/notifications/unread?offsets="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertNotificationsApi;

import java.io.File;
import java.util.*;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        array[Long] offsets = ; // array[Long] | notification offset
        try {
            apiInstance.unmarkAlertNotifications(offsets);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#unmarkAlertNotifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertNotificationsApi;

public class AlertNotificationsApiExample {

    public static void main(String[] args) {
        AlertNotificationsApi apiInstance = new AlertNotificationsApi();
        array[Long] offsets = ; // array[Long] | notification offset
        try {
            apiInstance.unmarkAlertNotifications(offsets);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertNotificationsApi#unmarkAlertNotifications");
            e.printStackTrace();
        }
    }
}
array[Long] *offsets = ; // notification offset (optional)

AlertNotificationsApi *apiInstance = [[AlertNotificationsApi alloc] init];

// Mark the alert notifications as unread
[apiInstance unmarkAlertNotificationsWith:offsets
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertNotificationsApi()
var opts = { 
  'offsets':  // {{array[Long]}} notification offset
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.unmarkAlertNotifications(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class unmarkAlertNotificationsExample
    {
        public void main()
        {

            var apiInstance = new AlertNotificationsApi();
            var offsets = new array[Long](); // array[Long] | notification offset (optional) 

            try
            {
                // Mark the alert notifications as unread
                apiInstance.unmarkAlertNotifications(offsets);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertNotificationsApi.unmarkAlertNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertNotificationsApi();
$offsets = ; // array[Long] | notification offset

try {
    $api_instance->unmarkAlertNotifications($offsets);
} catch (Exception $e) {
    echo 'Exception when calling AlertNotificationsApi->unmarkAlertNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertNotificationsApi;

my $api_instance = WWW::SwaggerClient::AlertNotificationsApi->new();
my $offsets = []; # array[Long] | notification offset

eval { 
    $api_instance->unmarkAlertNotifications(offsets => $offsets);
};
if ($@) {
    warn "Exception when calling AlertNotificationsApi->unmarkAlertNotifications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertNotificationsApi()
offsets =  # array[Long] | notification offset (optional)

try: 
    # Mark the alert notifications as unread
    api_instance.unmark_alert_notifications(offsets=offsets)
except ApiException as e:
    print("Exception when calling AlertNotificationsApi->unmarkAlertNotifications: %s\n" % e)

Parameters

Query parameters
Name Description
offsets
array[Long] (int64)
notification offset

Responses

Status: default - successful operation


AlertPolicyOperations

addAlertPolicy

Add an alert policy.


/api/v1/admin/alertPolicy

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//api/v1/admin/alertPolicy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        AlertPolicy body = ; // AlertPolicy | 
        try {
            Long result = apiInstance.addAlertPolicy(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#addAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        AlertPolicy body = ; // AlertPolicy | 
        try {
            Long result = apiInstance.addAlertPolicy(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#addAlertPolicy");
            e.printStackTrace();
        }
    }
}
AlertPolicy *body = ; //  (optional)

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Add an alert policy.
[apiInstance addAlertPolicyWith:body
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var opts = { 
  'body':  // {{AlertPolicy}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAlertPolicy(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var body = new AlertPolicy(); // AlertPolicy |  (optional) 

            try
            {
                // Add an alert policy.
                Long result = apiInstance.addAlertPolicy(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.addAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$body = ; // AlertPolicy | 

try {
    $result = $api_instance->addAlertPolicy($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->addAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $body = WWW::SwaggerClient::Object::AlertPolicy->new(); # AlertPolicy | 

eval { 
    my $result = $api_instance->addAlertPolicy(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->addAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
body =  # AlertPolicy |  (optional)

try: 
    # Add an alert policy.
    api_response = api_instance.add_alert_policy(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->addAlertPolicy: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - successful operation


deleteAlertPolicy

Delete an existing alert policy.


/api/v1/admin/alertPolicy/{id}

Usage and SDK Samples

curl -X DELETE\
"//api/v1/admin/alertPolicy/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.deleteAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#deleteAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.deleteAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#deleteAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Delete an existing alert policy.
[apiInstance deleteAlertPolicyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAlertPolicy(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 

            try
            {
                // Delete an existing alert policy.
                apiInstance.deleteAlertPolicy(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.deleteAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 

try {
    $api_instance->deleteAlertPolicy($id);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->deleteAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 

eval { 
    $api_instance->deleteAlertPolicy(id => $id);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->deleteAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 

try: 
    # Delete an existing alert policy.
    api_instance.delete_alert_policy(id)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->deleteAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses

Status: default - successful operation


disableAlertPolicy

Disable an existing alert policy.


/api/v1/admin/alertPolicy/{id}/disable

Usage and SDK Samples

curl -X PUT\
"//api/v1/admin/alertPolicy/{id}/disable"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.disableAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#disableAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.disableAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#disableAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Disable an existing alert policy.
[apiInstance disableAlertPolicyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.disableAlertPolicy(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class disableAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 

            try
            {
                // Disable an existing alert policy.
                apiInstance.disableAlertPolicy(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.disableAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 

try {
    $api_instance->disableAlertPolicy($id);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->disableAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 

eval { 
    $api_instance->disableAlertPolicy(id => $id);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->disableAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 

try: 
    # Disable an existing alert policy.
    api_instance.disable_alert_policy(id)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->disableAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses

Status: default - successful operation


enableAlertPolicy

Enable an existing alert policy.


/api/v1/admin/alertPolicy/{id}/enable

Usage and SDK Samples

curl -X PUT\
"//api/v1/admin/alertPolicy/{id}/enable"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.enableAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#enableAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            apiInstance.enableAlertPolicy(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#enableAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Enable an existing alert policy.
[apiInstance enableAlertPolicyWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.enableAlertPolicy(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class enableAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 

            try
            {
                // Enable an existing alert policy.
                apiInstance.enableAlertPolicy(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.enableAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 

try {
    $api_instance->enableAlertPolicy($id);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->enableAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 

eval { 
    $api_instance->enableAlertPolicy(id => $id);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->enableAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 

try: 
    # Enable an existing alert policy.
    api_instance.enable_alert_policy(id)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->enableAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses

Status: default - successful operation


getAlertPolicy

Get the alert policy for a given id.


/api/v1/admin/alertPolicy/{id}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alertPolicy/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            AlertPolicy result = apiInstance.getAlertPolicy(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        try {
            AlertPolicy result = apiInstance.getAlertPolicy(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Get the alert policy for a given id.
[apiInstance getAlertPolicyWith:id
              completionHandler: ^(AlertPolicy output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertPolicy(id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 

            try
            {
                // Get the alert policy for a given id.
                AlertPolicy result = apiInstance.getAlertPolicy(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.getAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 

try {
    $result = $api_instance->getAlertPolicy($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->getAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 

eval { 
    my $result = $api_instance->getAlertPolicy(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->getAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 

try: 
    # Get the alert policy for a given id.
    api_response = api_instance.get_alert_policy(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->getAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required

Responses

Status: 200 - successful operation


getAllAlertPolicies

Get all the alert policies register.


/api/v1/admin/alertPolicy

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alertPolicy"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        try {
            AlertPolicies result = apiInstance.getAllAlertPolicies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAllAlertPolicies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        try {
            AlertPolicies result = apiInstance.getAllAlertPolicies();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAllAlertPolicies");
            e.printStackTrace();
        }
    }
}

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Get all the alert policies register.
[apiInstance getAllAlertPoliciesWithCompletionHandler: 
              ^(AlertPolicies output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllAlertPolicies(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllAlertPoliciesExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();

            try
            {
                // Get all the alert policies register.
                AlertPolicies result = apiInstance.getAllAlertPolicies();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.getAllAlertPolicies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();

try {
    $result = $api_instance->getAllAlertPolicies();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->getAllAlertPolicies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();

eval { 
    my $result = $api_instance->getAllAlertPolicies();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->getAllAlertPolicies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()

try: 
    # Get all the alert policies register.
    api_response = api_instance.get_all_alert_policies()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->getAllAlertPolicies: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getAutoCompleteAutomata

Returns Autocomplete automata for alert policy.


/api/v1/admin/alertPolicy/automata/{version}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alertPolicy/automata/{version}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Integer version = 56; // Integer | 
        try {
            PolicyAutoCompleteAutomata result = apiInstance.getAutoCompleteAutomata(version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAutoCompleteAutomata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Integer version = 56; // Integer | 
        try {
            PolicyAutoCompleteAutomata result = apiInstance.getAutoCompleteAutomata(version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#getAutoCompleteAutomata");
            e.printStackTrace();
        }
    }
}
Integer *version = 56; // 

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Returns Autocomplete automata for alert policy.
[apiInstance getAutoCompleteAutomataWith:version
              completionHandler: ^(PolicyAutoCompleteAutomata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var version = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAutoCompleteAutomata(version, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAutoCompleteAutomataExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var version = 56;  // Integer | 

            try
            {
                // Returns Autocomplete automata for alert policy.
                PolicyAutoCompleteAutomata result = apiInstance.getAutoCompleteAutomata(version);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.getAutoCompleteAutomata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$version = 56; // Integer | 

try {
    $result = $api_instance->getAutoCompleteAutomata($version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->getAutoCompleteAutomata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $version = 56; # Integer | 

eval { 
    my $result = $api_instance->getAutoCompleteAutomata(version => $version);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->getAutoCompleteAutomata: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
version = 56 # Integer | 

try: 
    # Returns Autocomplete automata for alert policy.
    api_response = api_instance.get_auto_complete_automata(version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->getAutoCompleteAutomata: %s\n" % e)

Parameters

Path parameters
Name Description
version*
Integer (int32)
Required

Responses

Status: 200 - successful operation


updateAlertPolicy

Update an existing alert policy.


/api/v1/admin/alertPolicy/{id}

Usage and SDK Samples

curl -X PUT\
-H "Content-Type: */*"\
"//api/v1/admin/alertPolicy/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertPolicyOperationsApi;

import java.io.File;
import java.util.*;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        AlertPolicy body = ; // AlertPolicy | 
        try {
            apiInstance.updateAlertPolicy(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#updateAlertPolicy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertPolicyOperationsApi;

public class AlertPolicyOperationsApiExample {

    public static void main(String[] args) {
        AlertPolicyOperationsApi apiInstance = new AlertPolicyOperationsApi();
        Long id = 789; // Long | 
        AlertPolicy body = ; // AlertPolicy | 
        try {
            apiInstance.updateAlertPolicy(id, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertPolicyOperationsApi#updateAlertPolicy");
            e.printStackTrace();
        }
    }
}
Long *id = 789; // 
AlertPolicy *body = ; //  (optional)

AlertPolicyOperationsApi *apiInstance = [[AlertPolicyOperationsApi alloc] init];

// Update an existing alert policy.
[apiInstance updateAlertPolicyWith:id
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertPolicyOperationsApi()
var id = 789; // {{Long}} 
var opts = { 
  'body':  // {{AlertPolicy}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateAlertPolicy(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAlertPolicyExample
    {
        public void main()
        {

            var apiInstance = new AlertPolicyOperationsApi();
            var id = 789;  // Long | 
            var body = new AlertPolicy(); // AlertPolicy |  (optional) 

            try
            {
                // Update an existing alert policy.
                apiInstance.updateAlertPolicy(id, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertPolicyOperationsApi.updateAlertPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertPolicyOperationsApi();
$id = 789; // Long | 
$body = ; // AlertPolicy | 

try {
    $api_instance->updateAlertPolicy($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling AlertPolicyOperationsApi->updateAlertPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertPolicyOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertPolicyOperationsApi->new();
my $id = 789; # Long | 
my $body = WWW::SwaggerClient::Object::AlertPolicy->new(); # AlertPolicy | 

eval { 
    $api_instance->updateAlertPolicy(id => $id, body => $body);
};
if ($@) {
    warn "Exception when calling AlertPolicyOperationsApi->updateAlertPolicy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertPolicyOperationsApi()
id = 789 # Long | 
body =  # AlertPolicy |  (optional)

try: 
    # Update an existing alert policy.
    api_instance.update_alert_policy(id, body=body)
except ApiException as e:
    print("Exception when calling AlertPolicyOperationsApi->updateAlertPolicy: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Long (int64)
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


AlertingConfigOperations

isStreamsReplicationManagerConfigured

Check if alerting is configured


/api/v1/admin/alert/is-configured

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/alert/is-configured"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertingConfigOperationsApi;

import java.io.File;
import java.util.*;

public class AlertingConfigOperationsApiExample {

    public static void main(String[] args) {
        
        AlertingConfigOperationsApi apiInstance = new AlertingConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertingConfigOperationsApi#isStreamsReplicationManagerConfigured");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertingConfigOperationsApi;

public class AlertingConfigOperationsApiExample {

    public static void main(String[] args) {
        AlertingConfigOperationsApi apiInstance = new AlertingConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertingConfigOperationsApi#isStreamsReplicationManagerConfigured");
            e.printStackTrace();
        }
    }
}

AlertingConfigOperationsApi *apiInstance = [[AlertingConfigOperationsApi alloc] init];

// Check if alerting is configured
[apiInstance isStreamsReplicationManagerConfiguredWithCompletionHandler: 
              ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AlertingConfigOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isStreamsReplicationManagerConfigured(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isStreamsReplicationManagerConfiguredExample
    {
        public void main()
        {

            var apiInstance = new AlertingConfigOperationsApi();

            try
            {
                // Check if alerting is configured
                'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertingConfigOperationsApi.isStreamsReplicationManagerConfigured: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAlertingConfigOperationsApi();

try {
    $result = $api_instance->isStreamsReplicationManagerConfigured();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertingConfigOperationsApi->isStreamsReplicationManagerConfigured: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertingConfigOperationsApi;

my $api_instance = WWW::SwaggerClient::AlertingConfigOperationsApi->new();

eval { 
    my $result = $api_instance->isStreamsReplicationManagerConfigured();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertingConfigOperationsApi->isStreamsReplicationManagerConfigured: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AlertingConfigOperationsApi()

try: 
    # Check if alerting is configured
    api_response = api_instance.is_streams_replication_manager_configured()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AlertingConfigOperationsApi->isStreamsReplicationManagerConfigured: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


ApplicationContextRelatedOperations

getSMMVersion

Returns version of SMM service


/api/v1/admin/version

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/version"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApplicationContextRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class ApplicationContextRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        ApplicationContextRelatedOperationsApi apiInstance = new ApplicationContextRelatedOperationsApi();
        try {
            SMMVersion result = apiInstance.getSMMVersion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationContextRelatedOperationsApi#getSMMVersion");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApplicationContextRelatedOperationsApi;

public class ApplicationContextRelatedOperationsApiExample {

    public static void main(String[] args) {
        ApplicationContextRelatedOperationsApi apiInstance = new ApplicationContextRelatedOperationsApi();
        try {
            SMMVersion result = apiInstance.getSMMVersion();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApplicationContextRelatedOperationsApi#getSMMVersion");
            e.printStackTrace();
        }
    }
}

ApplicationContextRelatedOperationsApi *apiInstance = [[ApplicationContextRelatedOperationsApi alloc] init];

// Returns version of SMM service
[apiInstance getSMMVersionWithCompletionHandler: 
              ^(SMMVersion output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ApplicationContextRelatedOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSMMVersion(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSMMVersionExample
    {
        public void main()
        {

            var apiInstance = new ApplicationContextRelatedOperationsApi();

            try
            {
                // Returns version of SMM service
                SMMVersion result = apiInstance.getSMMVersion();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApplicationContextRelatedOperationsApi.getSMMVersion: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiApplicationContextRelatedOperationsApi();

try {
    $result = $api_instance->getSMMVersion();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationContextRelatedOperationsApi->getSMMVersion: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApplicationContextRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::ApplicationContextRelatedOperationsApi->new();

eval { 
    my $result = $api_instance->getSMMVersion();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApplicationContextRelatedOperationsApi->getSMMVersion: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ApplicationContextRelatedOperationsApi()

try: 
    # Returns version of SMM service
    api_response = api_instance.get_smm_version()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApplicationContextRelatedOperationsApi->getSMMVersion: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


Authentication

getAccess

Get the Authentication status.


/api/v1/admin/auth/access

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/auth/access"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.getAccess();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getAccess");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.getAccess();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#getAccess");
            e.printStackTrace();
        }
    }
}

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Get the Authentication status.
[apiInstance getAccessWithCompletionHandler: 
              ^(AuthenticationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccess(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccessExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();

            try
            {
                // Get the Authentication status.
                AuthenticationResponse result = apiInstance.getAccess();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.getAccess: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $result = $api_instance->getAccess();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->getAccess: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    my $result = $api_instance->getAccess();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->getAccess: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Get the Authentication status.
    api_response = api_instance.get_access()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->getAccess: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


login

Get the login response


/api/v1/admin/auth/login

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
"//api/v1/admin/auth/login"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.login();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#login");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.login();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#login");
            e.printStackTrace();
        }
    }
}

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Get the login response
[apiInstance loginWithCompletionHandler: 
              ^(AuthenticationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();

            try
            {
                // Get the login response
                AuthenticationResponse result = apiInstance.login();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $result = $api_instance->login();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    my $result = $api_instance->login();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->login: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Get the login response
    api_response = api_instance.login()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->login: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


logout

Get the logout success


/api/v1/admin/auth/logout

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/auth/logout"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuthenticationApi;

import java.io.File;
import java.util.*;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#logout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuthenticationApi;

public class AuthenticationApiExample {

    public static void main(String[] args) {
        AuthenticationApi apiInstance = new AuthenticationApi();
        try {
            AuthenticationResponse result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthenticationApi#logout");
            e.printStackTrace();
        }
    }
}

AuthenticationApi *apiInstance = [[AuthenticationApi alloc] init];

// Get the logout success
[apiInstance logoutWithCompletionHandler: 
              ^(AuthenticationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.AuthenticationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logout(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class logoutExample
    {
        public void main()
        {

            var apiInstance = new AuthenticationApi();

            try
            {
                // Get the logout success
                AuthenticationResponse result = apiInstance.logout();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuthenticationApi.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiAuthenticationApi();

try {
    $result = $api_instance->logout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuthenticationApi;

my $api_instance = WWW::SwaggerClient::AuthenticationApi->new();

eval { 
    my $result = $api_instance->logout();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthenticationApi->logout: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthenticationApi()

try: 
    # Get the logout success
    api_response = api_instance.logout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthenticationApi->logout: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


BrokerMetricsOperations

getBrokerMetrics

Get broker metrics for given brokerId.


/api/v1/admin/metrics/brokers/{brokerId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/brokers/{brokerId}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrokerMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class BrokerMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        BrokerMetricsOperationsApi apiInstance = new BrokerMetricsOperationsApi();
        Integer brokerId = 56; // Integer | Broker identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            BrokerMetrics result = apiInstance.getBrokerMetrics(brokerId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokerMetricsOperationsApi#getBrokerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BrokerMetricsOperationsApi;

public class BrokerMetricsOperationsApiExample {

    public static void main(String[] args) {
        BrokerMetricsOperationsApi apiInstance = new BrokerMetricsOperationsApi();
        Integer brokerId = 56; // Integer | Broker identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            BrokerMetrics result = apiInstance.getBrokerMetrics(brokerId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokerMetricsOperationsApi#getBrokerMetrics");
            e.printStackTrace();
        }
    }
}
Integer *brokerId = 56; // Broker identifier
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

BrokerMetricsOperationsApi *apiInstance = [[BrokerMetricsOperationsApi alloc] init];

// Get broker metrics for given brokerId.
[apiInstance getBrokerMetricsWith:brokerId
    duration:duration
    from:from
    to:to
              completionHandler: ^(BrokerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.BrokerMetricsOperationsApi()
var brokerId = 56; // {{Integer}} Broker identifier
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokerMetrics(brokerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokerMetricsExample
    {
        public void main()
        {

            var apiInstance = new BrokerMetricsOperationsApi();
            var brokerId = 56;  // Integer | Broker identifier
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get broker metrics for given brokerId.
                BrokerMetrics result = apiInstance.getBrokerMetrics(brokerId, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrokerMetricsOperationsApi.getBrokerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBrokerMetricsOperationsApi();
$brokerId = 56; // Integer | Broker identifier
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getBrokerMetrics($brokerId, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrokerMetricsOperationsApi->getBrokerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BrokerMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::BrokerMetricsOperationsApi->new();
my $brokerId = 56; # Integer | Broker identifier
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getBrokerMetrics(brokerId => $brokerId, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrokerMetricsOperationsApi->getBrokerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BrokerMetricsOperationsApi()
brokerId = 56 # Integer | Broker identifier
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get broker metrics for given brokerId.
    api_response = api_instance.get_broker_metrics(brokerId, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrokerMetricsOperationsApi->getBrokerMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
brokerId*
Integer (int32)
Broker identifier
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


BrokersMetadataOperations

getBroker

Returns broker node in the cluster with the given broker Id.


/api/v1/admin/brokers/{brokerId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/brokers/{brokerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrokersMetadataOperationsApi;

import java.io.File;
import java.util.*;

public class BrokersMetadataOperationsApiExample {

    public static void main(String[] args) {
        
        BrokersMetadataOperationsApi apiInstance = new BrokersMetadataOperationsApi();
        Integer brokerId = 56; // Integer | 
        try {
            BrokerNode result = apiInstance.getBroker(brokerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokersMetadataOperationsApi#getBroker");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BrokersMetadataOperationsApi;

public class BrokersMetadataOperationsApiExample {

    public static void main(String[] args) {
        BrokersMetadataOperationsApi apiInstance = new BrokersMetadataOperationsApi();
        Integer brokerId = 56; // Integer | 
        try {
            BrokerNode result = apiInstance.getBroker(brokerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokersMetadataOperationsApi#getBroker");
            e.printStackTrace();
        }
    }
}
Integer *brokerId = 56; // 

BrokersMetadataOperationsApi *apiInstance = [[BrokersMetadataOperationsApi alloc] init];

// Returns broker node in the cluster with the given broker Id.
[apiInstance getBrokerWith:brokerId
              completionHandler: ^(BrokerNode output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.BrokersMetadataOperationsApi()
var brokerId = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBroker(brokerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokerExample
    {
        public void main()
        {

            var apiInstance = new BrokersMetadataOperationsApi();
            var brokerId = 56;  // Integer | 

            try
            {
                // Returns broker node in the cluster with the given broker Id.
                BrokerNode result = apiInstance.getBroker(brokerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrokersMetadataOperationsApi.getBroker: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBrokersMetadataOperationsApi();
$brokerId = 56; // Integer | 

try {
    $result = $api_instance->getBroker($brokerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrokersMetadataOperationsApi->getBroker: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BrokersMetadataOperationsApi;

my $api_instance = WWW::SwaggerClient::BrokersMetadataOperationsApi->new();
my $brokerId = 56; # Integer | 

eval { 
    my $result = $api_instance->getBroker(brokerId => $brokerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrokersMetadataOperationsApi->getBroker: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BrokersMetadataOperationsApi()
brokerId = 56 # Integer | 

try: 
    # Returns broker node in the cluster with the given broker Id.
    api_response = api_instance.get_broker(brokerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrokersMetadataOperationsApi->getBroker: %s\n" % e)

Parameters

Path parameters
Name Description
brokerId*
Integer (int32)
Required

Responses

Status: 200 - successful operation


getBrokers

Returns all broker nodes in the cluster with the given brokerIds if they exist.


/api/v1/admin/brokers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/brokers?brokerIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BrokersMetadataOperationsApi;

import java.io.File;
import java.util.*;

public class BrokersMetadataOperationsApiExample {

    public static void main(String[] args) {
        
        BrokersMetadataOperationsApi apiInstance = new BrokersMetadataOperationsApi();
        String brokerIds = brokerIds_example; // String | Comma separated broker identifiers
        try {
            array[BrokerNode] result = apiInstance.getBrokers(brokerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokersMetadataOperationsApi#getBrokers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BrokersMetadataOperationsApi;

public class BrokersMetadataOperationsApiExample {

    public static void main(String[] args) {
        BrokersMetadataOperationsApi apiInstance = new BrokersMetadataOperationsApi();
        String brokerIds = brokerIds_example; // String | Comma separated broker identifiers
        try {
            array[BrokerNode] result = apiInstance.getBrokers(brokerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BrokersMetadataOperationsApi#getBrokers");
            e.printStackTrace();
        }
    }
}
String *brokerIds = brokerIds_example; // Comma separated broker identifiers (optional)

BrokersMetadataOperationsApi *apiInstance = [[BrokersMetadataOperationsApi alloc] init];

// Returns all broker nodes in the cluster with the given brokerIds if they exist.
[apiInstance getBrokersWith:brokerIds
              completionHandler: ^(array[BrokerNode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.BrokersMetadataOperationsApi()
var opts = { 
  'brokerIds': brokerIds_example // {{String}} Comma separated broker identifiers
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokersExample
    {
        public void main()
        {

            var apiInstance = new BrokersMetadataOperationsApi();
            var brokerIds = brokerIds_example;  // String | Comma separated broker identifiers (optional) 

            try
            {
                // Returns all broker nodes in the cluster with the given brokerIds if they exist.
                array[BrokerNode] result = apiInstance.getBrokers(brokerIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BrokersMetadataOperationsApi.getBrokers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiBrokersMetadataOperationsApi();
$brokerIds = brokerIds_example; // String | Comma separated broker identifiers

try {
    $result = $api_instance->getBrokers($brokerIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BrokersMetadataOperationsApi->getBrokers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BrokersMetadataOperationsApi;

my $api_instance = WWW::SwaggerClient::BrokersMetadataOperationsApi->new();
my $brokerIds = brokerIds_example; # String | Comma separated broker identifiers

eval { 
    my $result = $api_instance->getBrokers(brokerIds => $brokerIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BrokersMetadataOperationsApi->getBrokers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BrokersMetadataOperationsApi()
brokerIds = brokerIds_example # String | Comma separated broker identifiers (optional)

try: 
    # Returns all broker nodes in the cluster with the given brokerIds if they exist.
    api_response = api_instance.get_brokers(brokerIds=brokerIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BrokersMetadataOperationsApi->getBrokers: %s\n" % e)

Parameters

Query parameters
Name Description
brokerIds
String
Comma separated broker identifiers

Responses

Status: 200 - successful operation


CMKafkaInfo

getKafkaRoleInfo

Fetch Kafka cluster Role information from the Cloudera Manager environment


/api/v1/admin/cluster/cmKafkaClusterRolesInfo

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/cluster/cmKafkaClusterRolesInfo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CMKafkaInfoApi;

import java.io.File;
import java.util.*;

public class CMKafkaInfoApiExample {

    public static void main(String[] args) {
        
        CMKafkaInfoApi apiInstance = new CMKafkaInfoApi();
        try {
            KafkaClusterRolesInfo result = apiInstance.getKafkaRoleInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMKafkaInfoApi#getKafkaRoleInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CMKafkaInfoApi;

public class CMKafkaInfoApiExample {

    public static void main(String[] args) {
        CMKafkaInfoApi apiInstance = new CMKafkaInfoApi();
        try {
            KafkaClusterRolesInfo result = apiInstance.getKafkaRoleInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CMKafkaInfoApi#getKafkaRoleInfo");
            e.printStackTrace();
        }
    }
}

CMKafkaInfoApi *apiInstance = [[CMKafkaInfoApi alloc] init];

// Fetch Kafka cluster Role information from the Cloudera Manager environment
[apiInstance getKafkaRoleInfoWithCompletionHandler: 
              ^(KafkaClusterRolesInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.CMKafkaInfoApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getKafkaRoleInfo(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getKafkaRoleInfoExample
    {
        public void main()
        {

            var apiInstance = new CMKafkaInfoApi();

            try
            {
                // Fetch Kafka cluster Role information from the Cloudera Manager environment
                KafkaClusterRolesInfo result = apiInstance.getKafkaRoleInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CMKafkaInfoApi.getKafkaRoleInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCMKafkaInfoApi();

try {
    $result = $api_instance->getKafkaRoleInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CMKafkaInfoApi->getKafkaRoleInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CMKafkaInfoApi;

my $api_instance = WWW::SwaggerClient::CMKafkaInfoApi->new();

eval { 
    my $result = $api_instance->getKafkaRoleInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CMKafkaInfoApi->getKafkaRoleInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CMKafkaInfoApi()

try: 
    # Fetch Kafka cluster Role information from the Cloudera Manager environment
    api_response = api_instance.get_kafka_role_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CMKafkaInfoApi->getKafkaRoleInfo: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


ClusterMetadataOperations

getClusterDetails

Get the kafka cluster details to which this service is connected to.


/api/v1/admin/cluster

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/cluster"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ClusterMetadataOperationsApi;

import java.io.File;
import java.util.*;

public class ClusterMetadataOperationsApiExample {

    public static void main(String[] args) {
        
        ClusterMetadataOperationsApi apiInstance = new ClusterMetadataOperationsApi();
        try {
            KafkaClusterInfo result = apiInstance.getClusterDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterMetadataOperationsApi#getClusterDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ClusterMetadataOperationsApi;

public class ClusterMetadataOperationsApiExample {

    public static void main(String[] args) {
        ClusterMetadataOperationsApi apiInstance = new ClusterMetadataOperationsApi();
        try {
            KafkaClusterInfo result = apiInstance.getClusterDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ClusterMetadataOperationsApi#getClusterDetails");
            e.printStackTrace();
        }
    }
}

ClusterMetadataOperationsApi *apiInstance = [[ClusterMetadataOperationsApi alloc] init];

// Get the kafka cluster details to which this service is connected to.
[apiInstance getClusterDetailsWithCompletionHandler: 
              ^(KafkaClusterInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ClusterMetadataOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getClusterDetails(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getClusterDetailsExample
    {
        public void main()
        {

            var apiInstance = new ClusterMetadataOperationsApi();

            try
            {
                // Get the kafka cluster details to which this service is connected to.
                KafkaClusterInfo result = apiInstance.getClusterDetails();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ClusterMetadataOperationsApi.getClusterDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiClusterMetadataOperationsApi();

try {
    $result = $api_instance->getClusterDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClusterMetadataOperationsApi->getClusterDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ClusterMetadataOperationsApi;

my $api_instance = WWW::SwaggerClient::ClusterMetadataOperationsApi->new();

eval { 
    my $result = $api_instance->getClusterDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ClusterMetadataOperationsApi->getClusterDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ClusterMetadataOperationsApi()

try: 
    # Get the kafka cluster details to which this service is connected to.
    api_response = api_instance.get_cluster_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ClusterMetadataOperationsApi->getClusterDetails: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


ConsumerGroupRelatedDetails_

getAllConsumerInfo

Get consumer group details for all clients.


/api/v1/admin/consumers/clients

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/clients"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        try {
            array[ConsumerInfo] result = apiInstance.getAllConsumerInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getAllConsumerInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        try {
            array[ConsumerInfo] result = apiInstance.getAllConsumerInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getAllConsumerInfo");
            e.printStackTrace();
        }
    }
}

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get consumer group details for all clients.
[apiInstance getAllConsumerInfoWithCompletionHandler: 
              ^(array[ConsumerInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllConsumerInfo(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllConsumerInfoExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();

            try
            {
                // Get consumer group details for all clients.
                array[ConsumerInfo] result = apiInstance.getAllConsumerInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getAllConsumerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();

try {
    $result = $api_instance->getAllConsumerInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getAllConsumerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();

eval { 
    my $result = $api_instance->getAllConsumerInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getAllConsumerInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()

try: 
    # Get consumer group details for all clients.
    api_response = api_instance.get_all_consumer_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getAllConsumerInfo: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getConsumerGroupInfo

Get consumer group details for the given groupName `groupName`.


/api/v1/admin/consumers/groups/{groupName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/groups/{groupName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String groupName = groupName_example; // String | Name of the consumer group
        try {
            ConsumerGroupInfo result = apiInstance.getConsumerGroupInfo(groupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroupInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String groupName = groupName_example; // String | Name of the consumer group
        try {
            ConsumerGroupInfo result = apiInstance.getConsumerGroupInfo(groupName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroupInfo");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // Name of the consumer group

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get consumer group details for the given groupName `groupName`.
[apiInstance getConsumerGroupInfoWith:groupName
              completionHandler: ^(ConsumerGroupInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var groupName = groupName_example; // {{String}} Name of the consumer group

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupInfo(groupName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupInfoExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();
            var groupName = groupName_example;  // String | Name of the consumer group

            try
            {
                // Get consumer group details for the given groupName `groupName`.
                ConsumerGroupInfo result = apiInstance.getConsumerGroupInfo(groupName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getConsumerGroupInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();
$groupName = groupName_example; // String | Name of the consumer group

try {
    $result = $api_instance->getConsumerGroupInfo($groupName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();
my $groupName = groupName_example; # String | Name of the consumer group

eval { 
    my $result = $api_instance->getConsumerGroupInfo(groupName => $groupName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()
groupName = groupName_example # String | Name of the consumer group

try: 
    # Get consumer group details for the given groupName `groupName`.
    api_response = api_instance.get_consumer_group_info(groupName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupInfo: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
String
Name of the consumer group
Required

Responses

Status: 200 - successful operation


getConsumerGroupNames

Get all consumer group names.


/api/v1/admin/consumers/groupNames

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/groupNames"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        try {
            array['String'] result = apiInstance.getConsumerGroupNames();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroupNames");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        try {
            array['String'] result = apiInstance.getConsumerGroupNames();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroupNames");
            e.printStackTrace();
        }
    }
}

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get all consumer group names.
[apiInstance getConsumerGroupNamesWithCompletionHandler: 
              ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupNames(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupNamesExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();

            try
            {
                // Get all consumer group names.
                array['String'] result = apiInstance.getConsumerGroupNames();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getConsumerGroupNames: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();

try {
    $result = $api_instance->getConsumerGroupNames();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupNames: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();

eval { 
    my $result = $api_instance->getConsumerGroupNames();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupNames: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()

try: 
    # Get all consumer group names.
    api_response = api_instance.get_consumer_group_names()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroupNames: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getConsumerGroups

Get all consumer group details.


/api/v1/admin/consumers/groups

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/groups?state="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String state = state_example; // String | State of the Consumer Group
        try {
            array[ConsumerGroupInfo] result = apiInstance.getConsumerGroups(state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroups");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String state = state_example; // String | State of the Consumer Group
        try {
            array[ConsumerGroupInfo] result = apiInstance.getConsumerGroups(state);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerGroups");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // State of the Consumer Group (optional)

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get all consumer group details.
[apiInstance getConsumerGroupsWith:state
              completionHandler: ^(array[ConsumerGroupInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var opts = { 
  'state': state_example // {{String}} State of the Consumer Group
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroups(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupsExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();
            var state = state_example;  // String | State of the Consumer Group (optional) 

            try
            {
                // Get all consumer group details.
                array[ConsumerGroupInfo] result = apiInstance.getConsumerGroups(state);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getConsumerGroups: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();
$state = state_example; // String | State of the Consumer Group

try {
    $result = $api_instance->getConsumerGroups($state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroups: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();
my $state = state_example; # String | State of the Consumer Group

eval { 
    my $result = $api_instance->getConsumerGroups(state => $state);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroups: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()
state = state_example # String | State of the Consumer Group (optional)

try: 
    # Get all consumer group details.
    api_response = api_instance.get_consumer_groups(state=state)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerGroups: %s\n" % e)

Parameters

Query parameters
Name Description
state
String
State of the Consumer Group

Responses

Status: 200 - successful operation


getConsumerInfo

Get consumer group details for a given clientId.


/api/v1/admin/consumers/clients/{clientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/consumers/clients/{clientId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String clientId = clientId_example; // String | Consumer client identifier
        try {
            ConsumerInfo result = apiInstance.getConsumerInfo(clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String clientId = clientId_example; // String | Consumer client identifier
        try {
            ConsumerInfo result = apiInstance.getConsumerInfo(clientId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#getConsumerInfo");
            e.printStackTrace();
        }
    }
}
String *clientId = clientId_example; // Consumer client identifier

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Get consumer group details for a given clientId.
[apiInstance getConsumerInfoWith:clientId
              completionHandler: ^(ConsumerInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var clientId = clientId_example; // {{String}} Consumer client identifier

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerInfo(clientId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerInfoExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();
            var clientId = clientId_example;  // String | Consumer client identifier

            try
            {
                // Get consumer group details for a given clientId.
                ConsumerInfo result = apiInstance.getConsumerInfo(clientId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.getConsumerInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();
$clientId = clientId_example; // String | Consumer client identifier

try {
    $result = $api_instance->getConsumerInfo($clientId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();
my $clientId = clientId_example; # String | Consumer client identifier

eval { 
    my $result = $api_instance->getConsumerInfo(clientId => $clientId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()
clientId = clientId_example # String | Consumer client identifier

try: 
    # Get consumer group details for a given clientId.
    api_response = api_instance.get_consumer_info(clientId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->getConsumerInfo: %s\n" % e)

Parameters

Path parameters
Name Description
clientId*
String
Consumer client identifier
Required

Responses

Status: 200 - successful operation


resetOffset

Reset consumer offsets


/api/v1/admin/consumers/groups/{groupName}/resetOffsets

Usage and SDK Samples

curl -X POST\
-H "Content-Type: */*"\
"//api/v1/admin/consumers/groups/{groupName}/resetOffsets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

import java.io.File;
import java.util.*;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String groupName = groupName_example; // String | Name of the consumer group
        ConsumerOffsetResetParams body = ; // ConsumerOffsetResetParams | 
        try {
            apiInstance.resetOffset(groupName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#resetOffset");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerGroupRelatedDetails_Api;

public class ConsumerGroupRelatedDetails_ApiExample {

    public static void main(String[] args) {
        ConsumerGroupRelatedDetails_Api apiInstance = new ConsumerGroupRelatedDetails_Api();
        String groupName = groupName_example; // String | Name of the consumer group
        ConsumerOffsetResetParams body = ; // ConsumerOffsetResetParams | 
        try {
            apiInstance.resetOffset(groupName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerGroupRelatedDetails_Api#resetOffset");
            e.printStackTrace();
        }
    }
}
String *groupName = groupName_example; // Name of the consumer group
ConsumerOffsetResetParams *body = ; //  (optional)

ConsumerGroupRelatedDetails_Api *apiInstance = [[ConsumerGroupRelatedDetails_Api alloc] init];

// Reset consumer offsets
[apiInstance resetOffsetWith:groupName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerGroupRelatedDetails_Api()
var groupName = groupName_example; // {{String}} Name of the consumer group
var opts = { 
  'body':  // {{ConsumerOffsetResetParams}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.resetOffset(groupName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class resetOffsetExample
    {
        public void main()
        {

            var apiInstance = new ConsumerGroupRelatedDetails_Api();
            var groupName = groupName_example;  // String | Name of the consumer group
            var body = new ConsumerOffsetResetParams(); // ConsumerOffsetResetParams |  (optional) 

            try
            {
                // Reset consumer offsets
                apiInstance.resetOffset(groupName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerGroupRelatedDetails_Api.resetOffset: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerGroupRelatedDetails_Api();
$groupName = groupName_example; // String | Name of the consumer group
$body = ; // ConsumerOffsetResetParams | 

try {
    $api_instance->resetOffset($groupName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerGroupRelatedDetails_Api->resetOffset: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api;

my $api_instance = WWW::SwaggerClient::ConsumerGroupRelatedDetails_Api->new();
my $groupName = groupName_example; # String | Name of the consumer group
my $body = WWW::SwaggerClient::Object::ConsumerOffsetResetParams->new(); # ConsumerOffsetResetParams | 

eval { 
    $api_instance->resetOffset(groupName => $groupName, body => $body);
};
if ($@) {
    warn "Exception when calling ConsumerGroupRelatedDetails_Api->resetOffset: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerGroupRelatedDetails_Api()
groupName = groupName_example # String | Name of the consumer group
body =  # ConsumerOffsetResetParams |  (optional)

try: 
    # Reset consumer offsets
    api_instance.reset_offset(groupName, body=body)
except ApiException as e:
    print("Exception when calling ConsumerGroupRelatedDetails_Api->resetOffset: %s\n" % e)

Parameters

Path parameters
Name Description
groupName*
String
Name of the consumer group
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


ConsumerMetricOperations

getConsumerGroupMetrics1

Get timeline metrics for a consumer group. This will return per partition metrics for a consumer group.


/api/v2/admin/metrics/consumers/group/{groupId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/metrics/consumers/group/{groupId}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConsumerMetricOperationsApi;

import java.io.File;
import java.util.*;

public class ConsumerMetricOperationsApiExample {

    public static void main(String[] args) {
        
        ConsumerMetricOperationsApi apiInstance = new ConsumerMetricOperationsApi();
        String groupId = groupId_example; // String | Consumer group identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ConsumerGroupMetrics result = apiInstance.getConsumerGroupMetrics1(groupId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerMetricOperationsApi#getConsumerGroupMetrics1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConsumerMetricOperationsApi;

public class ConsumerMetricOperationsApiExample {

    public static void main(String[] args) {
        ConsumerMetricOperationsApi apiInstance = new ConsumerMetricOperationsApi();
        String groupId = groupId_example; // String | Consumer group identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ConsumerGroupMetrics result = apiInstance.getConsumerGroupMetrics1(groupId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConsumerMetricOperationsApi#getConsumerGroupMetrics1");
            e.printStackTrace();
        }
    }
}
String *groupId = groupId_example; // Consumer group identifier
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

ConsumerMetricOperationsApi *apiInstance = [[ConsumerMetricOperationsApi alloc] init];

// Get timeline metrics for a consumer group. This will return per partition metrics for a consumer group.
[apiInstance getConsumerGroupMetrics1With:groupId
    duration:duration
    from:from
    to:to
              completionHandler: ^(ConsumerGroupMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ConsumerMetricOperationsApi()
var groupId = groupId_example; // {{String}} Consumer group identifier
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupMetrics1(groupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupMetrics1Example
    {
        public void main()
        {

            var apiInstance = new ConsumerMetricOperationsApi();
            var groupId = groupId_example;  // String | Consumer group identifier
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get timeline metrics for a consumer group. This will return per partition metrics for a consumer group.
                ConsumerGroupMetrics result = apiInstance.getConsumerGroupMetrics1(groupId, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConsumerMetricOperationsApi.getConsumerGroupMetrics1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiConsumerMetricOperationsApi();
$groupId = groupId_example; // String | Consumer group identifier
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getConsumerGroupMetrics1($groupId, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConsumerMetricOperationsApi->getConsumerGroupMetrics1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConsumerMetricOperationsApi;

my $api_instance = WWW::SwaggerClient::ConsumerMetricOperationsApi->new();
my $groupId = groupId_example; # String | Consumer group identifier
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getConsumerGroupMetrics1(groupId => $groupId, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConsumerMetricOperationsApi->getConsumerGroupMetrics1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ConsumerMetricOperationsApi()
groupId = groupId_example # String | Consumer group identifier
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get timeline metrics for a consumer group. This will return per partition metrics for a consumer group.
    api_response = api_instance.get_consumer_group_metrics1(groupId, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConsumerMetricOperationsApi->getConsumerGroupMetrics1: %s\n" % e)

Parameters

Path parameters
Name Description
groupId*
String
Consumer group identifier
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


CruiseControlConfigOperations

isCruiseControlConfigured

Check if Cruise Control is configured


/api/v1/admin/kafkacruisecontrol/is-configured

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafkacruisecontrol/is-configured"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CruiseControlConfigOperationsApi;

import java.io.File;
import java.util.*;

public class CruiseControlConfigOperationsApiExample {

    public static void main(String[] args) {
        
        CruiseControlConfigOperationsApi apiInstance = new CruiseControlConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isCruiseControlConfigured();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlConfigOperationsApi#isCruiseControlConfigured");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CruiseControlConfigOperationsApi;

public class CruiseControlConfigOperationsApiExample {

    public static void main(String[] args) {
        CruiseControlConfigOperationsApi apiInstance = new CruiseControlConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isCruiseControlConfigured();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlConfigOperationsApi#isCruiseControlConfigured");
            e.printStackTrace();
        }
    }
}

CruiseControlConfigOperationsApi *apiInstance = [[CruiseControlConfigOperationsApi alloc] init];

// Check if Cruise Control is configured
[apiInstance isCruiseControlConfiguredWithCompletionHandler: 
              ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.CruiseControlConfigOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isCruiseControlConfigured(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isCruiseControlConfiguredExample
    {
        public void main()
        {

            var apiInstance = new CruiseControlConfigOperationsApi();

            try
            {
                // Check if Cruise Control is configured
                'Boolean' result = apiInstance.isCruiseControlConfigured();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CruiseControlConfigOperationsApi.isCruiseControlConfigured: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCruiseControlConfigOperationsApi();

try {
    $result = $api_instance->isCruiseControlConfigured();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CruiseControlConfigOperationsApi->isCruiseControlConfigured: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CruiseControlConfigOperationsApi;

my $api_instance = WWW::SwaggerClient::CruiseControlConfigOperationsApi->new();

eval { 
    my $result = $api_instance->isCruiseControlConfigured();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CruiseControlConfigOperationsApi->isCruiseControlConfigured: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CruiseControlConfigOperationsApi()

try: 
    # Check if Cruise Control is configured
    api_response = api_instance.is_cruise_control_configured()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CruiseControlConfigOperationsApi->isCruiseControlConfigured: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


CruiseControlOperations

cruiseControlRebalance

Cruise Control rebalance


/api/v1/admin/kafkacruisecontrol/rebalance

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//api/v1/admin/kafkacruisecontrol/rebalance?dryrun="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CruiseControlOperationsApi;

import java.io.File;
import java.util.*;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        CruiseControlRebalanceRequest body = ; // CruiseControlRebalanceRequest | 
        Boolean dryrun = true; // Boolean | 
        try {
            RebalanceResult result = apiInstance.cruiseControlRebalance(body, dryrun);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#cruiseControlRebalance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CruiseControlOperationsApi;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        CruiseControlRebalanceRequest body = ; // CruiseControlRebalanceRequest | 
        Boolean dryrun = true; // Boolean | 
        try {
            RebalanceResult result = apiInstance.cruiseControlRebalance(body, dryrun);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#cruiseControlRebalance");
            e.printStackTrace();
        }
    }
}
CruiseControlRebalanceRequest *body = ; //  (optional)
Boolean *dryrun = true; //  (optional)

CruiseControlOperationsApi *apiInstance = [[CruiseControlOperationsApi alloc] init];

// Cruise Control rebalance
[apiInstance cruiseControlRebalanceWith:body
    dryrun:dryrun
              completionHandler: ^(RebalanceResult output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.CruiseControlOperationsApi()
var opts = { 
  'body':  // {{CruiseControlRebalanceRequest}} 
  'dryrun': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cruiseControlRebalance(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class cruiseControlRebalanceExample
    {
        public void main()
        {

            var apiInstance = new CruiseControlOperationsApi();
            var body = new CruiseControlRebalanceRequest(); // CruiseControlRebalanceRequest |  (optional) 
            var dryrun = true;  // Boolean |  (optional) 

            try
            {
                // Cruise Control rebalance
                RebalanceResult result = apiInstance.cruiseControlRebalance(body, dryrun);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CruiseControlOperationsApi.cruiseControlRebalance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCruiseControlOperationsApi();
$body = ; // CruiseControlRebalanceRequest | 
$dryrun = true; // Boolean | 

try {
    $result = $api_instance->cruiseControlRebalance($body, $dryrun);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CruiseControlOperationsApi->cruiseControlRebalance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CruiseControlOperationsApi;

my $api_instance = WWW::SwaggerClient::CruiseControlOperationsApi->new();
my $body = WWW::SwaggerClient::Object::CruiseControlRebalanceRequest->new(); # CruiseControlRebalanceRequest | 
my $dryrun = true; # Boolean | 

eval { 
    my $result = $api_instance->cruiseControlRebalance(body => $body, dryrun => $dryrun);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CruiseControlOperationsApi->cruiseControlRebalance: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CruiseControlOperationsApi()
body =  # CruiseControlRebalanceRequest |  (optional)
dryrun = true # Boolean |  (optional)

try: 
    # Cruise Control rebalance
    api_response = api_instance.cruise_control_rebalance(body=body, dryrun=dryrun)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CruiseControlOperationsApi->cruiseControlRebalance: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
dryrun
Boolean

Responses

Status: 200 - successful operation


getCruiseControlState

Get the Cruise Control state


/api/v1/admin/kafkacruisecontrol/state

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafkacruisecontrol/state"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CruiseControlOperationsApi;

import java.io.File;
import java.util.*;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        try {
            CruiseControlStateResponse result = apiInstance.getCruiseControlState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#getCruiseControlState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CruiseControlOperationsApi;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        try {
            CruiseControlStateResponse result = apiInstance.getCruiseControlState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#getCruiseControlState");
            e.printStackTrace();
        }
    }
}

CruiseControlOperationsApi *apiInstance = [[CruiseControlOperationsApi alloc] init];

// Get the Cruise Control state
[apiInstance getCruiseControlStateWithCompletionHandler: 
              ^(CruiseControlStateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.CruiseControlOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCruiseControlState(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCruiseControlStateExample
    {
        public void main()
        {

            var apiInstance = new CruiseControlOperationsApi();

            try
            {
                // Get the Cruise Control state
                CruiseControlStateResponse result = apiInstance.getCruiseControlState();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CruiseControlOperationsApi.getCruiseControlState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCruiseControlOperationsApi();

try {
    $result = $api_instance->getCruiseControlState();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CruiseControlOperationsApi->getCruiseControlState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CruiseControlOperationsApi;

my $api_instance = WWW::SwaggerClient::CruiseControlOperationsApi->new();

eval { 
    my $result = $api_instance->getCruiseControlState();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CruiseControlOperationsApi->getCruiseControlState: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CruiseControlOperationsApi()

try: 
    # Get the Cruise Control state
    api_response = api_instance.get_cruise_control_state()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CruiseControlOperationsApi->getCruiseControlState: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getKafkaClusterState

Get the kafka cluster state


/api/v1/admin/kafkacruisecontrol/kafka_cluster_state

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafkacruisecontrol/kafka_cluster_state"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CruiseControlOperationsApi;

import java.io.File;
import java.util.*;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        try {
            KafkaClusterState result = apiInstance.getKafkaClusterState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#getKafkaClusterState");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CruiseControlOperationsApi;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        try {
            KafkaClusterState result = apiInstance.getKafkaClusterState();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#getKafkaClusterState");
            e.printStackTrace();
        }
    }
}

CruiseControlOperationsApi *apiInstance = [[CruiseControlOperationsApi alloc] init];

// Get the kafka cluster state
[apiInstance getKafkaClusterStateWithCompletionHandler: 
              ^(KafkaClusterState output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.CruiseControlOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getKafkaClusterState(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getKafkaClusterStateExample
    {
        public void main()
        {

            var apiInstance = new CruiseControlOperationsApi();

            try
            {
                // Get the kafka cluster state
                KafkaClusterState result = apiInstance.getKafkaClusterState();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CruiseControlOperationsApi.getKafkaClusterState: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCruiseControlOperationsApi();

try {
    $result = $api_instance->getKafkaClusterState();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CruiseControlOperationsApi->getKafkaClusterState: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CruiseControlOperationsApi;

my $api_instance = WWW::SwaggerClient::CruiseControlOperationsApi->new();

eval { 
    my $result = $api_instance->getKafkaClusterState();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CruiseControlOperationsApi->getKafkaClusterState: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CruiseControlOperationsApi()

try: 
    # Get the kafka cluster state
    api_response = api_instance.get_kafka_cluster_state()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CruiseControlOperationsApi->getKafkaClusterState: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getUserPermissions

Get the user permissions as the list of roles


/api/v1/admin/kafkacruisecontrol/permissions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafkacruisecontrol/permissions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CruiseControlOperationsApi;

import java.io.File;
import java.util.*;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        try {
            CruiseControlPermissions result = apiInstance.getUserPermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#getUserPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CruiseControlOperationsApi;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        try {
            CruiseControlPermissions result = apiInstance.getUserPermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#getUserPermissions");
            e.printStackTrace();
        }
    }
}

CruiseControlOperationsApi *apiInstance = [[CruiseControlOperationsApi alloc] init];

// Get the user permissions as the list of roles
[apiInstance getUserPermissionsWithCompletionHandler: 
              ^(CruiseControlPermissions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.CruiseControlOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserPermissions(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getUserPermissionsExample
    {
        public void main()
        {

            var apiInstance = new CruiseControlOperationsApi();

            try
            {
                // Get the user permissions as the list of roles
                CruiseControlPermissions result = apiInstance.getUserPermissions();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CruiseControlOperationsApi.getUserPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCruiseControlOperationsApi();

try {
    $result = $api_instance->getUserPermissions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CruiseControlOperationsApi->getUserPermissions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CruiseControlOperationsApi;

my $api_instance = WWW::SwaggerClient::CruiseControlOperationsApi->new();

eval { 
    my $result = $api_instance->getUserPermissions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CruiseControlOperationsApi->getUserPermissions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CruiseControlOperationsApi()

try: 
    # Get the user permissions as the list of roles
    api_response = api_instance.get_user_permissions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CruiseControlOperationsApi->getUserPermissions: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


stopOngoingProposal

Stop ongoing proposal


/api/v1/admin/kafkacruisecontrol/stop_proposal_execution

Usage and SDK Samples

curl -X POST\
"//api/v1/admin/kafkacruisecontrol/stop_proposal_execution"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CruiseControlOperationsApi;

import java.io.File;
import java.util.*;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        try {
            apiInstance.stopOngoingProposal();
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#stopOngoingProposal");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CruiseControlOperationsApi;

public class CruiseControlOperationsApiExample {

    public static void main(String[] args) {
        CruiseControlOperationsApi apiInstance = new CruiseControlOperationsApi();
        try {
            apiInstance.stopOngoingProposal();
        } catch (ApiException e) {
            System.err.println("Exception when calling CruiseControlOperationsApi#stopOngoingProposal");
            e.printStackTrace();
        }
    }
}

CruiseControlOperationsApi *apiInstance = [[CruiseControlOperationsApi alloc] init];

// Stop ongoing proposal
[apiInstance stopOngoingProposalWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.CruiseControlOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.stopOngoingProposal(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stopOngoingProposalExample
    {
        public void main()
        {

            var apiInstance = new CruiseControlOperationsApi();

            try
            {
                // Stop ongoing proposal
                apiInstance.stopOngoingProposal();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CruiseControlOperationsApi.stopOngoingProposal: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiCruiseControlOperationsApi();

try {
    $api_instance->stopOngoingProposal();
} catch (Exception $e) {
    echo 'Exception when calling CruiseControlOperationsApi->stopOngoingProposal: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CruiseControlOperationsApi;

my $api_instance = WWW::SwaggerClient::CruiseControlOperationsApi->new();

eval { 
    $api_instance->stopOngoingProposal();
};
if ($@) {
    warn "Exception when calling CruiseControlOperationsApi->stopOngoingProposal: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.CruiseControlOperationsApi()

try: 
    # Stop ongoing proposal
    api_instance.stop_ongoing_proposal()
except ApiException as e:
    print("Exception when calling CruiseControlOperationsApi->stopOngoingProposal: %s\n" % e)

Parameters

Responses

Status: default - successful operation


EndToEndLatencyMetrics

getConsumerMetrics

Get the end to end latency metrics for the given topic across all intercepted consumer groups.


/api/v1/admin/etelatency/{topicName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetrics(topicName, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetrics(topicName, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetrics");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics for the given topic across all intercepted consumer groups.
[apiInstance getConsumerMetricsWith:topicName
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'granularity': granularity_example // {{String}} Granularity to aggregate the metrics with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerMetrics(topicName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerMetricsExample
    {
        public void main()
        {

            var apiInstance = new EndToEndLatencyMetricsApi();
            var topicName = topicName_example;  // String | Topic to query about
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var granularity = granularity_example;  // String | Granularity to aggregate the metrics with (optional)  (default to THIRTY_SECS)

            try
            {
                // Get the end to end latency metrics for the given topic across all intercepted consumer groups.
                ETELatencyMetrics result = apiInstance.getConsumerMetrics(topicName, duration, from, to, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EndToEndLatencyMetricsApi.getConsumerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEndToEndLatencyMetricsApi();
$topicName = topicName_example; // String | Topic to query about
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$granularity = granularity_example; // String | Granularity to aggregate the metrics with

try {
    $result = $api_instance->getConsumerMetrics($topicName, $duration, $from, $to, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndToEndLatencyMetricsApi->getConsumerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EndToEndLatencyMetricsApi;

my $api_instance = WWW::SwaggerClient::EndToEndLatencyMetricsApi->new();
my $topicName = topicName_example; # String | Topic to query about
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $granularity = granularity_example; # String | Granularity to aggregate the metrics with

eval { 
    my $result = $api_instance->getConsumerMetrics(topicName => $topicName, duration => $duration, from => $from, to => $to, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndToEndLatencyMetricsApi->getConsumerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EndToEndLatencyMetricsApi()
topicName = topicName_example # String | Topic to query about
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
granularity = granularity_example # String | Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

try: 
    # Get the end to end latency metrics for the given topic across all intercepted consumer groups.
    api_response = api_instance.get_consumer_metrics(topicName, duration=duration, from=from, to=to, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndToEndLatencyMetricsApi->getConsumerMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Topic to query about
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
granularity
String
Granularity to aggregate the metrics with

Responses

Status: 200 - successful operation


getConsumerMetricsByClientId

Get the end to end latency metrics under a given consumer group for the given clientId and topic.


/api/v1/admin/etelatency/{topicName}/groups/{groupId}/clients/{clientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}/groups/{groupId}/clients/{clientId}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String clientId = clientId_example; // String | Client Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientId(topicName, groupId, clientId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByClientId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String clientId = clientId_example; // String | Client Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientId(topicName, groupId, clientId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByClientId");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
String *groupId = groupId_example; // Consumer Group Id queried for
String *clientId = clientId_example; // Client Id queried for
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics under a given consumer group for the given clientId and topic.
[apiInstance getConsumerMetricsByClientIdWith:topicName
    groupId:groupId
    clientId:clientId
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var groupId = groupId_example; // {{String}} Consumer Group Id queried for
var clientId = clientId_example; // {{String}} Client Id queried for
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'granularity': granularity_example // {{String}} Granularity to aggregate the metrics with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerMetricsByClientId(topicName, groupId, clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerMetricsByClientIdExample
    {
        public void main()
        {

            var apiInstance = new EndToEndLatencyMetricsApi();
            var topicName = topicName_example;  // String | Topic to query about
            var groupId = groupId_example;  // String | Consumer Group Id queried for
            var clientId = clientId_example;  // String | Client Id queried for
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var granularity = granularity_example;  // String | Granularity to aggregate the metrics with (optional)  (default to THIRTY_SECS)

            try
            {
                // Get the end to end latency metrics under a given consumer group for the given clientId and topic.
                ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientId(topicName, groupId, clientId, duration, from, to, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EndToEndLatencyMetricsApi.getConsumerMetricsByClientId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEndToEndLatencyMetricsApi();
$topicName = topicName_example; // String | Topic to query about
$groupId = groupId_example; // String | Consumer Group Id queried for
$clientId = clientId_example; // String | Client Id queried for
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$granularity = granularity_example; // String | Granularity to aggregate the metrics with

try {
    $result = $api_instance->getConsumerMetricsByClientId($topicName, $groupId, $clientId, $duration, $from, $to, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EndToEndLatencyMetricsApi;

my $api_instance = WWW::SwaggerClient::EndToEndLatencyMetricsApi->new();
my $topicName = topicName_example; # String | Topic to query about
my $groupId = groupId_example; # String | Consumer Group Id queried for
my $clientId = clientId_example; # String | Client Id queried for
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $granularity = granularity_example; # String | Granularity to aggregate the metrics with

eval { 
    my $result = $api_instance->getConsumerMetricsByClientId(topicName => $topicName, groupId => $groupId, clientId => $clientId, duration => $duration, from => $from, to => $to, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EndToEndLatencyMetricsApi()
topicName = topicName_example # String | Topic to query about
groupId = groupId_example # String | Consumer Group Id queried for
clientId = clientId_example # String | Client Id queried for
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
granularity = granularity_example # String | Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

try: 
    # Get the end to end latency metrics under a given consumer group for the given clientId and topic.
    api_response = api_instance.get_consumer_metrics_by_client_id(topicName, groupId, clientId, duration=duration, from=from, to=to, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientId: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Topic to query about
Required
groupId*
String
Consumer Group Id queried for
Required
clientId*
String
Client Id queried for
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
granularity
String
Granularity to aggregate the metrics with

Responses

Status: 200 - successful operation


getConsumerMetricsByClientPartition

Get the end to end latency metrics of a client under a given consumer group for the given partition and topic.


/api/v1/admin/etelatency/{topicName}/partitions/{partitionNum}/groups/{groupId}/clients/{clientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}/partitions/{partitionNum}/groups/{groupId}/clients/{clientId}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        Integer partitionNum = 56; // Integer | Partition to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String clientId = clientId_example; // String | Client Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientPartition(topicName, partitionNum, groupId, clientId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByClientPartition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        Integer partitionNum = 56; // Integer | Partition to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String clientId = clientId_example; // String | Client Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientPartition(topicName, partitionNum, groupId, clientId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByClientPartition");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
Integer *partitionNum = 56; // Partition to query about
String *groupId = groupId_example; // Consumer Group Id queried for
String *clientId = clientId_example; // Client Id queried for
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics of a client under a given consumer group for the given partition and topic.
[apiInstance getConsumerMetricsByClientPartitionWith:topicName
    partitionNum:partitionNum
    groupId:groupId
    clientId:clientId
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var partitionNum = 56; // {{Integer}} Partition to query about
var groupId = groupId_example; // {{String}} Consumer Group Id queried for
var clientId = clientId_example; // {{String}} Client Id queried for
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'granularity': granularity_example // {{String}} Granularity to aggregate the metrics with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerMetricsByClientPartition(topicName, partitionNum, groupId, clientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerMetricsByClientPartitionExample
    {
        public void main()
        {

            var apiInstance = new EndToEndLatencyMetricsApi();
            var topicName = topicName_example;  // String | Topic to query about
            var partitionNum = 56;  // Integer | Partition to query about
            var groupId = groupId_example;  // String | Consumer Group Id queried for
            var clientId = clientId_example;  // String | Client Id queried for
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var granularity = granularity_example;  // String | Granularity to aggregate the metrics with (optional)  (default to THIRTY_SECS)

            try
            {
                // Get the end to end latency metrics of a client under a given consumer group for the given partition and topic.
                ETELatencyMetrics result = apiInstance.getConsumerMetricsByClientPartition(topicName, partitionNum, groupId, clientId, duration, from, to, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EndToEndLatencyMetricsApi.getConsumerMetricsByClientPartition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEndToEndLatencyMetricsApi();
$topicName = topicName_example; // String | Topic to query about
$partitionNum = 56; // Integer | Partition to query about
$groupId = groupId_example; // String | Consumer Group Id queried for
$clientId = clientId_example; // String | Client Id queried for
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$granularity = granularity_example; // String | Granularity to aggregate the metrics with

try {
    $result = $api_instance->getConsumerMetricsByClientPartition($topicName, $partitionNum, $groupId, $clientId, $duration, $from, $to, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientPartition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EndToEndLatencyMetricsApi;

my $api_instance = WWW::SwaggerClient::EndToEndLatencyMetricsApi->new();
my $topicName = topicName_example; # String | Topic to query about
my $partitionNum = 56; # Integer | Partition to query about
my $groupId = groupId_example; # String | Consumer Group Id queried for
my $clientId = clientId_example; # String | Client Id queried for
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $granularity = granularity_example; # String | Granularity to aggregate the metrics with

eval { 
    my $result = $api_instance->getConsumerMetricsByClientPartition(topicName => $topicName, partitionNum => $partitionNum, groupId => $groupId, clientId => $clientId, duration => $duration, from => $from, to => $to, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientPartition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EndToEndLatencyMetricsApi()
topicName = topicName_example # String | Topic to query about
partitionNum = 56 # Integer | Partition to query about
groupId = groupId_example # String | Consumer Group Id queried for
clientId = clientId_example # String | Client Id queried for
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
granularity = granularity_example # String | Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

try: 
    # Get the end to end latency metrics of a client under a given consumer group for the given partition and topic.
    api_response = api_instance.get_consumer_metrics_by_client_partition(topicName, partitionNum, groupId, clientId, duration=duration, from=from, to=to, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByClientPartition: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Topic to query about
Required
partitionNum*
Integer (int32)
Partition to query about
Required
groupId*
String
Consumer Group Id queried for
Required
clientId*
String
Client Id queried for
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
granularity
String
Granularity to aggregate the metrics with

Responses

Status: 200 - successful operation


getConsumerMetricsByGroup

Get the end to end latency metrics under the given consumer group Id for the given topic.


/api/v1/admin/etelatency/{topicName}/groups/{groupId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}/groups/{groupId}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByGroup(topicName, groupId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByGroup(topicName, groupId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByGroup");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
String *groupId = groupId_example; // Consumer Group Id queried for
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics under the given consumer group Id for the given topic.
[apiInstance getConsumerMetricsByGroupWith:topicName
    groupId:groupId
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var groupId = groupId_example; // {{String}} Consumer Group Id queried for
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'granularity': granularity_example // {{String}} Granularity to aggregate the metrics with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerMetricsByGroup(topicName, groupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerMetricsByGroupExample
    {
        public void main()
        {

            var apiInstance = new EndToEndLatencyMetricsApi();
            var topicName = topicName_example;  // String | Topic to query about
            var groupId = groupId_example;  // String | Consumer Group Id queried for
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var granularity = granularity_example;  // String | Granularity to aggregate the metrics with (optional)  (default to THIRTY_SECS)

            try
            {
                // Get the end to end latency metrics under the given consumer group Id for the given topic.
                ETELatencyMetrics result = apiInstance.getConsumerMetricsByGroup(topicName, groupId, duration, from, to, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EndToEndLatencyMetricsApi.getConsumerMetricsByGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEndToEndLatencyMetricsApi();
$topicName = topicName_example; // String | Topic to query about
$groupId = groupId_example; // String | Consumer Group Id queried for
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$granularity = granularity_example; // String | Granularity to aggregate the metrics with

try {
    $result = $api_instance->getConsumerMetricsByGroup($topicName, $groupId, $duration, $from, $to, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EndToEndLatencyMetricsApi;

my $api_instance = WWW::SwaggerClient::EndToEndLatencyMetricsApi->new();
my $topicName = topicName_example; # String | Topic to query about
my $groupId = groupId_example; # String | Consumer Group Id queried for
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $granularity = granularity_example; # String | Granularity to aggregate the metrics with

eval { 
    my $result = $api_instance->getConsumerMetricsByGroup(topicName => $topicName, groupId => $groupId, duration => $duration, from => $from, to => $to, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EndToEndLatencyMetricsApi()
topicName = topicName_example # String | Topic to query about
groupId = groupId_example # String | Consumer Group Id queried for
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
granularity = granularity_example # String | Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

try: 
    # Get the end to end latency metrics under the given consumer group Id for the given topic.
    api_response = api_instance.get_consumer_metrics_by_group(topicName, groupId, duration=duration, from=from, to=to, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByGroup: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Topic to query about
Required
groupId*
String
Consumer Group Id queried for
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
granularity
String
Granularity to aggregate the metrics with

Responses

Status: 200 - successful operation


getConsumerMetricsByPartition

Get the end to end latency metrics under a given consumer group for the given partition and topic.


/api/v1/admin/etelatency/{topicName}/partitions/{partitionNum}/groups/{groupId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/etelatency/{topicName}/partitions/{partitionNum}/groups/{groupId}?duration=&from=&to=&granularity="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EndToEndLatencyMetricsApi;

import java.io.File;
import java.util.*;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        Integer partitionNum = 56; // Integer | Partition to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByPartition(topicName, partitionNum, groupId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByPartition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.EndToEndLatencyMetricsApi;

public class EndToEndLatencyMetricsApiExample {

    public static void main(String[] args) {
        EndToEndLatencyMetricsApi apiInstance = new EndToEndLatencyMetricsApi();
        String topicName = topicName_example; // String | Topic to query about
        Integer partitionNum = 56; // Integer | Partition to query about
        String groupId = groupId_example; // String | Consumer Group Id queried for
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String granularity = granularity_example; // String | Granularity to aggregate the metrics with
        try {
            ETELatencyMetrics result = apiInstance.getConsumerMetricsByPartition(topicName, partitionNum, groupId, duration, from, to, granularity);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndToEndLatencyMetricsApi#getConsumerMetricsByPartition");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Topic to query about
Integer *partitionNum = 56; // Partition to query about
String *groupId = groupId_example; // Consumer Group Id queried for
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *granularity = granularity_example; // Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

EndToEndLatencyMetricsApi *apiInstance = [[EndToEndLatencyMetricsApi alloc] init];

// Get the end to end latency metrics under a given consumer group for the given partition and topic.
[apiInstance getConsumerMetricsByPartitionWith:topicName
    partitionNum:partitionNum
    groupId:groupId
    duration:duration
    from:from
    to:to
    granularity:granularity
              completionHandler: ^(ETELatencyMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.EndToEndLatencyMetricsApi()
var topicName = topicName_example; // {{String}} Topic to query about
var partitionNum = 56; // {{Integer}} Partition to query about
var groupId = groupId_example; // {{String}} Consumer Group Id queried for
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'granularity': granularity_example // {{String}} Granularity to aggregate the metrics with
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerMetricsByPartition(topicName, partitionNum, groupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerMetricsByPartitionExample
    {
        public void main()
        {

            var apiInstance = new EndToEndLatencyMetricsApi();
            var topicName = topicName_example;  // String | Topic to query about
            var partitionNum = 56;  // Integer | Partition to query about
            var groupId = groupId_example;  // String | Consumer Group Id queried for
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var granularity = granularity_example;  // String | Granularity to aggregate the metrics with (optional)  (default to THIRTY_SECS)

            try
            {
                // Get the end to end latency metrics under a given consumer group for the given partition and topic.
                ETELatencyMetrics result = apiInstance.getConsumerMetricsByPartition(topicName, partitionNum, groupId, duration, from, to, granularity);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EndToEndLatencyMetricsApi.getConsumerMetricsByPartition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiEndToEndLatencyMetricsApi();
$topicName = topicName_example; // String | Topic to query about
$partitionNum = 56; // Integer | Partition to query about
$groupId = groupId_example; // String | Consumer Group Id queried for
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$granularity = granularity_example; // String | Granularity to aggregate the metrics with

try {
    $result = $api_instance->getConsumerMetricsByPartition($topicName, $partitionNum, $groupId, $duration, $from, $to, $granularity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByPartition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EndToEndLatencyMetricsApi;

my $api_instance = WWW::SwaggerClient::EndToEndLatencyMetricsApi->new();
my $topicName = topicName_example; # String | Topic to query about
my $partitionNum = 56; # Integer | Partition to query about
my $groupId = groupId_example; # String | Consumer Group Id queried for
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $granularity = granularity_example; # String | Granularity to aggregate the metrics with

eval { 
    my $result = $api_instance->getConsumerMetricsByPartition(topicName => $topicName, partitionNum => $partitionNum, groupId => $groupId, duration => $duration, from => $from, to => $to, granularity => $granularity);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByPartition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.EndToEndLatencyMetricsApi()
topicName = topicName_example # String | Topic to query about
partitionNum = 56 # Integer | Partition to query about
groupId = groupId_example # String | Consumer Group Id queried for
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
granularity = granularity_example # String | Granularity to aggregate the metrics with (optional) (default to THIRTY_SECS)

try: 
    # Get the end to end latency metrics under a given consumer group for the given partition and topic.
    api_response = api_instance.get_consumer_metrics_by_partition(topicName, partitionNum, groupId, duration=duration, from=from, to=to, granularity=granularity)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndToEndLatencyMetricsApi->getConsumerMetricsByPartition: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Topic to query about
Required
partitionNum*
Integer (int32)
Partition to query about
Required
groupId*
String
Consumer Group Id queried for
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
granularity
String
Granularity to aggregate the metrics with

Responses

Status: 200 - successful operation


KafkaConnectConfigOperations

isKafkaConnectConfigured

Check if Kafka Connect is configured


/api/v1/admin/kafka-connect/is-configured

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/is-configured"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectConfigOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectConfigOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectConfigOperationsApi apiInstance = new KafkaConnectConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isKafkaConnectConfigured();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectConfigOperationsApi#isKafkaConnectConfigured");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectConfigOperationsApi;

public class KafkaConnectConfigOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectConfigOperationsApi apiInstance = new KafkaConnectConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isKafkaConnectConfigured();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectConfigOperationsApi#isKafkaConnectConfigured");
            e.printStackTrace();
        }
    }
}

KafkaConnectConfigOperationsApi *apiInstance = [[KafkaConnectConfigOperationsApi alloc] init];

// Check if Kafka Connect is configured
[apiInstance isKafkaConnectConfiguredWithCompletionHandler: 
              ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectConfigOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isKafkaConnectConfigured(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isKafkaConnectConfiguredExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectConfigOperationsApi();

            try
            {
                // Check if Kafka Connect is configured
                'Boolean' result = apiInstance.isKafkaConnectConfigured();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectConfigOperationsApi.isKafkaConnectConfigured: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectConfigOperationsApi();

try {
    $result = $api_instance->isKafkaConnectConfigured();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectConfigOperationsApi->isKafkaConnectConfigured: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectConfigOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectConfigOperationsApi->new();

eval { 
    my $result = $api_instance->isKafkaConnectConfigured();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectConfigOperationsApi->isKafkaConnectConfigured: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectConfigOperationsApi()

try: 
    # Check if Kafka Connect is configured
    api_response = api_instance.is_kafka_connect_configured()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectConfigOperationsApi->isKafkaConnectConfigured: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


KafkaConnectMetricsOperations

getConnectWorkerMetrics

Get worker level metrics for the given connector.


/api/v1/admin/metrics/connect/workers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/connect/workers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectMetricsOperationsApi apiInstance = new KafkaConnectMetricsOperationsApi();
        try {
            array[ConnectWorkerMetrics] result = apiInstance.getConnectWorkerMetrics();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectMetricsOperationsApi#getConnectWorkerMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectMetricsOperationsApi;

public class KafkaConnectMetricsOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectMetricsOperationsApi apiInstance = new KafkaConnectMetricsOperationsApi();
        try {
            array[ConnectWorkerMetrics] result = apiInstance.getConnectWorkerMetrics();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectMetricsOperationsApi#getConnectWorkerMetrics");
            e.printStackTrace();
        }
    }
}

KafkaConnectMetricsOperationsApi *apiInstance = [[KafkaConnectMetricsOperationsApi alloc] init];

// Get worker level metrics for the given connector.
[apiInstance getConnectWorkerMetricsWithCompletionHandler: 
              ^(array[ConnectWorkerMetrics] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectMetricsOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectWorkerMetrics(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConnectWorkerMetricsExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectMetricsOperationsApi();

            try
            {
                // Get worker level metrics for the given connector.
                array[ConnectWorkerMetrics] result = apiInstance.getConnectWorkerMetrics();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectMetricsOperationsApi.getConnectWorkerMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectMetricsOperationsApi();

try {
    $result = $api_instance->getConnectWorkerMetrics();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectMetricsOperationsApi->getConnectWorkerMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectMetricsOperationsApi->new();

eval { 
    my $result = $api_instance->getConnectWorkerMetrics();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectMetricsOperationsApi->getConnectWorkerMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectMetricsOperationsApi()

try: 
    # Get worker level metrics for the given connector.
    api_response = api_instance.get_connect_worker_metrics()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectMetricsOperationsApi->getConnectWorkerMetrics: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getSinkConnectorTaskMetrics

Get task level metrics for the given connector.


/api/v1/admin/metrics/connect/sink/{connectorName}/{taskId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/connect/sink/{connectorName}/{taskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectMetricsOperationsApi apiInstance = new KafkaConnectMetricsOperationsApi();
        String connectorName = connectorName_example; // String | Name of the connector
        Integer taskId = 56; // Integer | Task Id
        try {
            SinkConnectorTaskMetrics result = apiInstance.getSinkConnectorTaskMetrics(connectorName, taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectMetricsOperationsApi#getSinkConnectorTaskMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectMetricsOperationsApi;

public class KafkaConnectMetricsOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectMetricsOperationsApi apiInstance = new KafkaConnectMetricsOperationsApi();
        String connectorName = connectorName_example; // String | Name of the connector
        Integer taskId = 56; // Integer | Task Id
        try {
            SinkConnectorTaskMetrics result = apiInstance.getSinkConnectorTaskMetrics(connectorName, taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectMetricsOperationsApi#getSinkConnectorTaskMetrics");
            e.printStackTrace();
        }
    }
}
String *connectorName = connectorName_example; // Name of the connector
Integer *taskId = 56; // Task Id

KafkaConnectMetricsOperationsApi *apiInstance = [[KafkaConnectMetricsOperationsApi alloc] init];

// Get task level metrics for the given connector.
[apiInstance getSinkConnectorTaskMetricsWith:connectorName
    taskId:taskId
              completionHandler: ^(SinkConnectorTaskMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectMetricsOperationsApi()
var connectorName = connectorName_example; // {{String}} Name of the connector
var taskId = 56; // {{Integer}} Task Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSinkConnectorTaskMetrics(connectorName, taskId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSinkConnectorTaskMetricsExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectMetricsOperationsApi();
            var connectorName = connectorName_example;  // String | Name of the connector
            var taskId = 56;  // Integer | Task Id

            try
            {
                // Get task level metrics for the given connector.
                SinkConnectorTaskMetrics result = apiInstance.getSinkConnectorTaskMetrics(connectorName, taskId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectMetricsOperationsApi.getSinkConnectorTaskMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectMetricsOperationsApi();
$connectorName = connectorName_example; // String | Name of the connector
$taskId = 56; // Integer | Task Id

try {
    $result = $api_instance->getSinkConnectorTaskMetrics($connectorName, $taskId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectMetricsOperationsApi->getSinkConnectorTaskMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectMetricsOperationsApi->new();
my $connectorName = connectorName_example; # String | Name of the connector
my $taskId = 56; # Integer | Task Id

eval { 
    my $result = $api_instance->getSinkConnectorTaskMetrics(connectorName => $connectorName, taskId => $taskId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectMetricsOperationsApi->getSinkConnectorTaskMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectMetricsOperationsApi()
connectorName = connectorName_example # String | Name of the connector
taskId = 56 # Integer | Task Id

try: 
    # Get task level metrics for the given connector.
    api_response = api_instance.get_sink_connector_task_metrics(connectorName, taskId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectMetricsOperationsApi->getSinkConnectorTaskMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
connectorName*
String
Name of the connector
Required
taskId*
Integer (int32)
Task Id
Required

Responses

Status: 200 - successful operation


getSourceConnectorTaskMetrics

Get task level metrics for the given connector.


/api/v1/admin/metrics/connect/source/{connectorName}/{taskId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/connect/source/{connectorName}/{taskId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectMetricsOperationsApi apiInstance = new KafkaConnectMetricsOperationsApi();
        String connectorName = connectorName_example; // String | Name of the connector
        Integer taskId = 56; // Integer | Task Id
        try {
            SourceConnectorTaskMetrics result = apiInstance.getSourceConnectorTaskMetrics(connectorName, taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectMetricsOperationsApi#getSourceConnectorTaskMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectMetricsOperationsApi;

public class KafkaConnectMetricsOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectMetricsOperationsApi apiInstance = new KafkaConnectMetricsOperationsApi();
        String connectorName = connectorName_example; // String | Name of the connector
        Integer taskId = 56; // Integer | Task Id
        try {
            SourceConnectorTaskMetrics result = apiInstance.getSourceConnectorTaskMetrics(connectorName, taskId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectMetricsOperationsApi#getSourceConnectorTaskMetrics");
            e.printStackTrace();
        }
    }
}
String *connectorName = connectorName_example; // Name of the connector
Integer *taskId = 56; // Task Id

KafkaConnectMetricsOperationsApi *apiInstance = [[KafkaConnectMetricsOperationsApi alloc] init];

// Get task level metrics for the given connector.
[apiInstance getSourceConnectorTaskMetricsWith:connectorName
    taskId:taskId
              completionHandler: ^(SourceConnectorTaskMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectMetricsOperationsApi()
var connectorName = connectorName_example; // {{String}} Name of the connector
var taskId = 56; // {{Integer}} Task Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSourceConnectorTaskMetrics(connectorName, taskId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSourceConnectorTaskMetricsExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectMetricsOperationsApi();
            var connectorName = connectorName_example;  // String | Name of the connector
            var taskId = 56;  // Integer | Task Id

            try
            {
                // Get task level metrics for the given connector.
                SourceConnectorTaskMetrics result = apiInstance.getSourceConnectorTaskMetrics(connectorName, taskId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectMetricsOperationsApi.getSourceConnectorTaskMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectMetricsOperationsApi();
$connectorName = connectorName_example; // String | Name of the connector
$taskId = 56; // Integer | Task Id

try {
    $result = $api_instance->getSourceConnectorTaskMetrics($connectorName, $taskId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectMetricsOperationsApi->getSourceConnectorTaskMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectMetricsOperationsApi->new();
my $connectorName = connectorName_example; # String | Name of the connector
my $taskId = 56; # Integer | Task Id

eval { 
    my $result = $api_instance->getSourceConnectorTaskMetrics(connectorName => $connectorName, taskId => $taskId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectMetricsOperationsApi->getSourceConnectorTaskMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectMetricsOperationsApi()
connectorName = connectorName_example # String | Name of the connector
taskId = 56 # Integer | Task Id

try: 
    # Get task level metrics for the given connector.
    api_response = api_instance.get_source_connector_task_metrics(connectorName, taskId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectMetricsOperationsApi->getSourceConnectorTaskMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
connectorName*
String
Name of the connector
Required
taskId*
Integer (int32)
Task Id
Required

Responses

Status: 200 - successful operation


KafkaConnectOperations

configureConnector

Create or reconfigure a Connector


/api/v1/admin/kafka-connect/connectors/{connector}

Usage and SDK Samples

curl -X PUT\
-H "Content-Type: */*"\
"//api/v1/admin/kafka-connect/connectors/{connector}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        map[String, Object] body = ; // map[String, Object] | 
        try {
            apiInstance.configureConnector(connector, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#configureConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        map[String, Object] body = ; // map[String, Object] | 
        try {
            apiInstance.configureConnector(connector, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#configureConnector");
            e.printStackTrace();
        }
    }
}
String *connector = connector_example; // Connector name
map[String, Object] *body = ; //  (optional)

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Create or reconfigure a Connector
[apiInstance configureConnectorWith:connector
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var connector = connector_example; // {{String}} Connector name
var opts = { 
  'body':  // {{map[String, Object]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.configureConnector(connector, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class configureConnectorExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connector = connector_example;  // String | Connector name
            var body = new map[String, Object](); // map[String, Object] |  (optional) 

            try
            {
                // Create or reconfigure a Connector
                apiInstance.configureConnector(connector, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.configureConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connector = connector_example; // String | Connector name
$body = ; // map[String, Object] | 

try {
    $api_instance->configureConnector($connector, $body);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->configureConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connector = connector_example; # String | Connector name
my $body = WWW::SwaggerClient::Object::map[String, Object]->new(); # map[String, Object] | 

eval { 
    $api_instance->configureConnector(connector => $connector, body => $body);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->configureConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connector = connector_example # String | Connector name
body =  # map[String, Object] |  (optional)

try: 
    # Create or reconfigure a Connector
    api_instance.configure_connector(connector, body=body)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->configureConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connector*
String
Connector name
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


connector

Get info for a single configured Connector or null if it does not exist


/api/v1/admin/kafka-connect/connectors/{connector}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/connectors/{connector}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        try {
            ConnectorResponse result = apiInstance.connector(connector);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#connector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        try {
            ConnectorResponse result = apiInstance.connector(connector);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#connector");
            e.printStackTrace();
        }
    }
}
String *connector = connector_example; // Connector name

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Get info for a single configured Connector or null if it does not exist
[apiInstance connectorWith:connector
              completionHandler: ^(ConnectorResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var connector = connector_example; // {{String}} Connector name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.connector(connector, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class connectorExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connector = connector_example;  // String | Connector name

            try
            {
                // Get info for a single configured Connector or null if it does not exist
                ConnectorResponse result = apiInstance.connector(connector);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.connector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connector = connector_example; // String | Connector name

try {
    $result = $api_instance->connector($connector);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->connector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connector = connector_example; # String | Connector name

eval { 
    my $result = $api_instance->connector(connector => $connector);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->connector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connector = connector_example # String | Connector name

try: 
    # Get info for a single configured Connector or null if it does not exist
    api_response = api_instance.connector(connector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->connector: %s\n" % e)

Parameters

Path parameters
Name Description
connector*
String
Connector name
Required

Responses

Status: 200 - successful operation


connectorOperation

Pause, resume, or restart a Connector


/api/v1/admin/kafka-connect/connectors/{connector}/{operation}

Usage and SDK Samples

curl -X POST\
"//api/v1/admin/kafka-connect/connectors/{connector}/{operation}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        String operation = operation_example; // String | Operation
        try {
            apiInstance.connectorOperation(connector, operation);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#connectorOperation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        String operation = operation_example; // String | Operation
        try {
            apiInstance.connectorOperation(connector, operation);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#connectorOperation");
            e.printStackTrace();
        }
    }
}
String *connector = connector_example; // Connector name
String *operation = operation_example; // Operation

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Pause, resume, or restart a Connector
[apiInstance connectorOperationWith:connector
    operation:operation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var connector = connector_example; // {{String}} Connector name
var operation = operation_example; // {{String}} Operation

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.connectorOperation(connector, operation, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class connectorOperationExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connector = connector_example;  // String | Connector name
            var operation = operation_example;  // String | Operation

            try
            {
                // Pause, resume, or restart a Connector
                apiInstance.connectorOperation(connector, operation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.connectorOperation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connector = connector_example; // String | Connector name
$operation = operation_example; // String | Operation

try {
    $api_instance->connectorOperation($connector, $operation);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->connectorOperation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connector = connector_example; # String | Connector name
my $operation = operation_example; # String | Operation

eval { 
    $api_instance->connectorOperation(connector => $connector, operation => $operation);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->connectorOperation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connector = connector_example # String | Connector name
operation = operation_example # String | Operation

try: 
    # Pause, resume, or restart a Connector
    api_instance.connector_operation(connector, operation)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->connectorOperation: %s\n" % e)

Parameters

Path parameters
Name Description
connector*
String
Connector name
Required
operation*
String
Operation
Required

Responses

Status: default - successful operation


connectorTemplates

Returns a list of connector templates that can be used for creating connectors


/api/v1/admin/kafka-connect/connector-templates

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/connector-templates"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        try {
            array[ConnectorTemplate] result = apiInstance.connectorTemplates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#connectorTemplates");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        try {
            array[ConnectorTemplate] result = apiInstance.connectorTemplates();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#connectorTemplates");
            e.printStackTrace();
        }
    }
}

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Returns a list of connector templates that can be used for creating connectors
[apiInstance connectorTemplatesWithCompletionHandler: 
              ^(array[ConnectorTemplate] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.connectorTemplates(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class connectorTemplatesExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();

            try
            {
                // Returns a list of connector templates that can be used for creating connectors
                array[ConnectorTemplate] result = apiInstance.connectorTemplates();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.connectorTemplates: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();

try {
    $result = $api_instance->connectorTemplates();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->connectorTemplates: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();

eval { 
    my $result = $api_instance->connectorTemplates();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->connectorTemplates: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()

try: 
    # Returns a list of connector templates that can be used for creating connectors
    api_response = api_instance.connector_templates()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->connectorTemplates: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


connectors

Get info for all configured Connectors


/api/v1/admin/kafka-connect/connectors

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/connectors"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        try {
            ConnectorsResponse result = apiInstance.connectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#connectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        try {
            ConnectorsResponse result = apiInstance.connectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#connectors");
            e.printStackTrace();
        }
    }
}

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Get info for all configured Connectors
[apiInstance connectorsWithCompletionHandler: 
              ^(ConnectorsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.connectors(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class connectorsExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();

            try
            {
                // Get info for all configured Connectors
                ConnectorsResponse result = apiInstance.connectors();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.connectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();

try {
    $result = $api_instance->connectors();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->connectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();

eval { 
    my $result = $api_instance->connectors();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->connectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()

try: 
    # Get info for all configured Connectors
    api_response = api_instance.connectors()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->connectors: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


createConnector

Create a Connector


/api/v1/admin/kafka-connect/connectors

Usage and SDK Samples

curl -X POST\
-H "Content-Type: */*"\
"//api/v1/admin/kafka-connect/connectors"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        CreateConnectorUIRequest body = ; // CreateConnectorUIRequest | 
        try {
            apiInstance.createConnector(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#createConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        CreateConnectorUIRequest body = ; // CreateConnectorUIRequest | 
        try {
            apiInstance.createConnector(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#createConnector");
            e.printStackTrace();
        }
    }
}
CreateConnectorUIRequest *body = ; //  (optional)

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Create a Connector
[apiInstance createConnectorWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var opts = { 
  'body':  // {{CreateConnectorUIRequest}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createConnector(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createConnectorExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var body = new CreateConnectorUIRequest(); // CreateConnectorUIRequest |  (optional) 

            try
            {
                // Create a Connector
                apiInstance.createConnector(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.createConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$body = ; // CreateConnectorUIRequest | 

try {
    $api_instance->createConnector($body);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->createConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $body = WWW::SwaggerClient::Object::CreateConnectorUIRequest->new(); # CreateConnectorUIRequest | 

eval { 
    $api_instance->createConnector(body => $body);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->createConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
body =  # CreateConnectorUIRequest |  (optional)

try: 
    # Create a Connector
    api_instance.create_connector(body=body)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->createConnector: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: default - successful operation


deleteConnector

Delete a Connector


/api/v1/admin/kafka-connect/connectors/{connector}

Usage and SDK Samples

curl -X DELETE\
"//api/v1/admin/kafka-connect/connectors/{connector}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        try {
            apiInstance.deleteConnector(connector);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#deleteConnector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        try {
            apiInstance.deleteConnector(connector);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#deleteConnector");
            e.printStackTrace();
        }
    }
}
String *connector = connector_example; // Connector name

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Delete a Connector
[apiInstance deleteConnectorWith:connector
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var connector = connector_example; // {{String}} Connector name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteConnector(connector, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteConnectorExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connector = connector_example;  // String | Connector name

            try
            {
                // Delete a Connector
                apiInstance.deleteConnector(connector);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.deleteConnector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connector = connector_example; // String | Connector name

try {
    $api_instance->deleteConnector($connector);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->deleteConnector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connector = connector_example; # String | Connector name

eval { 
    $api_instance->deleteConnector(connector => $connector);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->deleteConnector: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connector = connector_example # String | Connector name

try: 
    # Delete a Connector
    api_instance.delete_connector(connector)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->deleteConnector: %s\n" % e)

Parameters

Path parameters
Name Description
connector*
String
Connector name
Required

Responses

Status: default - successful operation


getConnectorConfigDef

Get Configuration Definitions


/api/v1/admin/kafka-connect/connector-templates/config/definitions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/connector-templates/config/definitions?connectorPluginClass="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connectorPluginClass = connectorPluginClass_example; // String | 
        try {
            FetchConfigDefResponse result = apiInstance.getConnectorConfigDef(connectorPluginClass);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#getConnectorConfigDef");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connectorPluginClass = connectorPluginClass_example; // String | 
        try {
            FetchConfigDefResponse result = apiInstance.getConnectorConfigDef(connectorPluginClass);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#getConnectorConfigDef");
            e.printStackTrace();
        }
    }
}
String *connectorPluginClass = connectorPluginClass_example; //  (optional)

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Get Configuration Definitions
[apiInstance getConnectorConfigDefWith:connectorPluginClass
              completionHandler: ^(FetchConfigDefResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var opts = { 
  'connectorPluginClass': connectorPluginClass_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectorConfigDef(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConnectorConfigDefExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connectorPluginClass = connectorPluginClass_example;  // String |  (optional) 

            try
            {
                // Get Configuration Definitions
                FetchConfigDefResponse result = apiInstance.getConnectorConfigDef(connectorPluginClass);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.getConnectorConfigDef: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connectorPluginClass = connectorPluginClass_example; // String | 

try {
    $result = $api_instance->getConnectorConfigDef($connectorPluginClass);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->getConnectorConfigDef: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connectorPluginClass = connectorPluginClass_example; # String | 

eval { 
    my $result = $api_instance->getConnectorConfigDef(connectorPluginClass => $connectorPluginClass);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->getConnectorConfigDef: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connectorPluginClass = connectorPluginClass_example # String |  (optional)

try: 
    # Get Configuration Definitions
    api_response = api_instance.get_connector_config_def(connectorPluginClass=connectorPluginClass)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->getConnectorConfigDef: %s\n" % e)

Parameters

Query parameters
Name Description
connectorPluginClass
String

Responses

Status: 200 - successful operation


getConnectorPermissions

Connector Permissions


/api/v1/admin/kafka-connect/connector-permissions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/connector-permissions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        try {
            ConnectorPermissions result = apiInstance.getConnectorPermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#getConnectorPermissions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        try {
            ConnectorPermissions result = apiInstance.getConnectorPermissions();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#getConnectorPermissions");
            e.printStackTrace();
        }
    }
}

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Connector Permissions
[apiInstance getConnectorPermissionsWithCompletionHandler: 
              ^(ConnectorPermissions output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConnectorPermissions(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConnectorPermissionsExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();

            try
            {
                // Connector Permissions
                ConnectorPermissions result = apiInstance.getConnectorPermissions();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.getConnectorPermissions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();

try {
    $result = $api_instance->getConnectorPermissions();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->getConnectorPermissions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();

eval { 
    my $result = $api_instance->getConnectorPermissions();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->getConnectorPermissions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()

try: 
    # Connector Permissions
    api_response = api_instance.get_connector_permissions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->getConnectorPermissions: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


handleEnhanceConfig

Enhance Provided Configuration

In case of a non Stateless NiFi connector it returns the configuration from the request expanded with the missing sample configuration for a given connector. In case of a Predefined Stateless NiFi connector it returns the configuration from the request expanded with the sample configuration and the predefined flow parameters. In case of a Non Predefined Stateless NiFi connector a flow.snapshot configuration should be provided, and it returns the configuration from the request expanded with the sample configuration and the flow parameters from the flow.snapshot.


/api/v1/admin/kafka-connect/connector-templates/config/enhance

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//api/v1/admin/kafka-connect/connector-templates/config/enhance?connectorPluginClass="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        SamplePluginConfig body = ; // SamplePluginConfig | Provided configuration to expand with the missing parameters.
        String connectorPluginClass = connectorPluginClass_example; // String | 
        try {
            SamplePluginConfig result = apiInstance.handleEnhanceConfig(body, connectorPluginClass);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#handleEnhanceConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        SamplePluginConfig body = ; // SamplePluginConfig | Provided configuration to expand with the missing parameters.
        String connectorPluginClass = connectorPluginClass_example; // String | 
        try {
            SamplePluginConfig result = apiInstance.handleEnhanceConfig(body, connectorPluginClass);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#handleEnhanceConfig");
            e.printStackTrace();
        }
    }
}
SamplePluginConfig *body = ; // Provided configuration to expand with the missing parameters. (optional)
String *connectorPluginClass = connectorPluginClass_example; //  (optional)

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Enhance Provided Configuration
[apiInstance handleEnhanceConfigWith:body
    connectorPluginClass:connectorPluginClass
              completionHandler: ^(SamplePluginConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var opts = { 
  'body':  // {{SamplePluginConfig}} Provided configuration to expand with the missing parameters.
  'connectorPluginClass': connectorPluginClass_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleEnhanceConfig(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleEnhanceConfigExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var body = new SamplePluginConfig(); // SamplePluginConfig | Provided configuration to expand with the missing parameters. (optional) 
            var connectorPluginClass = connectorPluginClass_example;  // String |  (optional) 

            try
            {
                // Enhance Provided Configuration
                SamplePluginConfig result = apiInstance.handleEnhanceConfig(body, connectorPluginClass);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.handleEnhanceConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$body = ; // SamplePluginConfig | Provided configuration to expand with the missing parameters.
$connectorPluginClass = connectorPluginClass_example; // String | 

try {
    $result = $api_instance->handleEnhanceConfig($body, $connectorPluginClass);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->handleEnhanceConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $body = WWW::SwaggerClient::Object::SamplePluginConfig->new(); # SamplePluginConfig | Provided configuration to expand with the missing parameters.
my $connectorPluginClass = connectorPluginClass_example; # String | 

eval { 
    my $result = $api_instance->handleEnhanceConfig(body => $body, connectorPluginClass => $connectorPluginClass);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->handleEnhanceConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
body =  # SamplePluginConfig | Provided configuration to expand with the missing parameters. (optional)
connectorPluginClass = connectorPluginClass_example # String |  (optional)

try: 
    # Enhance Provided Configuration
    api_response = api_instance.handle_enhance_config(body=body, connectorPluginClass=connectorPluginClass)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->handleEnhanceConfig: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
connectorPluginClass
String

Responses

Status: 200 - successful operation


handleGetSampleConfigForTemplate

Template Configuration


/api/v1/admin/kafka-connect/connector-templates/config/sample

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/connector-templates/config/sample?connectorPluginClass=&name=&version="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connectorPluginClass = connectorPluginClass_example; // String | 
        String name = name_example; // String | 
        String version = version_example; // String | 
        try {
            SamplePluginConfig result = apiInstance.handleGetSampleConfigForTemplate(connectorPluginClass, name, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#handleGetSampleConfigForTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connectorPluginClass = connectorPluginClass_example; // String | 
        String name = name_example; // String | 
        String version = version_example; // String | 
        try {
            SamplePluginConfig result = apiInstance.handleGetSampleConfigForTemplate(connectorPluginClass, name, version);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#handleGetSampleConfigForTemplate");
            e.printStackTrace();
        }
    }
}
String *connectorPluginClass = connectorPluginClass_example; //  (optional)
String *name = name_example; //  (optional)
String *version = version_example; //  (optional)

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Template Configuration
[apiInstance handleGetSampleConfigForTemplateWith:connectorPluginClass
    name:name
    version:version
              completionHandler: ^(SamplePluginConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var opts = { 
  'connectorPluginClass': connectorPluginClass_example, // {{String}} 
  'name': name_example, // {{String}} 
  'version': version_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.handleGetSampleConfigForTemplate(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class handleGetSampleConfigForTemplateExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connectorPluginClass = connectorPluginClass_example;  // String |  (optional) 
            var name = name_example;  // String |  (optional) 
            var version = version_example;  // String |  (optional) 

            try
            {
                // Template Configuration
                SamplePluginConfig result = apiInstance.handleGetSampleConfigForTemplate(connectorPluginClass, name, version);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.handleGetSampleConfigForTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connectorPluginClass = connectorPluginClass_example; // String | 
$name = name_example; // String | 
$version = version_example; // String | 

try {
    $result = $api_instance->handleGetSampleConfigForTemplate($connectorPluginClass, $name, $version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->handleGetSampleConfigForTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connectorPluginClass = connectorPluginClass_example; # String | 
my $name = name_example; # String | 
my $version = version_example; # String | 

eval { 
    my $result = $api_instance->handleGetSampleConfigForTemplate(connectorPluginClass => $connectorPluginClass, name => $name, version => $version);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->handleGetSampleConfigForTemplate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connectorPluginClass = connectorPluginClass_example # String |  (optional)
name = name_example # String |  (optional)
version = version_example # String |  (optional)

try: 
    # Template Configuration
    api_response = api_instance.handle_get_sample_config_for_template(connectorPluginClass=connectorPluginClass, name=name, version=version)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->handleGetSampleConfigForTemplate: %s\n" % e)

Parameters

Query parameters
Name Description
connectorPluginClass
String
name
String
version
String

Responses

Status: 200 - successful operation


pluginConfigSample

Return a sample configuration of a connector plugin


/api/v1/admin/kafka-connect/connector-plugins/{connector}/config/sample

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/connector-plugins/{connector}/config/sample"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        try {
            SamplePluginConfig result = apiInstance.pluginConfigSample(connector);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#pluginConfigSample");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        try {
            SamplePluginConfig result = apiInstance.pluginConfigSample(connector);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#pluginConfigSample");
            e.printStackTrace();
        }
    }
}
String *connector = connector_example; // Connector name

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Return a sample configuration of a connector plugin
[apiInstance pluginConfigSampleWith:connector
              completionHandler: ^(SamplePluginConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var connector = connector_example; // {{String}} Connector name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginConfigSample(connector, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pluginConfigSampleExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connector = connector_example;  // String | Connector name

            try
            {
                // Return a sample configuration of a connector plugin
                SamplePluginConfig result = apiInstance.pluginConfigSample(connector);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.pluginConfigSample: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connector = connector_example; // String | Connector name

try {
    $result = $api_instance->pluginConfigSample($connector);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->pluginConfigSample: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connector = connector_example; # String | Connector name

eval { 
    my $result = $api_instance->pluginConfigSample(connector => $connector);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->pluginConfigSample: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connector = connector_example # String | Connector name

try: 
    # Return a sample configuration of a connector plugin
    api_response = api_instance.plugin_config_sample(connector)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->pluginConfigSample: %s\n" % e)

Parameters

Path parameters
Name Description
connector*
String
Connector name
Required

Responses

Status: 200 - successful operation


pluginConnectors

Return a list of connector plugins installed in the Kafka Connect cluster


/api/v1/admin/kafka-connect/connector-plugins

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/kafka-connect/connector-plugins"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        try {
            array[ConnectorPluginDTO] result = apiInstance.pluginConnectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#pluginConnectors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        try {
            array[ConnectorPluginDTO] result = apiInstance.pluginConnectors();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#pluginConnectors");
            e.printStackTrace();
        }
    }
}

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Return a list of connector plugins installed in the Kafka Connect cluster
[apiInstance pluginConnectorsWithCompletionHandler: 
              ^(array[ConnectorPluginDTO] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pluginConnectors(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class pluginConnectorsExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();

            try
            {
                // Return a list of connector plugins installed in the Kafka Connect cluster
                array[ConnectorPluginDTO] result = apiInstance.pluginConnectors();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.pluginConnectors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();

try {
    $result = $api_instance->pluginConnectors();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->pluginConnectors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();

eval { 
    my $result = $api_instance->pluginConnectors();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->pluginConnectors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()

try: 
    # Return a list of connector plugins installed in the Kafka Connect cluster
    api_response = api_instance.plugin_connectors()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->pluginConnectors: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


taskOperation

Restart a Task


/api/v1/admin/kafka-connect/connectors/{connector}/tasks/{task}/{operation}

Usage and SDK Samples

curl -X POST\
"//api/v1/admin/kafka-connect/connectors/{connector}/tasks/{task}/{operation}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        Integer task = 56; // Integer | Task id
        String operation = operation_example; // String | Operation
        try {
            apiInstance.taskOperation(connector, task, operation);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#taskOperation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        Integer task = 56; // Integer | Task id
        String operation = operation_example; // String | Operation
        try {
            apiInstance.taskOperation(connector, task, operation);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#taskOperation");
            e.printStackTrace();
        }
    }
}
String *connector = connector_example; // Connector name
Integer *task = 56; // Task id
String *operation = operation_example; // Operation

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Restart a Task
[apiInstance taskOperationWith:connector
    task:task
    operation:operation
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var connector = connector_example; // {{String}} Connector name
var task = 56; // {{Integer}} Task id
var operation = operation_example; // {{String}} Operation

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.taskOperation(connector, task, operation, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class taskOperationExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connector = connector_example;  // String | Connector name
            var task = 56;  // Integer | Task id
            var operation = operation_example;  // String | Operation

            try
            {
                // Restart a Task
                apiInstance.taskOperation(connector, task, operation);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.taskOperation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connector = connector_example; // String | Connector name
$task = 56; // Integer | Task id
$operation = operation_example; // String | Operation

try {
    $api_instance->taskOperation($connector, $task, $operation);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->taskOperation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connector = connector_example; # String | Connector name
my $task = 56; # Integer | Task id
my $operation = operation_example; # String | Operation

eval { 
    $api_instance->taskOperation(connector => $connector, task => $task, operation => $operation);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->taskOperation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connector = connector_example # String | Connector name
task = 56 # Integer | Task id
operation = operation_example # String | Operation

try: 
    # Restart a Task
    api_instance.task_operation(connector, task, operation)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->taskOperation: %s\n" % e)

Parameters

Path parameters
Name Description
connector*
String
Connector name
Required
task*
Integer (int32)
Task id
Required
operation*
String
Operation
Required

Responses

Status: default - successful operation


validateConfig

Validate Connector Configuration


/api/v1/admin/kafka-connect/connector-plugins/{connector}/config/validate

Usage and SDK Samples

curl -X PUT\
-H "Content-Type: */*"\
"//api/v1/admin/kafka-connect/connector-plugins/{connector}/config/validate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        map[String, Object] body = ; // map[String, Object] | 
        try {
            apiInstance.validateConfig(connector, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#validateConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        String connector = connector_example; // String | Connector name
        map[String, Object] body = ; // map[String, Object] | 
        try {
            apiInstance.validateConfig(connector, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#validateConfig");
            e.printStackTrace();
        }
    }
}
String *connector = connector_example; // Connector name
map[String, Object] *body = ; //  (optional)

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Validate Connector Configuration
[apiInstance validateConfigWith:connector
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var connector = connector_example; // {{String}} Connector name
var opts = { 
  'body':  // {{map[String, Object]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.validateConfig(connector, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateConfigExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var connector = connector_example;  // String | Connector name
            var body = new map[String, Object](); // map[String, Object] |  (optional) 

            try
            {
                // Validate Connector Configuration
                apiInstance.validateConfig(connector, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.validateConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$connector = connector_example; // String | Connector name
$body = ; // map[String, Object] | 

try {
    $api_instance->validateConfig($connector, $body);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->validateConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $connector = connector_example; # String | Connector name
my $body = WWW::SwaggerClient::Object::map[String, Object]->new(); # map[String, Object] | 

eval { 
    $api_instance->validateConfig(connector => $connector, body => $body);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->validateConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
connector = connector_example # String | Connector name
body =  # map[String, Object] |  (optional)

try: 
    # Validate Connector Configuration
    api_instance.validate_config(connector, body=body)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->validateConfig: %s\n" % e)

Parameters

Path parameters
Name Description
connector*
String
Connector name
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


validateTemplateConfig

Validate Template Configuration


/api/v1/admin/kafka-connect/connector-templates/config/validate

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//api/v1/admin/kafka-connect/connector-templates/config/validate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        ValidateTemplateConfigRequest body = ; // ValidateTemplateConfigRequest | 
        try {
            ValidateTemplateConfigResponse result = apiInstance.validateTemplateConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#validateTemplateConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        ValidateTemplateConfigRequest body = ; // ValidateTemplateConfigRequest | 
        try {
            ValidateTemplateConfigResponse result = apiInstance.validateTemplateConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#validateTemplateConfig");
            e.printStackTrace();
        }
    }
}
ValidateTemplateConfigRequest *body = ; //  (optional)

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Validate Template Configuration
[apiInstance validateTemplateConfigWith:body
              completionHandler: ^(ValidateTemplateConfigResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var opts = { 
  'body':  // {{ValidateTemplateConfigRequest}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateTemplateConfig(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateTemplateConfigExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var body = new ValidateTemplateConfigRequest(); // ValidateTemplateConfigRequest |  (optional) 

            try
            {
                // Validate Template Configuration
                ValidateTemplateConfigResponse result = apiInstance.validateTemplateConfig(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.validateTemplateConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$body = ; // ValidateTemplateConfigRequest | 

try {
    $result = $api_instance->validateTemplateConfig($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->validateTemplateConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ValidateTemplateConfigRequest->new(); # ValidateTemplateConfigRequest | 

eval { 
    my $result = $api_instance->validateTemplateConfig(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->validateTemplateConfig: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
body =  # ValidateTemplateConfigRequest |  (optional)

try: 
    # Validate Template Configuration
    api_response = api_instance.validate_template_config(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->validateTemplateConfig: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - successful operation


validateTemplateConfigDetailed

Validate Template Configuration


/api/v1/admin/kafka-connect/connector-templates/config/validate-detailed

Usage and SDK Samples

curl -X PUT\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//api/v1/admin/kafka-connect/connector-templates/config/validate-detailed"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.KafkaConnectOperationsApi;

import java.io.File;
import java.util.*;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        ValidateTemplateConfigRequest body = ; // ValidateTemplateConfigRequest | 
        try {
            ValidateTemplateConfigDetailedResponse result = apiInstance.validateTemplateConfigDetailed(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#validateTemplateConfigDetailed");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.KafkaConnectOperationsApi;

public class KafkaConnectOperationsApiExample {

    public static void main(String[] args) {
        KafkaConnectOperationsApi apiInstance = new KafkaConnectOperationsApi();
        ValidateTemplateConfigRequest body = ; // ValidateTemplateConfigRequest | 
        try {
            ValidateTemplateConfigDetailedResponse result = apiInstance.validateTemplateConfigDetailed(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling KafkaConnectOperationsApi#validateTemplateConfigDetailed");
            e.printStackTrace();
        }
    }
}
ValidateTemplateConfigRequest *body = ; //  (optional)

KafkaConnectOperationsApi *apiInstance = [[KafkaConnectOperationsApi alloc] init];

// Validate Template Configuration
[apiInstance validateTemplateConfigDetailedWith:body
              completionHandler: ^(ValidateTemplateConfigDetailedResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.KafkaConnectOperationsApi()
var opts = { 
  'body':  // {{ValidateTemplateConfigRequest}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.validateTemplateConfigDetailed(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class validateTemplateConfigDetailedExample
    {
        public void main()
        {

            var apiInstance = new KafkaConnectOperationsApi();
            var body = new ValidateTemplateConfigRequest(); // ValidateTemplateConfigRequest |  (optional) 

            try
            {
                // Validate Template Configuration
                ValidateTemplateConfigDetailedResponse result = apiInstance.validateTemplateConfigDetailed(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling KafkaConnectOperationsApi.validateTemplateConfigDetailed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiKafkaConnectOperationsApi();
$body = ; // ValidateTemplateConfigRequest | 

try {
    $result = $api_instance->validateTemplateConfigDetailed($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling KafkaConnectOperationsApi->validateTemplateConfigDetailed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::KafkaConnectOperationsApi;

my $api_instance = WWW::SwaggerClient::KafkaConnectOperationsApi->new();
my $body = WWW::SwaggerClient::Object::ValidateTemplateConfigRequest->new(); # ValidateTemplateConfigRequest | 

eval { 
    my $result = $api_instance->validateTemplateConfigDetailed(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling KafkaConnectOperationsApi->validateTemplateConfigDetailed: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.KafkaConnectOperationsApi()
body =  # ValidateTemplateConfigRequest |  (optional)

try: 
    # Validate Template Configuration
    api_response = api_instance.validate_template_config_detailed(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling KafkaConnectOperationsApi->validateTemplateConfigDetailed: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - successful operation


LineageOperations

getConsumerGroupLineage

Get lineage for Consumer Group


/api/v2/admin/lineage/consumerGroups/{consumerGroupId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/lineage/consumerGroups/{consumerGroupId}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LineageOperationsApi;

import java.io.File;
import java.util.*;

public class LineageOperationsApiExample {

    public static void main(String[] args) {
        
        LineageOperationsApi apiInstance = new LineageOperationsApi();
        String consumerGroupId = consumerGroupId_example; // String | Consumer Group
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ConsumerGroupLineage result = apiInstance.getConsumerGroupLineage(consumerGroupId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageOperationsApi#getConsumerGroupLineage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LineageOperationsApi;

public class LineageOperationsApiExample {

    public static void main(String[] args) {
        LineageOperationsApi apiInstance = new LineageOperationsApi();
        String consumerGroupId = consumerGroupId_example; // String | Consumer Group
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ConsumerGroupLineage result = apiInstance.getConsumerGroupLineage(consumerGroupId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageOperationsApi#getConsumerGroupLineage");
            e.printStackTrace();
        }
    }
}
String *consumerGroupId = consumerGroupId_example; // Consumer Group
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

LineageOperationsApi *apiInstance = [[LineageOperationsApi alloc] init];

// Get lineage for Consumer Group
[apiInstance getConsumerGroupLineageWith:consumerGroupId
    duration:duration
    from:from
    to:to
              completionHandler: ^(ConsumerGroupLineage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.LineageOperationsApi()
var consumerGroupId = consumerGroupId_example; // {{String}} Consumer Group
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConsumerGroupLineage(consumerGroupId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getConsumerGroupLineageExample
    {
        public void main()
        {

            var apiInstance = new LineageOperationsApi();
            var consumerGroupId = consumerGroupId_example;  // String | Consumer Group
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get lineage for Consumer Group
                ConsumerGroupLineage result = apiInstance.getConsumerGroupLineage(consumerGroupId, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LineageOperationsApi.getConsumerGroupLineage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLineageOperationsApi();
$consumerGroupId = consumerGroupId_example; // String | Consumer Group
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getConsumerGroupLineage($consumerGroupId, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LineageOperationsApi->getConsumerGroupLineage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LineageOperationsApi;

my $api_instance = WWW::SwaggerClient::LineageOperationsApi->new();
my $consumerGroupId = consumerGroupId_example; # String | Consumer Group
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getConsumerGroupLineage(consumerGroupId => $consumerGroupId, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LineageOperationsApi->getConsumerGroupLineage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LineageOperationsApi()
consumerGroupId = consumerGroupId_example # String | Consumer Group
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get lineage for Consumer Group
    api_response = api_instance.get_consumer_group_lineage(consumerGroupId, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LineageOperationsApi->getConsumerGroupLineage: %s\n" % e)

Parameters

Path parameters
Name Description
consumerGroupId*
String
Consumer Group
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


getProducerLineage

Get lineage for Producer


/api/v2/admin/lineage/producers/{producerId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/lineage/producers/{producerId}?from=&to=&duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LineageOperationsApi;

import java.io.File;
import java.util.*;

public class LineageOperationsApiExample {

    public static void main(String[] args) {
        
        LineageOperationsApi apiInstance = new LineageOperationsApi();
        String producerId = producerId_example; // String | Producer Id
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        try {
            ProducerLineage result = apiInstance.getProducerLineage(producerId, from, to, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageOperationsApi#getProducerLineage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LineageOperationsApi;

public class LineageOperationsApiExample {

    public static void main(String[] args) {
        LineageOperationsApi apiInstance = new LineageOperationsApi();
        String producerId = producerId_example; // String | Producer Id
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        try {
            ProducerLineage result = apiInstance.getProducerLineage(producerId, from, to, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageOperationsApi#getProducerLineage");
            e.printStackTrace();
        }
    }
}
String *producerId = producerId_example; // Producer Id
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)

LineageOperationsApi *apiInstance = [[LineageOperationsApi alloc] init];

// Get lineage for Producer
[apiInstance getProducerLineageWith:producerId
    from:from
    to:to
    duration:duration
              completionHandler: ^(ProducerLineage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.LineageOperationsApi()
var producerId = producerId_example; // {{String}} Producer Id
var opts = { 
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789, // {{Long}} End of the time period. Provide '-1' to fetch the latest value
  'duration': duration_example // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducerLineage(producerId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProducerLineageExample
    {
        public void main()
        {

            var apiInstance = new LineageOperationsApi();
            var producerId = producerId_example;  // String | Producer Id
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 

            try
            {
                // Get lineage for Producer
                ProducerLineage result = apiInstance.getProducerLineage(producerId, from, to, duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LineageOperationsApi.getProducerLineage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLineageOperationsApi();
$producerId = producerId_example; // String | Producer Id
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params

try {
    $result = $api_instance->getProducerLineage($producerId, $from, $to, $duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LineageOperationsApi->getProducerLineage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LineageOperationsApi;

my $api_instance = WWW::SwaggerClient::LineageOperationsApi->new();
my $producerId = producerId_example; # String | Producer Id
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params

eval { 
    my $result = $api_instance->getProducerLineage(producerId => $producerId, from => $from, to => $to, duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LineageOperationsApi->getProducerLineage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LineageOperationsApi()
producerId = producerId_example # String | Producer Id
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)

try: 
    # Get lineage for Producer
    api_response = api_instance.get_producer_lineage(producerId, from=from, to=to, duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LineageOperationsApi->getProducerLineage: %s\n" % e)

Parameters

Path parameters
Name Description
producerId*
String
Producer Id
Required
Query parameters
Name Description
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params

Responses

Status: 200 - successful operation


getTopicLineage

Get lineage for Producer


/api/v2/admin/lineage/partitions/{topic}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/lineage/partitions/{topic}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LineageOperationsApi;

import java.io.File;
import java.util.*;

public class LineageOperationsApiExample {

    public static void main(String[] args) {
        
        LineageOperationsApi apiInstance = new LineageOperationsApi();
        String topic = topic_example; // String | Topic Name
        try {
            array[TopicPartitionLineage] result = apiInstance.getTopicLineage(topic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageOperationsApi#getTopicLineage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LineageOperationsApi;

public class LineageOperationsApiExample {

    public static void main(String[] args) {
        LineageOperationsApi apiInstance = new LineageOperationsApi();
        String topic = topic_example; // String | Topic Name
        try {
            array[TopicPartitionLineage] result = apiInstance.getTopicLineage(topic);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageOperationsApi#getTopicLineage");
            e.printStackTrace();
        }
    }
}
String *topic = topic_example; // Topic Name

LineageOperationsApi *apiInstance = [[LineageOperationsApi alloc] init];

// Get lineage for Producer
[apiInstance getTopicLineageWith:topic
              completionHandler: ^(array[TopicPartitionLineage] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.LineageOperationsApi()
var topic = topic_example; // {{String}} Topic Name

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicLineage(topic, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicLineageExample
    {
        public void main()
        {

            var apiInstance = new LineageOperationsApi();
            var topic = topic_example;  // String | Topic Name

            try
            {
                // Get lineage for Producer
                array[TopicPartitionLineage] result = apiInstance.getTopicLineage(topic);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LineageOperationsApi.getTopicLineage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLineageOperationsApi();
$topic = topic_example; // String | Topic Name

try {
    $result = $api_instance->getTopicLineage($topic);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LineageOperationsApi->getTopicLineage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LineageOperationsApi;

my $api_instance = WWW::SwaggerClient::LineageOperationsApi->new();
my $topic = topic_example; # String | Topic Name

eval { 
    my $result = $api_instance->getTopicLineage(topic => $topic);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LineageOperationsApi->getTopicLineage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LineageOperationsApi()
topic = topic_example # String | Topic Name

try: 
    # Get lineage for Producer
    api_response = api_instance.get_topic_lineage(topic)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LineageOperationsApi->getTopicLineage: %s\n" % e)

Parameters

Path parameters
Name Description
topic*
String
Topic Name
Required

Responses

Status: 200 - successful operation


getTopicPartitionLineage

Get lineage for Topic Partition


/api/v2/admin/lineage/partitions/{topic}/{partition}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/lineage/partitions/{topic}/{partition}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LineageOperationsApi;

import java.io.File;
import java.util.*;

public class LineageOperationsApiExample {

    public static void main(String[] args) {
        
        LineageOperationsApi apiInstance = new LineageOperationsApi();
        String topic = topic_example; // String | Topic Name
        Integer partition = 56; // Integer | Partition Id
        try {
            TopicPartitionLineage result = apiInstance.getTopicPartitionLineage(topic, partition);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageOperationsApi#getTopicPartitionLineage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LineageOperationsApi;

public class LineageOperationsApiExample {

    public static void main(String[] args) {
        LineageOperationsApi apiInstance = new LineageOperationsApi();
        String topic = topic_example; // String | Topic Name
        Integer partition = 56; // Integer | Partition Id
        try {
            TopicPartitionLineage result = apiInstance.getTopicPartitionLineage(topic, partition);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageOperationsApi#getTopicPartitionLineage");
            e.printStackTrace();
        }
    }
}
String *topic = topic_example; // Topic Name
Integer *partition = 56; // Partition Id

LineageOperationsApi *apiInstance = [[LineageOperationsApi alloc] init];

// Get lineage for Topic Partition
[apiInstance getTopicPartitionLineageWith:topic
    partition:partition
              completionHandler: ^(TopicPartitionLineage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.LineageOperationsApi()
var topic = topic_example; // {{String}} Topic Name
var partition = 56; // {{Integer}} Partition Id

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicPartitionLineage(topic, partition, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicPartitionLineageExample
    {
        public void main()
        {

            var apiInstance = new LineageOperationsApi();
            var topic = topic_example;  // String | Topic Name
            var partition = 56;  // Integer | Partition Id

            try
            {
                // Get lineage for Topic Partition
                TopicPartitionLineage result = apiInstance.getTopicPartitionLineage(topic, partition);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LineageOperationsApi.getTopicPartitionLineage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLineageOperationsApi();
$topic = topic_example; // String | Topic Name
$partition = 56; // Integer | Partition Id

try {
    $result = $api_instance->getTopicPartitionLineage($topic, $partition);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LineageOperationsApi->getTopicPartitionLineage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LineageOperationsApi;

my $api_instance = WWW::SwaggerClient::LineageOperationsApi->new();
my $topic = topic_example; # String | Topic Name
my $partition = 56; # Integer | Partition Id

eval { 
    my $result = $api_instance->getTopicPartitionLineage(topic => $topic, partition => $partition);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LineageOperationsApi->getTopicPartitionLineage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LineageOperationsApi()
topic = topic_example # String | Topic Name
partition = 56 # Integer | Partition Id

try: 
    # Get lineage for Topic Partition
    api_response = api_instance.get_topic_partition_lineage(topic, partition)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LineageOperationsApi->getTopicPartitionLineage: %s\n" % e)

Parameters

Path parameters
Name Description
topic*
String
Topic Name
Required
partition*
Integer (int32)
Partition Id
Required

Responses

Status: 200 - successful operation


NotifierRelatedOperations

createNotifier

Creates Notifier for the given NotifierConfiguration


/api/v1/admin/notifiers

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//api/v1/admin/notifiers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifierRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        NotifierConfiguration body = ; // NotifierConfiguration | 
        try {
            Long result = apiInstance.createNotifier(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#createNotifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifierRelatedOperationsApi;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        NotifierConfiguration body = ; // NotifierConfiguration | 
        try {
            Long result = apiInstance.createNotifier(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#createNotifier");
            e.printStackTrace();
        }
    }
}
NotifierConfiguration *body = ; //  (optional)

NotifierRelatedOperationsApi *apiInstance = [[NotifierRelatedOperationsApi alloc] init];

// Creates Notifier for the given NotifierConfiguration
[apiInstance createNotifierWith:body
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.NotifierRelatedOperationsApi()
var opts = { 
  'body':  // {{NotifierConfiguration}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createNotifier(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createNotifierExample
    {
        public void main()
        {

            var apiInstance = new NotifierRelatedOperationsApi();
            var body = new NotifierConfiguration(); // NotifierConfiguration |  (optional) 

            try
            {
                // Creates Notifier for the given NotifierConfiguration
                Long result = apiInstance.createNotifier(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifierRelatedOperationsApi.createNotifier: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNotifierRelatedOperationsApi();
$body = ; // NotifierConfiguration | 

try {
    $result = $api_instance->createNotifier($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotifierRelatedOperationsApi->createNotifier: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifierRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::NotifierRelatedOperationsApi->new();
my $body = WWW::SwaggerClient::Object::NotifierConfiguration->new(); # NotifierConfiguration | 

eval { 
    my $result = $api_instance->createNotifier(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotifierRelatedOperationsApi->createNotifier: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NotifierRelatedOperationsApi()
body =  # NotifierConfiguration |  (optional)

try: 
    # Creates Notifier for the given NotifierConfiguration
    api_response = api_instance.create_notifier(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotifierRelatedOperationsApi->createNotifier: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - successful operation


deleteNotifier

Deletes Notifier for the given notifierId


/api/v1/admin/notifiers/{notifierId}

Usage and SDK Samples

curl -X DELETE\
"//api/v1/admin/notifiers/{notifierId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifierRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        Long notifierId = 789; // Long | 
        try {
            apiInstance.deleteNotifier(notifierId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#deleteNotifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifierRelatedOperationsApi;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        Long notifierId = 789; // Long | 
        try {
            apiInstance.deleteNotifier(notifierId);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#deleteNotifier");
            e.printStackTrace();
        }
    }
}
Long *notifierId = 789; // 

NotifierRelatedOperationsApi *apiInstance = [[NotifierRelatedOperationsApi alloc] init];

// Deletes Notifier for the given notifierId
[apiInstance deleteNotifierWith:notifierId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.NotifierRelatedOperationsApi()
var notifierId = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteNotifier(notifierId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteNotifierExample
    {
        public void main()
        {

            var apiInstance = new NotifierRelatedOperationsApi();
            var notifierId = 789;  // Long | 

            try
            {
                // Deletes Notifier for the given notifierId
                apiInstance.deleteNotifier(notifierId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifierRelatedOperationsApi.deleteNotifier: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNotifierRelatedOperationsApi();
$notifierId = 789; // Long | 

try {
    $api_instance->deleteNotifier($notifierId);
} catch (Exception $e) {
    echo 'Exception when calling NotifierRelatedOperationsApi->deleteNotifier: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifierRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::NotifierRelatedOperationsApi->new();
my $notifierId = 789; # Long | 

eval { 
    $api_instance->deleteNotifier(notifierId => $notifierId);
};
if ($@) {
    warn "Exception when calling NotifierRelatedOperationsApi->deleteNotifier: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NotifierRelatedOperationsApi()
notifierId = 789 # Long | 

try: 
    # Deletes Notifier for the given notifierId
    api_instance.delete_notifier(notifierId)
except ApiException as e:
    print("Exception when calling NotifierRelatedOperationsApi->deleteNotifier: %s\n" % e)

Parameters

Path parameters
Name Description
notifierId*
Long (int64)
Required

Responses

Status: default - successful operation


getNotifier

Notifier configuration for the given notifierId


/api/v1/admin/notifiers/{notifierId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/notifiers/{notifierId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifierRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        Long notifierId = 789; // Long | 
        try {
            NotifierConfiguration result = apiInstance.getNotifier(notifierId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#getNotifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifierRelatedOperationsApi;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        Long notifierId = 789; // Long | 
        try {
            NotifierConfiguration result = apiInstance.getNotifier(notifierId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#getNotifier");
            e.printStackTrace();
        }
    }
}
Long *notifierId = 789; // 

NotifierRelatedOperationsApi *apiInstance = [[NotifierRelatedOperationsApi alloc] init];

// Notifier configuration for the given notifierId
[apiInstance getNotifierWith:notifierId
              completionHandler: ^(NotifierConfiguration output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.NotifierRelatedOperationsApi()
var notifierId = 789; // {{Long}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNotifier(notifierId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNotifierExample
    {
        public void main()
        {

            var apiInstance = new NotifierRelatedOperationsApi();
            var notifierId = 789;  // Long | 

            try
            {
                // Notifier configuration for the given notifierId
                NotifierConfiguration result = apiInstance.getNotifier(notifierId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifierRelatedOperationsApi.getNotifier: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNotifierRelatedOperationsApi();
$notifierId = 789; // Long | 

try {
    $result = $api_instance->getNotifier($notifierId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotifierRelatedOperationsApi->getNotifier: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifierRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::NotifierRelatedOperationsApi->new();
my $notifierId = 789; # Long | 

eval { 
    my $result = $api_instance->getNotifier(notifierId => $notifierId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotifierRelatedOperationsApi->getNotifier: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NotifierRelatedOperationsApi()
notifierId = 789 # Long | 

try: 
    # Notifier configuration for the given notifierId
    api_response = api_instance.get_notifier(notifierId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotifierRelatedOperationsApi->getNotifier: %s\n" % e)

Parameters

Path parameters
Name Description
notifierId*
Long (int64)
Required

Responses

Status: 200 - successful operation


getNotifierProviderConfigs

This API return map of notifier provider id with respective configuration fields. This is useful in understanding what kind of information is required for creating different notifiers.


/api/v1/admin/notifiers/providerConfigs

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/notifiers/providerConfigs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifierRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        try {
            NotifierConfigTemplates result = apiInstance.getNotifierProviderConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#getNotifierProviderConfigs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifierRelatedOperationsApi;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        try {
            NotifierConfigTemplates result = apiInstance.getNotifierProviderConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#getNotifierProviderConfigs");
            e.printStackTrace();
        }
    }
}

NotifierRelatedOperationsApi *apiInstance = [[NotifierRelatedOperationsApi alloc] init];

// This API return map of notifier provider id with respective configuration fields. This  is useful in understanding what kind of information is required for creating different notifiers.
[apiInstance getNotifierProviderConfigsWithCompletionHandler: 
              ^(NotifierConfigTemplates output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.NotifierRelatedOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getNotifierProviderConfigs(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getNotifierProviderConfigsExample
    {
        public void main()
        {

            var apiInstance = new NotifierRelatedOperationsApi();

            try
            {
                // This API return map of notifier provider id with respective configuration fields. This  is useful in understanding what kind of information is required for creating different notifiers.
                NotifierConfigTemplates result = apiInstance.getNotifierProviderConfigs();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifierRelatedOperationsApi.getNotifierProviderConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNotifierRelatedOperationsApi();

try {
    $result = $api_instance->getNotifierProviderConfigs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotifierRelatedOperationsApi->getNotifierProviderConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifierRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::NotifierRelatedOperationsApi->new();

eval { 
    my $result = $api_instance->getNotifierProviderConfigs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotifierRelatedOperationsApi->getNotifierProviderConfigs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NotifierRelatedOperationsApi()

try: 
    # This API return map of notifier provider id with respective configuration fields. This  is useful in understanding what kind of information is required for creating different notifiers.
    api_response = api_instance.get_notifier_provider_configs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotifierRelatedOperationsApi->getNotifierProviderConfigs: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


listNotifiers

List of added notifiers


/api/v1/admin/notifiers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/notifiers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifierRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        try {
            array[NotifierConfiguration] result = apiInstance.listNotifiers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#listNotifiers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifierRelatedOperationsApi;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        try {
            array[NotifierConfiguration] result = apiInstance.listNotifiers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#listNotifiers");
            e.printStackTrace();
        }
    }
}

NotifierRelatedOperationsApi *apiInstance = [[NotifierRelatedOperationsApi alloc] init];

// List of added notifiers
[apiInstance listNotifiersWithCompletionHandler: 
              ^(array[NotifierConfiguration] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.NotifierRelatedOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listNotifiers(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listNotifiersExample
    {
        public void main()
        {

            var apiInstance = new NotifierRelatedOperationsApi();

            try
            {
                // List of added notifiers
                array[NotifierConfiguration] result = apiInstance.listNotifiers();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifierRelatedOperationsApi.listNotifiers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNotifierRelatedOperationsApi();

try {
    $result = $api_instance->listNotifiers();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NotifierRelatedOperationsApi->listNotifiers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifierRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::NotifierRelatedOperationsApi->new();

eval { 
    my $result = $api_instance->listNotifiers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NotifierRelatedOperationsApi->listNotifiers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NotifierRelatedOperationsApi()

try: 
    # List of added notifiers
    api_response = api_instance.list_notifiers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NotifierRelatedOperationsApi->listNotifiers: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


updateNotifier

Updates Notifier for the given NotifierConfiguration with notifierId


/api/v1/admin/notifiers/{notifierId}

Usage and SDK Samples

curl -X PUT\
-H "Content-Type: */*"\
"//api/v1/admin/notifiers/{notifierId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NotifierRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        Long notifierId = 789; // Long | 
        NotifierConfiguration body = ; // NotifierConfiguration | 
        try {
            apiInstance.updateNotifier(notifierId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#updateNotifier");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.NotifierRelatedOperationsApi;

public class NotifierRelatedOperationsApiExample {

    public static void main(String[] args) {
        NotifierRelatedOperationsApi apiInstance = new NotifierRelatedOperationsApi();
        Long notifierId = 789; // Long | 
        NotifierConfiguration body = ; // NotifierConfiguration | 
        try {
            apiInstance.updateNotifier(notifierId, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotifierRelatedOperationsApi#updateNotifier");
            e.printStackTrace();
        }
    }
}
Long *notifierId = 789; // 
NotifierConfiguration *body = ; //  (optional)

NotifierRelatedOperationsApi *apiInstance = [[NotifierRelatedOperationsApi alloc] init];

// Updates Notifier for the given NotifierConfiguration with notifierId
[apiInstance updateNotifierWith:notifierId
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.NotifierRelatedOperationsApi()
var notifierId = 789; // {{Long}} 
var opts = { 
  'body':  // {{NotifierConfiguration}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateNotifier(notifierId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateNotifierExample
    {
        public void main()
        {

            var apiInstance = new NotifierRelatedOperationsApi();
            var notifierId = 789;  // Long | 
            var body = new NotifierConfiguration(); // NotifierConfiguration |  (optional) 

            try
            {
                // Updates Notifier for the given NotifierConfiguration with notifierId
                apiInstance.updateNotifier(notifierId, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NotifierRelatedOperationsApi.updateNotifier: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiNotifierRelatedOperationsApi();
$notifierId = 789; // Long | 
$body = ; // NotifierConfiguration | 

try {
    $api_instance->updateNotifier($notifierId, $body);
} catch (Exception $e) {
    echo 'Exception when calling NotifierRelatedOperationsApi->updateNotifier: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::NotifierRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::NotifierRelatedOperationsApi->new();
my $notifierId = 789; # Long | 
my $body = WWW::SwaggerClient::Object::NotifierConfiguration->new(); # NotifierConfiguration | 

eval { 
    $api_instance->updateNotifier(notifierId => $notifierId, body => $body);
};
if ($@) {
    warn "Exception when calling NotifierRelatedOperationsApi->updateNotifier: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.NotifierRelatedOperationsApi()
notifierId = 789 # Long | 
body =  # NotifierConfiguration |  (optional)

try: 
    # Updates Notifier for the given NotifierConfiguration with notifierId
    api_instance.update_notifier(notifierId, body=body)
except ApiException as e:
    print("Exception when calling NotifierRelatedOperationsApi->updateNotifier: %s\n" % e)

Parameters

Path parameters
Name Description
notifierId*
Long (int64)
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


ProducerMetricsOperations

getAllProducerMetrics1

Get producer metrics for all the alive producers


/api/v1/admin/metrics/producers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/producers?state=&duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProducerMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class ProducerMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        ProducerMetricsOperationsApi apiInstance = new ProducerMetricsOperationsApi();
        String state = state_example; // String | State of the Producer
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            array[ProducerMetrics] result = apiInstance.getAllProducerMetrics1(state, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProducerMetricsOperationsApi#getAllProducerMetrics1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProducerMetricsOperationsApi;

public class ProducerMetricsOperationsApiExample {

    public static void main(String[] args) {
        ProducerMetricsOperationsApi apiInstance = new ProducerMetricsOperationsApi();
        String state = state_example; // String | State of the Producer
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            array[ProducerMetrics] result = apiInstance.getAllProducerMetrics1(state, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProducerMetricsOperationsApi#getAllProducerMetrics1");
            e.printStackTrace();
        }
    }
}
String *state = state_example; // State of the Producer (optional)
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

ProducerMetricsOperationsApi *apiInstance = [[ProducerMetricsOperationsApi alloc] init];

// Get producer metrics for all the alive producers
[apiInstance getAllProducerMetrics1With:state
    duration:duration
    from:from
    to:to
              completionHandler: ^(array[ProducerMetrics] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ProducerMetricsOperationsApi()
var opts = { 
  'state': state_example, // {{String}} State of the Producer
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllProducerMetrics1(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllProducerMetrics1Example
    {
        public void main()
        {

            var apiInstance = new ProducerMetricsOperationsApi();
            var state = state_example;  // String | State of the Producer (optional) 
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get producer metrics for all the alive producers
                array[ProducerMetrics] result = apiInstance.getAllProducerMetrics1(state, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProducerMetricsOperationsApi.getAllProducerMetrics1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProducerMetricsOperationsApi();
$state = state_example; // String | State of the Producer
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getAllProducerMetrics1($state, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProducerMetricsOperationsApi->getAllProducerMetrics1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProducerMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::ProducerMetricsOperationsApi->new();
my $state = state_example; # String | State of the Producer
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getAllProducerMetrics1(state => $state, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProducerMetricsOperationsApi->getAllProducerMetrics1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProducerMetricsOperationsApi()
state = state_example # String | State of the Producer (optional)
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get producer metrics for all the alive producers
    api_response = api_instance.get_all_producer_metrics1(state=state, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProducerMetricsOperationsApi->getAllProducerMetrics1: %s\n" % e)

Parameters

Query parameters
Name Description
state
String
State of the Producer
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


getProducerMetrics1

Get producer metrics for the given producerClientId


/api/v1/admin/metrics/producers/{producerClientId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/producers/{producerClientId}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProducerMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class ProducerMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        ProducerMetricsOperationsApi apiInstance = new ProducerMetricsOperationsApi();
        String producerClientId = producerClientId_example; // String | Producer client identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ProducerMetrics result = apiInstance.getProducerMetrics1(producerClientId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProducerMetricsOperationsApi#getProducerMetrics1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProducerMetricsOperationsApi;

public class ProducerMetricsOperationsApiExample {

    public static void main(String[] args) {
        ProducerMetricsOperationsApi apiInstance = new ProducerMetricsOperationsApi();
        String producerClientId = producerClientId_example; // String | Producer client identifier
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ProducerMetrics result = apiInstance.getProducerMetrics1(producerClientId, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProducerMetricsOperationsApi#getProducerMetrics1");
            e.printStackTrace();
        }
    }
}
String *producerClientId = producerClientId_example; // Producer client identifier
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

ProducerMetricsOperationsApi *apiInstance = [[ProducerMetricsOperationsApi alloc] init];

// Get producer metrics for the given producerClientId
[apiInstance getProducerMetrics1With:producerClientId
    duration:duration
    from:from
    to:to
              completionHandler: ^(ProducerMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ProducerMetricsOperationsApi()
var producerClientId = producerClientId_example; // {{String}} Producer client identifier
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProducerMetrics1(producerClientId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProducerMetrics1Example
    {
        public void main()
        {

            var apiInstance = new ProducerMetricsOperationsApi();
            var producerClientId = producerClientId_example;  // String | Producer client identifier
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get producer metrics for the given producerClientId
                ProducerMetrics result = apiInstance.getProducerMetrics1(producerClientId, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProducerMetricsOperationsApi.getProducerMetrics1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiProducerMetricsOperationsApi();
$producerClientId = producerClientId_example; // String | Producer client identifier
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getProducerMetrics1($producerClientId, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProducerMetricsOperationsApi->getProducerMetrics1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProducerMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::ProducerMetricsOperationsApi->new();
my $producerClientId = producerClientId_example; # String | Producer client identifier
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getProducerMetrics1(producerClientId => $producerClientId, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProducerMetricsOperationsApi->getProducerMetrics1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ProducerMetricsOperationsApi()
producerClientId = producerClientId_example # String | Producer client identifier
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get producer metrics for the given producerClientId
    api_response = api_instance.get_producer_metrics1(producerClientId, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProducerMetricsOperationsApi->getProducerMetrics1: %s\n" % e)

Parameters

Path parameters
Name Description
producerClientId*
String
Producer client identifier
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


ResourceConfigurationOperations

alterTopicConfigs

Alter Topic configurations for the given topicName.


/api/v1/admin/configs/topics/{topicName}

Usage and SDK Samples

curl -X PUT\
-H "Content-Type: */*"\
"//api/v1/admin/configs/topics/{topicName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourceConfigurationOperationsApi;

import java.io.File;
import java.util.*;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        String topicName = topicName_example; // String | 
        map[String, String] body = ; // map[String, String] | 
        try {
            apiInstance.alterTopicConfigs(topicName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#alterTopicConfigs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourceConfigurationOperationsApi;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        String topicName = topicName_example; // String | 
        map[String, String] body = ; // map[String, String] | 
        try {
            apiInstance.alterTopicConfigs(topicName, body);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#alterTopicConfigs");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 
map[String, String] *body = ; //  (optional)

ResourceConfigurationOperationsApi *apiInstance = [[ResourceConfigurationOperationsApi alloc] init];

// Alter Topic configurations for the given topicName.
[apiInstance alterTopicConfigsWith:topicName
    body:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ResourceConfigurationOperationsApi()
var topicName = topicName_example; // {{String}} 
var opts = { 
  'body':  // {{map[String, String]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.alterTopicConfigs(topicName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class alterTopicConfigsExample
    {
        public void main()
        {

            var apiInstance = new ResourceConfigurationOperationsApi();
            var topicName = topicName_example;  // String | 
            var body = new map[String, String](); // map[String, String] |  (optional) 

            try
            {
                // Alter Topic configurations for the given topicName.
                apiInstance.alterTopicConfigs(topicName, body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourceConfigurationOperationsApi.alterTopicConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourceConfigurationOperationsApi();
$topicName = topicName_example; // String | 
$body = ; // map[String, String] | 

try {
    $api_instance->alterTopicConfigs($topicName, $body);
} catch (Exception $e) {
    echo 'Exception when calling ResourceConfigurationOperationsApi->alterTopicConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourceConfigurationOperationsApi;

my $api_instance = WWW::SwaggerClient::ResourceConfigurationOperationsApi->new();
my $topicName = topicName_example; # String | 
my $body = WWW::SwaggerClient::Object::map[String, String]->new(); # map[String, String] | 

eval { 
    $api_instance->alterTopicConfigs(topicName => $topicName, body => $body);
};
if ($@) {
    warn "Exception when calling ResourceConfigurationOperationsApi->alterTopicConfigs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourceConfigurationOperationsApi()
topicName = topicName_example # String | 
body =  # map[String, String] |  (optional)

try: 
    # Alter Topic configurations for the given topicName.
    api_instance.alter_topic_configs(topicName, body=body)
except ApiException as e:
    print("Exception when calling ResourceConfigurationOperationsApi->alterTopicConfigs: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required
Body parameters
Name Description
body

Responses

Status: default - successful operation


getAllBrokerDetails

Get kafka configurations for the given brokerIds. if brokerIds parameter does not have any value then configuration for all brokers is returned.


/api/v1/admin/configs/brokers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/configs/brokers"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourceConfigurationOperationsApi;

import java.io.File;
import java.util.*;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        try {
            array[KafkaResourceConfig] result = apiInstance.getAllBrokerDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getAllBrokerDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourceConfigurationOperationsApi;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        try {
            array[KafkaResourceConfig] result = apiInstance.getAllBrokerDetails();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getAllBrokerDetails");
            e.printStackTrace();
        }
    }
}

ResourceConfigurationOperationsApi *apiInstance = [[ResourceConfigurationOperationsApi alloc] init];

// Get kafka configurations for the given brokerIds. if brokerIds parameter does not have any value then configuration for all brokers is returned.
[apiInstance getAllBrokerDetailsWithCompletionHandler: 
              ^(array[KafkaResourceConfig] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ResourceConfigurationOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllBrokerDetails(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllBrokerDetailsExample
    {
        public void main()
        {

            var apiInstance = new ResourceConfigurationOperationsApi();

            try
            {
                // Get kafka configurations for the given brokerIds. if brokerIds parameter does not have any value then configuration for all brokers is returned.
                array[KafkaResourceConfig] result = apiInstance.getAllBrokerDetails();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourceConfigurationOperationsApi.getAllBrokerDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourceConfigurationOperationsApi();

try {
    $result = $api_instance->getAllBrokerDetails();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourceConfigurationOperationsApi->getAllBrokerDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourceConfigurationOperationsApi;

my $api_instance = WWW::SwaggerClient::ResourceConfigurationOperationsApi->new();

eval { 
    my $result = $api_instance->getAllBrokerDetails();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceConfigurationOperationsApi->getAllBrokerDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourceConfigurationOperationsApi()

try: 
    # Get kafka configurations for the given brokerIds. if brokerIds parameter does not have any value then configuration for all brokers is returned.
    api_response = api_instance.get_all_broker_details()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceConfigurationOperationsApi->getAllBrokerDetails: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getAllTopicConfigs

Get kafka configurations for all topics.


/api/v1/admin/configs/topics

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/configs/topics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourceConfigurationOperationsApi;

import java.io.File;
import java.util.*;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        try {
            array[KafkaResourceConfig] result = apiInstance.getAllTopicConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getAllTopicConfigs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourceConfigurationOperationsApi;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        try {
            array[KafkaResourceConfig] result = apiInstance.getAllTopicConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getAllTopicConfigs");
            e.printStackTrace();
        }
    }
}

ResourceConfigurationOperationsApi *apiInstance = [[ResourceConfigurationOperationsApi alloc] init];

// Get kafka configurations for all topics.
[apiInstance getAllTopicConfigsWithCompletionHandler: 
              ^(array[KafkaResourceConfig] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ResourceConfigurationOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllTopicConfigs(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllTopicConfigsExample
    {
        public void main()
        {

            var apiInstance = new ResourceConfigurationOperationsApi();

            try
            {
                // Get kafka configurations for all topics.
                array[KafkaResourceConfig] result = apiInstance.getAllTopicConfigs();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourceConfigurationOperationsApi.getAllTopicConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourceConfigurationOperationsApi();

try {
    $result = $api_instance->getAllTopicConfigs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourceConfigurationOperationsApi->getAllTopicConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourceConfigurationOperationsApi;

my $api_instance = WWW::SwaggerClient::ResourceConfigurationOperationsApi->new();

eval { 
    my $result = $api_instance->getAllTopicConfigs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceConfigurationOperationsApi->getAllTopicConfigs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourceConfigurationOperationsApi()

try: 
    # Get kafka configurations for all topics.
    api_response = api_instance.get_all_topic_configs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceConfigurationOperationsApi->getAllTopicConfigs: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getBrokerDetails

Get kafka configurations for the given brokerId.


/api/v1/admin/configs/brokers/{brokerId}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/configs/brokers/{brokerId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourceConfigurationOperationsApi;

import java.io.File;
import java.util.*;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        String brokerId = brokerId_example; // String | 
        try {
            KafkaResourceConfig result = apiInstance.getBrokerDetails(brokerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getBrokerDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourceConfigurationOperationsApi;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        String brokerId = brokerId_example; // String | 
        try {
            KafkaResourceConfig result = apiInstance.getBrokerDetails(brokerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getBrokerDetails");
            e.printStackTrace();
        }
    }
}
String *brokerId = brokerId_example; // 

ResourceConfigurationOperationsApi *apiInstance = [[ResourceConfigurationOperationsApi alloc] init];

// Get kafka configurations for the given brokerId.
[apiInstance getBrokerDetailsWith:brokerId
              completionHandler: ^(KafkaResourceConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ResourceConfigurationOperationsApi()
var brokerId = brokerId_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokerDetails(brokerId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokerDetailsExample
    {
        public void main()
        {

            var apiInstance = new ResourceConfigurationOperationsApi();
            var brokerId = brokerId_example;  // String | 

            try
            {
                // Get kafka configurations for the given brokerId.
                KafkaResourceConfig result = apiInstance.getBrokerDetails(brokerId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourceConfigurationOperationsApi.getBrokerDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourceConfigurationOperationsApi();
$brokerId = brokerId_example; // String | 

try {
    $result = $api_instance->getBrokerDetails($brokerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourceConfigurationOperationsApi->getBrokerDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourceConfigurationOperationsApi;

my $api_instance = WWW::SwaggerClient::ResourceConfigurationOperationsApi->new();
my $brokerId = brokerId_example; # String | 

eval { 
    my $result = $api_instance->getBrokerDetails(brokerId => $brokerId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceConfigurationOperationsApi->getBrokerDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourceConfigurationOperationsApi()
brokerId = brokerId_example # String | 

try: 
    # Get kafka configurations for the given brokerId.
    api_response = api_instance.get_broker_details(brokerId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceConfigurationOperationsApi->getBrokerDetails: %s\n" % e)

Parameters

Path parameters
Name Description
brokerId*
String
Required

Responses

Status: 200 - successful operation


getDefaultTopicConfigs

Get default kafka topic configuration


/api/v1/admin/configs/default/topics

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/configs/default/topics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourceConfigurationOperationsApi;

import java.io.File;
import java.util.*;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        try {
            array[KafkaResourceConfigEntry] result = apiInstance.getDefaultTopicConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getDefaultTopicConfigs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourceConfigurationOperationsApi;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        try {
            array[KafkaResourceConfigEntry] result = apiInstance.getDefaultTopicConfigs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getDefaultTopicConfigs");
            e.printStackTrace();
        }
    }
}

ResourceConfigurationOperationsApi *apiInstance = [[ResourceConfigurationOperationsApi alloc] init];

// Get default kafka topic configuration
[apiInstance getDefaultTopicConfigsWithCompletionHandler: 
              ^(array[KafkaResourceConfigEntry] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ResourceConfigurationOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDefaultTopicConfigs(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDefaultTopicConfigsExample
    {
        public void main()
        {

            var apiInstance = new ResourceConfigurationOperationsApi();

            try
            {
                // Get default kafka topic configuration
                array[KafkaResourceConfigEntry] result = apiInstance.getDefaultTopicConfigs();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourceConfigurationOperationsApi.getDefaultTopicConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourceConfigurationOperationsApi();

try {
    $result = $api_instance->getDefaultTopicConfigs();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourceConfigurationOperationsApi->getDefaultTopicConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourceConfigurationOperationsApi;

my $api_instance = WWW::SwaggerClient::ResourceConfigurationOperationsApi->new();

eval { 
    my $result = $api_instance->getDefaultTopicConfigs();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceConfigurationOperationsApi->getDefaultTopicConfigs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourceConfigurationOperationsApi()

try: 
    # Get default kafka topic configuration
    api_response = api_instance.get_default_topic_configs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceConfigurationOperationsApi->getDefaultTopicConfigs: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getTopicConfigs

Get kafka configurations for a topic with given topicName.


/api/v1/admin/configs/topics/{topicName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/configs/topics/{topicName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ResourceConfigurationOperationsApi;

import java.io.File;
import java.util.*;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            KafkaResourceConfig result = apiInstance.getTopicConfigs(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getTopicConfigs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ResourceConfigurationOperationsApi;

public class ResourceConfigurationOperationsApiExample {

    public static void main(String[] args) {
        ResourceConfigurationOperationsApi apiInstance = new ResourceConfigurationOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            KafkaResourceConfig result = apiInstance.getTopicConfigs(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ResourceConfigurationOperationsApi#getTopicConfigs");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 

ResourceConfigurationOperationsApi *apiInstance = [[ResourceConfigurationOperationsApi alloc] init];

// Get kafka configurations for a topic with given topicName.
[apiInstance getTopicConfigsWith:topicName
              completionHandler: ^(KafkaResourceConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.ResourceConfigurationOperationsApi()
var topicName = topicName_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicConfigs(topicName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicConfigsExample
    {
        public void main()
        {

            var apiInstance = new ResourceConfigurationOperationsApi();
            var topicName = topicName_example;  // String | 

            try
            {
                // Get kafka configurations for a topic with given topicName.
                KafkaResourceConfig result = apiInstance.getTopicConfigs(topicName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ResourceConfigurationOperationsApi.getTopicConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiResourceConfigurationOperationsApi();
$topicName = topicName_example; // String | 

try {
    $result = $api_instance->getTopicConfigs($topicName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ResourceConfigurationOperationsApi->getTopicConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ResourceConfigurationOperationsApi;

my $api_instance = WWW::SwaggerClient::ResourceConfigurationOperationsApi->new();
my $topicName = topicName_example; # String | 

eval { 
    my $result = $api_instance->getTopicConfigs(topicName => $topicName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ResourceConfigurationOperationsApi->getTopicConfigs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ResourceConfigurationOperationsApi()
topicName = topicName_example # String | 

try: 
    # Get kafka configurations for a topic with given topicName.
    api_response = api_instance.get_topic_configs(topicName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ResourceConfigurationOperationsApi->getTopicConfigs: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required

Responses

Status: 200 - successful operation


SMMDebugOperations

getAttributeValue

Get alert resource attribute value


/api/v1/admin/debug/alert/attributeValue

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/debug/alert/attributeValue?entity=&attribute=&name=&operator=&value="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SMMDebugOperationsApi;

import java.io.File;
import java.util.*;

public class SMMDebugOperationsApiExample {

    public static void main(String[] args) {
        
        SMMDebugOperationsApi apiInstance = new SMMDebugOperationsApi();
        String entity = entity_example; // String | 
        String attribute = attribute_example; // String | 
        String name = name_example; // String | 
        String operator = operator_example; // String | 
        String value = value_example; // String | 
        try {
            ResourceAttribute result = apiInstance.getAttributeValue(entity, attribute, name, operator, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SMMDebugOperationsApi#getAttributeValue");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SMMDebugOperationsApi;

public class SMMDebugOperationsApiExample {

    public static void main(String[] args) {
        SMMDebugOperationsApi apiInstance = new SMMDebugOperationsApi();
        String entity = entity_example; // String | 
        String attribute = attribute_example; // String | 
        String name = name_example; // String | 
        String operator = operator_example; // String | 
        String value = value_example; // String | 
        try {
            ResourceAttribute result = apiInstance.getAttributeValue(entity, attribute, name, operator, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SMMDebugOperationsApi#getAttributeValue");
            e.printStackTrace();
        }
    }
}
String *entity = entity_example; //  (optional)
String *attribute = attribute_example; //  (optional)
String *name = name_example; //  (optional)
String *operator = operator_example; //  (optional)
String *value = value_example; //  (optional)

SMMDebugOperationsApi *apiInstance = [[SMMDebugOperationsApi alloc] init];

// Get alert resource attribute value
[apiInstance getAttributeValueWith:entity
    attribute:attribute
    name:name
    operator:operator
    value:value
              completionHandler: ^(ResourceAttribute output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SMMDebugOperationsApi()
var opts = { 
  'entity': entity_example, // {{String}} 
  'attribute': attribute_example, // {{String}} 
  'name': name_example, // {{String}} 
  'operator': operator_example, // {{String}} 
  'value': value_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAttributeValue(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAttributeValueExample
    {
        public void main()
        {

            var apiInstance = new SMMDebugOperationsApi();
            var entity = entity_example;  // String |  (optional) 
            var attribute = attribute_example;  // String |  (optional) 
            var name = name_example;  // String |  (optional) 
            var operator = operator_example;  // String |  (optional) 
            var value = value_example;  // String |  (optional) 

            try
            {
                // Get alert resource attribute value
                ResourceAttribute result = apiInstance.getAttributeValue(entity, attribute, name, operator, value);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SMMDebugOperationsApi.getAttributeValue: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSMMDebugOperationsApi();
$entity = entity_example; // String | 
$attribute = attribute_example; // String | 
$name = name_example; // String | 
$operator = operator_example; // String | 
$value = value_example; // String | 

try {
    $result = $api_instance->getAttributeValue($entity, $attribute, $name, $operator, $value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMMDebugOperationsApi->getAttributeValue: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SMMDebugOperationsApi;

my $api_instance = WWW::SwaggerClient::SMMDebugOperationsApi->new();
my $entity = entity_example; # String | 
my $attribute = attribute_example; # String | 
my $name = name_example; # String | 
my $operator = operator_example; # String | 
my $value = value_example; # String | 

eval { 
    my $result = $api_instance->getAttributeValue(entity => $entity, attribute => $attribute, name => $name, operator => $operator, value => $value);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SMMDebugOperationsApi->getAttributeValue: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SMMDebugOperationsApi()
entity = entity_example # String |  (optional)
attribute = attribute_example # String |  (optional)
name = name_example # String |  (optional)
operator = operator_example # String |  (optional)
value = value_example # String |  (optional)

try: 
    # Get alert resource attribute value
    api_response = api_instance.get_attribute_value(entity=entity, attribute=attribute, name=name, operator=operator, value=value)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SMMDebugOperationsApi->getAttributeValue: %s\n" % e)

Parameters

Query parameters
Name Description
entity
String
attribute
String
name
String
operator
String
value
String

Responses

Status: 200 - successful operation


SchemaRegistryConfigOperations

isSchemaRegistryConfigured

Check if schema registry is configured


/api/v1/admin/schemas/is-configured

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/schemas/is-configured"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaRegistryConfigOperationsApi;

import java.io.File;
import java.util.*;

public class SchemaRegistryConfigOperationsApiExample {

    public static void main(String[] args) {
        
        SchemaRegistryConfigOperationsApi apiInstance = new SchemaRegistryConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isSchemaRegistryConfigured();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryConfigOperationsApi#isSchemaRegistryConfigured");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaRegistryConfigOperationsApi;

public class SchemaRegistryConfigOperationsApiExample {

    public static void main(String[] args) {
        SchemaRegistryConfigOperationsApi apiInstance = new SchemaRegistryConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isSchemaRegistryConfigured();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryConfigOperationsApi#isSchemaRegistryConfigured");
            e.printStackTrace();
        }
    }
}

SchemaRegistryConfigOperationsApi *apiInstance = [[SchemaRegistryConfigOperationsApi alloc] init];

// Check if schema registry is configured
[apiInstance isSchemaRegistryConfiguredWithCompletionHandler: 
              ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SchemaRegistryConfigOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isSchemaRegistryConfigured(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isSchemaRegistryConfiguredExample
    {
        public void main()
        {

            var apiInstance = new SchemaRegistryConfigOperationsApi();

            try
            {
                // Check if schema registry is configured
                'Boolean' result = apiInstance.isSchemaRegistryConfigured();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaRegistryConfigOperationsApi.isSchemaRegistryConfigured: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSchemaRegistryConfigOperationsApi();

try {
    $result = $api_instance->isSchemaRegistryConfigured();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchemaRegistryConfigOperationsApi->isSchemaRegistryConfigured: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaRegistryConfigOperationsApi;

my $api_instance = WWW::SwaggerClient::SchemaRegistryConfigOperationsApi->new();

eval { 
    my $result = $api_instance->isSchemaRegistryConfigured();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaRegistryConfigOperationsApi->isSchemaRegistryConfigured: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchemaRegistryConfigOperationsApi()

try: 
    # Check if schema registry is configured
    api_response = api_instance.is_schema_registry_configured()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaRegistryConfigOperationsApi->isSchemaRegistryConfigured: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


SchemaRegistryOperations

getKeySchemaVersionInfos

Get schema versions for the given kafka topic name


/api/v1/admin/schemas/topics/{topicName}/keySchema/versions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/schemas/topics/{topicName}/keySchema/versions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaRegistryOperationsApi;

import java.io.File;
import java.util.*;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            array[SchemaVersionInfo] result = apiInstance.getKeySchemaVersionInfos(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#getKeySchemaVersionInfos");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaRegistryOperationsApi;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            array[SchemaVersionInfo] result = apiInstance.getKeySchemaVersionInfos(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#getKeySchemaVersionInfos");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 

SchemaRegistryOperationsApi *apiInstance = [[SchemaRegistryOperationsApi alloc] init];

// Get schema versions for the given kafka topic name
[apiInstance getKeySchemaVersionInfosWith:topicName
              completionHandler: ^(array[SchemaVersionInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SchemaRegistryOperationsApi()
var topicName = topicName_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getKeySchemaVersionInfos(topicName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getKeySchemaVersionInfosExample
    {
        public void main()
        {

            var apiInstance = new SchemaRegistryOperationsApi();
            var topicName = topicName_example;  // String | 

            try
            {
                // Get schema versions for the given kafka topic name
                array[SchemaVersionInfo] result = apiInstance.getKeySchemaVersionInfos(topicName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaRegistryOperationsApi.getKeySchemaVersionInfos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSchemaRegistryOperationsApi();
$topicName = topicName_example; // String | 

try {
    $result = $api_instance->getKeySchemaVersionInfos($topicName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchemaRegistryOperationsApi->getKeySchemaVersionInfos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaRegistryOperationsApi;

my $api_instance = WWW::SwaggerClient::SchemaRegistryOperationsApi->new();
my $topicName = topicName_example; # String | 

eval { 
    my $result = $api_instance->getKeySchemaVersionInfos(topicName => $topicName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaRegistryOperationsApi->getKeySchemaVersionInfos: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchemaRegistryOperationsApi()
topicName = topicName_example # String | 

try: 
    # Get schema versions for the given kafka topic name
    api_response = api_instance.get_key_schema_version_infos(topicName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaRegistryOperationsApi->getKeySchemaVersionInfos: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required

Responses

Status: 200 - successful operation


getSchemaMetaForTopic

Schema mapping for a given kafka topic name


/api/v1/admin/schemas/topics/{topicName}/schema/mapping

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/schemas/topics/{topicName}/schema/mapping"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaRegistryOperationsApi;

import java.io.File;
import java.util.*;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            TopicSchemaMapping result = apiInstance.getSchemaMetaForTopic(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#getSchemaMetaForTopic");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaRegistryOperationsApi;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            TopicSchemaMapping result = apiInstance.getSchemaMetaForTopic(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#getSchemaMetaForTopic");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 

SchemaRegistryOperationsApi *apiInstance = [[SchemaRegistryOperationsApi alloc] init];

// Schema mapping for a given kafka topic name
[apiInstance getSchemaMetaForTopicWith:topicName
              completionHandler: ^(TopicSchemaMapping output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SchemaRegistryOperationsApi()
var topicName = topicName_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSchemaMetaForTopic(topicName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSchemaMetaForTopicExample
    {
        public void main()
        {

            var apiInstance = new SchemaRegistryOperationsApi();
            var topicName = topicName_example;  // String | 

            try
            {
                // Schema mapping for a given kafka topic name
                TopicSchemaMapping result = apiInstance.getSchemaMetaForTopic(topicName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaRegistryOperationsApi.getSchemaMetaForTopic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSchemaRegistryOperationsApi();
$topicName = topicName_example; // String | 

try {
    $result = $api_instance->getSchemaMetaForTopic($topicName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchemaRegistryOperationsApi->getSchemaMetaForTopic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaRegistryOperationsApi;

my $api_instance = WWW::SwaggerClient::SchemaRegistryOperationsApi->new();
my $topicName = topicName_example; # String | 

eval { 
    my $result = $api_instance->getSchemaMetaForTopic(topicName => $topicName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaRegistryOperationsApi->getSchemaMetaForTopic: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchemaRegistryOperationsApi()
topicName = topicName_example # String | 

try: 
    # Schema mapping for a given kafka topic name
    api_response = api_instance.get_schema_meta_for_topic(topicName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaRegistryOperationsApi->getSchemaMetaForTopic: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required

Responses

Status: 200 - successful operation


getSchemaRegistryInfo

Get the information about schema registry


/api/v1/admin/schemas/registryInfo

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/schemas/registryInfo"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaRegistryOperationsApi;

import java.io.File;
import java.util.*;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        try {
            SchemaRegistryInfo result = apiInstance.getSchemaRegistryInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#getSchemaRegistryInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaRegistryOperationsApi;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        try {
            SchemaRegistryInfo result = apiInstance.getSchemaRegistryInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#getSchemaRegistryInfo");
            e.printStackTrace();
        }
    }
}

SchemaRegistryOperationsApi *apiInstance = [[SchemaRegistryOperationsApi alloc] init];

// Get the information about schema registry
[apiInstance getSchemaRegistryInfoWithCompletionHandler: 
              ^(SchemaRegistryInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SchemaRegistryOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSchemaRegistryInfo(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSchemaRegistryInfoExample
    {
        public void main()
        {

            var apiInstance = new SchemaRegistryOperationsApi();

            try
            {
                // Get the information about schema registry
                SchemaRegistryInfo result = apiInstance.getSchemaRegistryInfo();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaRegistryOperationsApi.getSchemaRegistryInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSchemaRegistryOperationsApi();

try {
    $result = $api_instance->getSchemaRegistryInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchemaRegistryOperationsApi->getSchemaRegistryInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaRegistryOperationsApi;

my $api_instance = WWW::SwaggerClient::SchemaRegistryOperationsApi->new();

eval { 
    my $result = $api_instance->getSchemaRegistryInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaRegistryOperationsApi->getSchemaRegistryInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchemaRegistryOperationsApi()

try: 
    # Get the information about schema registry
    api_response = api_instance.get_schema_registry_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaRegistryOperationsApi->getSchemaRegistryInfo: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


getValueSchemaVersionInfos

Get schema versions for the given kafka topic name


/api/v1/admin/schemas/topics/{topicName}/valueSchema/versions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/schemas/topics/{topicName}/valueSchema/versions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaRegistryOperationsApi;

import java.io.File;
import java.util.*;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            array[SchemaVersionInfo] result = apiInstance.getValueSchemaVersionInfos(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#getValueSchemaVersionInfos");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaRegistryOperationsApi;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            array[SchemaVersionInfo] result = apiInstance.getValueSchemaVersionInfos(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#getValueSchemaVersionInfos");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 

SchemaRegistryOperationsApi *apiInstance = [[SchemaRegistryOperationsApi alloc] init];

// Get schema versions for the given kafka topic name
[apiInstance getValueSchemaVersionInfosWith:topicName
              completionHandler: ^(array[SchemaVersionInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SchemaRegistryOperationsApi()
var topicName = topicName_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getValueSchemaVersionInfos(topicName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getValueSchemaVersionInfosExample
    {
        public void main()
        {

            var apiInstance = new SchemaRegistryOperationsApi();
            var topicName = topicName_example;  // String | 

            try
            {
                // Get schema versions for the given kafka topic name
                array[SchemaVersionInfo] result = apiInstance.getValueSchemaVersionInfos(topicName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaRegistryOperationsApi.getValueSchemaVersionInfos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSchemaRegistryOperationsApi();
$topicName = topicName_example; // String | 

try {
    $result = $api_instance->getValueSchemaVersionInfos($topicName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchemaRegistryOperationsApi->getValueSchemaVersionInfos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaRegistryOperationsApi;

my $api_instance = WWW::SwaggerClient::SchemaRegistryOperationsApi->new();
my $topicName = topicName_example; # String | 

eval { 
    my $result = $api_instance->getValueSchemaVersionInfos(topicName => $topicName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaRegistryOperationsApi->getValueSchemaVersionInfos: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchemaRegistryOperationsApi()
topicName = topicName_example # String | 

try: 
    # Get schema versions for the given kafka topic name
    api_response = api_instance.get_value_schema_version_infos(topicName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaRegistryOperationsApi->getValueSchemaVersionInfos: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required

Responses

Status: 200 - successful operation


registerTopicSchemaMeta

Register a schema name for a kafka topic name


/api/v1/admin/schemas/topics/{topicName}/schema/mapping

Usage and SDK Samples

curl -X POST\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"//api/v1/admin/schemas/topics/{topicName}/schema/mapping"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchemaRegistryOperationsApi;

import java.io.File;
import java.util.*;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        String topicName = topicName_example; // String | 
        TopicSchemaMapping body = ; // TopicSchemaMapping | 
        try {
            Long result = apiInstance.registerTopicSchemaMeta(topicName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#registerTopicSchemaMeta");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchemaRegistryOperationsApi;

public class SchemaRegistryOperationsApiExample {

    public static void main(String[] args) {
        SchemaRegistryOperationsApi apiInstance = new SchemaRegistryOperationsApi();
        String topicName = topicName_example; // String | 
        TopicSchemaMapping body = ; // TopicSchemaMapping | 
        try {
            Long result = apiInstance.registerTopicSchemaMeta(topicName, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchemaRegistryOperationsApi#registerTopicSchemaMeta");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 
TopicSchemaMapping *body = ; //  (optional)

SchemaRegistryOperationsApi *apiInstance = [[SchemaRegistryOperationsApi alloc] init];

// Register a schema name for a kafka topic name
[apiInstance registerTopicSchemaMetaWith:topicName
    body:body
              completionHandler: ^(Long output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SchemaRegistryOperationsApi()
var topicName = topicName_example; // {{String}} 
var opts = { 
  'body':  // {{TopicSchemaMapping}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerTopicSchemaMeta(topicName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerTopicSchemaMetaExample
    {
        public void main()
        {

            var apiInstance = new SchemaRegistryOperationsApi();
            var topicName = topicName_example;  // String | 
            var body = new TopicSchemaMapping(); // TopicSchemaMapping |  (optional) 

            try
            {
                // Register a schema name for a kafka topic name
                Long result = apiInstance.registerTopicSchemaMeta(topicName, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchemaRegistryOperationsApi.registerTopicSchemaMeta: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSchemaRegistryOperationsApi();
$topicName = topicName_example; // String | 
$body = ; // TopicSchemaMapping | 

try {
    $result = $api_instance->registerTopicSchemaMeta($topicName, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchemaRegistryOperationsApi->registerTopicSchemaMeta: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchemaRegistryOperationsApi;

my $api_instance = WWW::SwaggerClient::SchemaRegistryOperationsApi->new();
my $topicName = topicName_example; # String | 
my $body = WWW::SwaggerClient::Object::TopicSchemaMapping->new(); # TopicSchemaMapping | 

eval { 
    my $result = $api_instance->registerTopicSchemaMeta(topicName => $topicName, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchemaRegistryOperationsApi->registerTopicSchemaMeta: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchemaRegistryOperationsApi()
topicName = topicName_example # String | 
body =  # TopicSchemaMapping |  (optional)

try: 
    # Register a schema name for a kafka topic name
    api_response = api_instance.register_topic_schema_meta(topicName, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchemaRegistryOperationsApi->registerTopicSchemaMeta: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required
Body parameters
Name Description
body

Responses

Status: 200 - successful operation


SearchRelatedOperations

getBrokerConfigs

Get kafka configurations for the given brokerIds.


/api/v1/admin/search/configs/brokers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/search/configs/brokers?brokerIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String brokerIds = brokerIds_example; // String | Comma separated broker identifiers
        try {
            array[KafkaResourceConfig] result = apiInstance.getBrokerConfigs(brokerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getBrokerConfigs");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchRelatedOperationsApi;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String brokerIds = brokerIds_example; // String | Comma separated broker identifiers
        try {
            array[KafkaResourceConfig] result = apiInstance.getBrokerConfigs(brokerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getBrokerConfigs");
            e.printStackTrace();
        }
    }
}
String *brokerIds = brokerIds_example; // Comma separated broker identifiers (optional)

SearchRelatedOperationsApi *apiInstance = [[SearchRelatedOperationsApi alloc] init];

// Get kafka configurations for the given brokerIds.
[apiInstance getBrokerConfigsWith:brokerIds
              completionHandler: ^(array[KafkaResourceConfig] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SearchRelatedOperationsApi()
var opts = { 
  'brokerIds': brokerIds_example // {{String}} Comma separated broker identifiers
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokerConfigs(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokerConfigsExample
    {
        public void main()
        {

            var apiInstance = new SearchRelatedOperationsApi();
            var brokerIds = brokerIds_example;  // String | Comma separated broker identifiers (optional) 

            try
            {
                // Get kafka configurations for the given brokerIds.
                array[KafkaResourceConfig] result = apiInstance.getBrokerConfigs(brokerIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchRelatedOperationsApi.getBrokerConfigs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSearchRelatedOperationsApi();
$brokerIds = brokerIds_example; // String | Comma separated broker identifiers

try {
    $result = $api_instance->getBrokerConfigs($brokerIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchRelatedOperationsApi->getBrokerConfigs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::SearchRelatedOperationsApi->new();
my $brokerIds = brokerIds_example; # String | Comma separated broker identifiers

eval { 
    my $result = $api_instance->getBrokerConfigs(brokerIds => $brokerIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchRelatedOperationsApi->getBrokerConfigs: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SearchRelatedOperationsApi()
brokerIds = brokerIds_example # String | Comma separated broker identifiers (optional)

try: 
    # Get kafka configurations for the given brokerIds.
    api_response = api_instance.get_broker_configs(brokerIds=brokerIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchRelatedOperationsApi->getBrokerConfigs: %s\n" % e)

Parameters

Query parameters
Name Description
brokerIds
String
Comma separated broker identifiers

Responses

Status: 200 - successful operation


getBrokers1

Returns broker nodes in the cluster with the given brokerIds if they exist.


/api/v1/admin/search/brokers

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/search/brokers?brokerIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String brokerIds = brokerIds_example; // String | Comma separated broker identifiers
        try {
            array[BrokerNode] result = apiInstance.getBrokers1(brokerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getBrokers1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchRelatedOperationsApi;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String brokerIds = brokerIds_example; // String | Comma separated broker identifiers
        try {
            array[BrokerNode] result = apiInstance.getBrokers1(brokerIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getBrokers1");
            e.printStackTrace();
        }
    }
}
String *brokerIds = brokerIds_example; // Comma separated broker identifiers (optional)

SearchRelatedOperationsApi *apiInstance = [[SearchRelatedOperationsApi alloc] init];

// Returns broker nodes in the cluster with the given brokerIds if they exist.
[apiInstance getBrokers1With:brokerIds
              completionHandler: ^(array[BrokerNode] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SearchRelatedOperationsApi()
var opts = { 
  'brokerIds': brokerIds_example // {{String}} Comma separated broker identifiers
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBrokers1(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getBrokers1Example
    {
        public void main()
        {

            var apiInstance = new SearchRelatedOperationsApi();
            var brokerIds = brokerIds_example;  // String | Comma separated broker identifiers (optional) 

            try
            {
                // Returns broker nodes in the cluster with the given brokerIds if they exist.
                array[BrokerNode] result = apiInstance.getBrokers1(brokerIds);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchRelatedOperationsApi.getBrokers1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSearchRelatedOperationsApi();
$brokerIds = brokerIds_example; // String | Comma separated broker identifiers

try {
    $result = $api_instance->getBrokers1($brokerIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchRelatedOperationsApi->getBrokers1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::SearchRelatedOperationsApi->new();
my $brokerIds = brokerIds_example; # String | Comma separated broker identifiers

eval { 
    my $result = $api_instance->getBrokers1(brokerIds => $brokerIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchRelatedOperationsApi->getBrokers1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SearchRelatedOperationsApi()
brokerIds = brokerIds_example # String | Comma separated broker identifiers (optional)

try: 
    # Returns broker nodes in the cluster with the given brokerIds if they exist.
    api_response = api_instance.get_brokers1(brokerIds=brokerIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchRelatedOperationsApi->getBrokers1: %s\n" % e)

Parameters

Query parameters
Name Description
brokerIds
String
Comma separated broker identifiers

Responses

Status: 200 - successful operation


getTopicConfigs1

Get kafka configurations at topic level for given topicNames


/api/v1/admin/search/configs/topics

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/search/configs/topics?topicNames="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String topicNames = topicNames_example; // String | Comma separated topic names
        try {
            array[KafkaResourceConfig] result = apiInstance.getTopicConfigs1(topicNames);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getTopicConfigs1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchRelatedOperationsApi;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String topicNames = topicNames_example; // String | Comma separated topic names
        try {
            array[KafkaResourceConfig] result = apiInstance.getTopicConfigs1(topicNames);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getTopicConfigs1");
            e.printStackTrace();
        }
    }
}
String *topicNames = topicNames_example; // Comma separated topic names (optional)

SearchRelatedOperationsApi *apiInstance = [[SearchRelatedOperationsApi alloc] init];

// Get kafka configurations at topic level for given topicNames
[apiInstance getTopicConfigs1With:topicNames
              completionHandler: ^(array[KafkaResourceConfig] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SearchRelatedOperationsApi()
var opts = { 
  'topicNames': topicNames_example // {{String}} Comma separated topic names
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicConfigs1(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicConfigs1Example
    {
        public void main()
        {

            var apiInstance = new SearchRelatedOperationsApi();
            var topicNames = topicNames_example;  // String | Comma separated topic names (optional) 

            try
            {
                // Get kafka configurations at topic level for given topicNames
                array[KafkaResourceConfig] result = apiInstance.getTopicConfigs1(topicNames);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchRelatedOperationsApi.getTopicConfigs1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSearchRelatedOperationsApi();
$topicNames = topicNames_example; // String | Comma separated topic names

try {
    $result = $api_instance->getTopicConfigs1($topicNames);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchRelatedOperationsApi->getTopicConfigs1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::SearchRelatedOperationsApi->new();
my $topicNames = topicNames_example; # String | Comma separated topic names

eval { 
    my $result = $api_instance->getTopicConfigs1(topicNames => $topicNames);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchRelatedOperationsApi->getTopicConfigs1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SearchRelatedOperationsApi()
topicNames = topicNames_example # String | Comma separated topic names (optional)

try: 
    # Get kafka configurations at topic level for given topicNames
    api_response = api_instance.get_topic_configs1(topicNames=topicNames)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchRelatedOperationsApi->getTopicConfigs1: %s\n" % e)

Parameters

Query parameters
Name Description
topicNames
String
Comma separated topic names

Responses

Status: 200 - successful operation


getTopicDetails

Get respective details for given topicNames.


/api/v1/admin/search/topics

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/search/topics?topicNames="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String topicNames = topicNames_example; // String | Comma separated topic names
        try {
            array[TopicInfo] result = apiInstance.getTopicDetails(topicNames);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getTopicDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchRelatedOperationsApi;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String topicNames = topicNames_example; // String | Comma separated topic names
        try {
            array[TopicInfo] result = apiInstance.getTopicDetails(topicNames);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getTopicDetails");
            e.printStackTrace();
        }
    }
}
String *topicNames = topicNames_example; // Comma separated topic names (optional)

SearchRelatedOperationsApi *apiInstance = [[SearchRelatedOperationsApi alloc] init];

// Get respective details for given topicNames.
[apiInstance getTopicDetailsWith:topicNames
              completionHandler: ^(array[TopicInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SearchRelatedOperationsApi()
var opts = { 
  'topicNames': topicNames_example // {{String}} Comma separated topic names
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicDetails(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicDetailsExample
    {
        public void main()
        {

            var apiInstance = new SearchRelatedOperationsApi();
            var topicNames = topicNames_example;  // String | Comma separated topic names (optional) 

            try
            {
                // Get respective details for given topicNames.
                array[TopicInfo] result = apiInstance.getTopicDetails(topicNames);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchRelatedOperationsApi.getTopicDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSearchRelatedOperationsApi();
$topicNames = topicNames_example; // String | Comma separated topic names

try {
    $result = $api_instance->getTopicDetails($topicNames);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchRelatedOperationsApi->getTopicDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::SearchRelatedOperationsApi->new();
my $topicNames = topicNames_example; # String | Comma separated topic names

eval { 
    my $result = $api_instance->getTopicDetails(topicNames => $topicNames);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchRelatedOperationsApi->getTopicDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SearchRelatedOperationsApi()
topicNames = topicNames_example # String | Comma separated topic names (optional)

try: 
    # Get respective details for given topicNames.
    api_response = api_instance.get_topic_details(topicNames=topicNames)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchRelatedOperationsApi->getTopicDetails: %s\n" % e)

Parameters

Query parameters
Name Description
topicNames
String
Comma separated topic names

Responses

Status: 200 - successful operation


getTopicPartitionInfos

Get a list of topic partitions with respective details for the given collection of topicPartitions which exist in target Kafka cluster.


/api/v1/admin/search/topicPartitions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/search/topicPartitions?partitions="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SearchRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String partitions = partitions_example; // String | Comma separated topic partition values
        try {
            TopicPartitionInfos result = apiInstance.getTopicPartitionInfos(partitions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getTopicPartitionInfos");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SearchRelatedOperationsApi;

public class SearchRelatedOperationsApiExample {

    public static void main(String[] args) {
        SearchRelatedOperationsApi apiInstance = new SearchRelatedOperationsApi();
        String partitions = partitions_example; // String | Comma separated topic partition values
        try {
            TopicPartitionInfos result = apiInstance.getTopicPartitionInfos(partitions);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SearchRelatedOperationsApi#getTopicPartitionInfos");
            e.printStackTrace();
        }
    }
}
String *partitions = partitions_example; // Comma separated topic partition values (optional)

SearchRelatedOperationsApi *apiInstance = [[SearchRelatedOperationsApi alloc] init];

// Get a list of topic partitions with respective details for the given collection of topicPartitions which exist in target Kafka cluster.
[apiInstance getTopicPartitionInfosWith:partitions
              completionHandler: ^(TopicPartitionInfos output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SearchRelatedOperationsApi()
var opts = { 
  'partitions': partitions_example // {{String}} Comma separated topic partition values
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicPartitionInfos(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicPartitionInfosExample
    {
        public void main()
        {

            var apiInstance = new SearchRelatedOperationsApi();
            var partitions = partitions_example;  // String | Comma separated topic partition values (optional) 

            try
            {
                // Get a list of topic partitions with respective details for the given collection of topicPartitions which exist in target Kafka cluster.
                TopicPartitionInfos result = apiInstance.getTopicPartitionInfos(partitions);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SearchRelatedOperationsApi.getTopicPartitionInfos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSearchRelatedOperationsApi();
$partitions = partitions_example; // String | Comma separated topic partition values

try {
    $result = $api_instance->getTopicPartitionInfos($partitions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchRelatedOperationsApi->getTopicPartitionInfos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SearchRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::SearchRelatedOperationsApi->new();
my $partitions = partitions_example; # String | Comma separated topic partition values

eval { 
    my $result = $api_instance->getTopicPartitionInfos(partitions => $partitions);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SearchRelatedOperationsApi->getTopicPartitionInfos: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SearchRelatedOperationsApi()
partitions = partitions_example # String | Comma separated topic partition values (optional)

try: 
    # Get a list of topic partitions with respective details for the given collection of topicPartitions which exist in target Kafka cluster.
    api_response = api_instance.get_topic_partition_infos(partitions=partitions)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SearchRelatedOperationsApi->getTopicPartitionInfos: %s\n" % e)

Parameters

Query parameters
Name Description
partitions
String
Comma separated topic partition values

Responses

Status: 200 - successful operation


SerdesRelatedOperations

getSupportedSerdes

List of supported serdes


/api/v1/admin/serdes

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/serdes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SerdesRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class SerdesRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        SerdesRelatedOperationsApi apiInstance = new SerdesRelatedOperationsApi();
        try {
            SerdesMappings result = apiInstance.getSupportedSerdes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SerdesRelatedOperationsApi#getSupportedSerdes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SerdesRelatedOperationsApi;

public class SerdesRelatedOperationsApiExample {

    public static void main(String[] args) {
        SerdesRelatedOperationsApi apiInstance = new SerdesRelatedOperationsApi();
        try {
            SerdesMappings result = apiInstance.getSupportedSerdes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SerdesRelatedOperationsApi#getSupportedSerdes");
            e.printStackTrace();
        }
    }
}

SerdesRelatedOperationsApi *apiInstance = [[SerdesRelatedOperationsApi alloc] init];

// List of supported serdes
[apiInstance getSupportedSerdesWithCompletionHandler: 
              ^(SerdesMappings output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.SerdesRelatedOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSupportedSerdes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSupportedSerdesExample
    {
        public void main()
        {

            var apiInstance = new SerdesRelatedOperationsApi();

            try
            {
                // List of supported serdes
                SerdesMappings result = apiInstance.getSupportedSerdes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SerdesRelatedOperationsApi.getSupportedSerdes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiSerdesRelatedOperationsApi();

try {
    $result = $api_instance->getSupportedSerdes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SerdesRelatedOperationsApi->getSupportedSerdes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SerdesRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::SerdesRelatedOperationsApi->new();

eval { 
    my $result = $api_instance->getSupportedSerdes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SerdesRelatedOperationsApi->getSupportedSerdes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SerdesRelatedOperationsApi()

try: 
    # List of supported serdes
    api_response = api_instance.get_supported_serdes()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SerdesRelatedOperationsApi->getSupportedSerdes: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


StreamsReplicationManagerConfigOperations

isStreamsReplicationManagerConfigured1

Check if streams replication manager is configured


/api/v1/admin/replication-stats/is-configured

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/replication-stats/is-configured"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerConfigOperationsApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerConfigOperationsApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerConfigOperationsApi apiInstance = new StreamsReplicationManagerConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerConfigOperationsApi#isStreamsReplicationManagerConfigured1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerConfigOperationsApi;

public class StreamsReplicationManagerConfigOperationsApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerConfigOperationsApi apiInstance = new StreamsReplicationManagerConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerConfigOperationsApi#isStreamsReplicationManagerConfigured1");
            e.printStackTrace();
        }
    }
}

StreamsReplicationManagerConfigOperationsApi *apiInstance = [[StreamsReplicationManagerConfigOperationsApi alloc] init];

// Check if streams replication manager is configured
[apiInstance isStreamsReplicationManagerConfigured1WithCompletionHandler: 
              ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerConfigOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isStreamsReplicationManagerConfigured1(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isStreamsReplicationManagerConfigured1Example
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerConfigOperationsApi();

            try
            {
                // Check if streams replication manager is configured
                'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured1();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerConfigOperationsApi.isStreamsReplicationManagerConfigured1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerConfigOperationsApi();

try {
    $result = $api_instance->isStreamsReplicationManagerConfigured1();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerConfigOperationsApi->isStreamsReplicationManagerConfigured1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerConfigOperationsApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerConfigOperationsApi->new();

eval { 
    my $result = $api_instance->isStreamsReplicationManagerConfigured1();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerConfigOperationsApi->isStreamsReplicationManagerConfigured1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerConfigOperationsApi()

try: 
    # Check if streams replication manager is configured
    api_response = api_instance.is_streams_replication_manager_configured1()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerConfigOperationsApi->isStreamsReplicationManagerConfigured1: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


isStreamsReplicationManagerConfigured2

Check if streams replication manager is configured


/api/v2/admin/replication-stats/is-configured

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/replication-stats/is-configured"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerConfigOperationsApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerConfigOperationsApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerConfigOperationsApi apiInstance = new StreamsReplicationManagerConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerConfigOperationsApi#isStreamsReplicationManagerConfigured2");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerConfigOperationsApi;

public class StreamsReplicationManagerConfigOperationsApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerConfigOperationsApi apiInstance = new StreamsReplicationManagerConfigOperationsApi();
        try {
            'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerConfigOperationsApi#isStreamsReplicationManagerConfigured2");
            e.printStackTrace();
        }
    }
}

StreamsReplicationManagerConfigOperationsApi *apiInstance = [[StreamsReplicationManagerConfigOperationsApi alloc] init];

// Check if streams replication manager is configured
[apiInstance isStreamsReplicationManagerConfigured2WithCompletionHandler: 
              ^('Boolean' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerConfigOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.isStreamsReplicationManagerConfigured2(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class isStreamsReplicationManagerConfigured2Example
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerConfigOperationsApi();

            try
            {
                // Check if streams replication manager is configured
                'Boolean' result = apiInstance.isStreamsReplicationManagerConfigured2();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerConfigOperationsApi.isStreamsReplicationManagerConfigured2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerConfigOperationsApi();

try {
    $result = $api_instance->isStreamsReplicationManagerConfigured2();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerConfigOperationsApi->isStreamsReplicationManagerConfigured2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerConfigOperationsApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerConfigOperationsApi->new();

eval { 
    my $result = $api_instance->isStreamsReplicationManagerConfigured2();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerConfigOperationsApi->isStreamsReplicationManagerConfigured2: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerConfigOperationsApi()

try: 
    # Check if streams replication manager is configured
    api_response = api_instance.is_streams_replication_manager_configured2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerConfigOperationsApi->isStreamsReplicationManagerConfigured2: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


StreamsReplicationManagerMonitoringOperations

clusterReplicationStats

Get replication stats for all the streams that are being replicated


/api/v1/admin/replication-stats

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/replication-stats?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerMonitoringOperationsApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerMonitoringOperationsApi apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
        String duration = duration_example; // String | Time span
        try {
            ClusterReplicationStatsDTO result = apiInstance.clusterReplicationStats(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsApi#clusterReplicationStats");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsApi;

public class StreamsReplicationManagerMonitoringOperationsApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerMonitoringOperationsApi apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
        String duration = duration_example; // String | Time span
        try {
            ClusterReplicationStatsDTO result = apiInstance.clusterReplicationStats(duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsApi#clusterReplicationStats");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Time span (optional)

StreamsReplicationManagerMonitoringOperationsApi *apiInstance = [[StreamsReplicationManagerMonitoringOperationsApi alloc] init];

// Get replication stats for all the streams that are being replicated
[apiInstance clusterReplicationStatsWith:duration
              completionHandler: ^(ClusterReplicationStatsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerMonitoringOperationsApi()
var opts = { 
  'duration': duration_example // {{String}} Time span
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clusterReplicationStats(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class clusterReplicationStatsExample
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
            var duration = duration_example;  // String | Time span (optional) 

            try
            {
                // Get replication stats for all the streams that are being replicated
                ClusterReplicationStatsDTO result = apiInstance.clusterReplicationStats(duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerMonitoringOperationsApi.clusterReplicationStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerMonitoringOperationsApi();
$duration = duration_example; // String | Time span

try {
    $result = $api_instance->clusterReplicationStats($duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerMonitoringOperationsApi->clusterReplicationStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsApi->new();
my $duration = duration_example; # String | Time span

eval { 
    my $result = $api_instance->clusterReplicationStats(duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerMonitoringOperationsApi->clusterReplicationStats: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerMonitoringOperationsApi()
duration = duration_example # String | Time span (optional)

try: 
    # Get replication stats for all the streams that are being replicated
    api_response = api_instance.cluster_replication_stats(duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerMonitoringOperationsApi->clusterReplicationStats: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Time span

Responses

Status: 200 - successful operation


topicReplicationStats

Get all the topic replication stats for a given source cluster


/api/v1/admin/replication-stats/{source}/topics

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/replication-stats/{source}/topics?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerMonitoringOperationsApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerMonitoringOperationsApi apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
        String source = source_example; // String | Source name
        String duration = duration_example; // String | Time span
        try {
            TopicReplicationStatsDTO result = apiInstance.topicReplicationStats(source, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsApi#topicReplicationStats");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsApi;

public class StreamsReplicationManagerMonitoringOperationsApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerMonitoringOperationsApi apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
        String source = source_example; // String | Source name
        String duration = duration_example; // String | Time span
        try {
            TopicReplicationStatsDTO result = apiInstance.topicReplicationStats(source, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsApi#topicReplicationStats");
            e.printStackTrace();
        }
    }
}
String *source = source_example; // Source name
String *duration = duration_example; // Time span (optional)

StreamsReplicationManagerMonitoringOperationsApi *apiInstance = [[StreamsReplicationManagerMonitoringOperationsApi alloc] init];

// Get all the topic replication stats for a given source cluster
[apiInstance topicReplicationStatsWith:source
    duration:duration
              completionHandler: ^(TopicReplicationStatsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerMonitoringOperationsApi()
var source = source_example; // {{String}} Source name
var opts = { 
  'duration': duration_example // {{String}} Time span
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.topicReplicationStats(source, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class topicReplicationStatsExample
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
            var source = source_example;  // String | Source name
            var duration = duration_example;  // String | Time span (optional) 

            try
            {
                // Get all the topic replication stats for a given source cluster
                TopicReplicationStatsDTO result = apiInstance.topicReplicationStats(source, duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerMonitoringOperationsApi.topicReplicationStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerMonitoringOperationsApi();
$source = source_example; // String | Source name
$duration = duration_example; // String | Time span

try {
    $result = $api_instance->topicReplicationStats($source, $duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerMonitoringOperationsApi->topicReplicationStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsApi->new();
my $source = source_example; # String | Source name
my $duration = duration_example; # String | Time span

eval { 
    my $result = $api_instance->topicReplicationStats(source => $source, duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerMonitoringOperationsApi->topicReplicationStats: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerMonitoringOperationsApi()
source = source_example # String | Source name
duration = duration_example # String | Time span (optional)

try: 
    # Get all the topic replication stats for a given source cluster
    api_response = api_instance.topic_replication_stats(source, duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerMonitoringOperationsApi->topicReplicationStats: %s\n" % e)

Parameters

Path parameters
Name Description
source*
String
Source name
Required
Query parameters
Name Description
duration
String
Time span

Responses

Status: 200 - successful operation


topicTimelineMetrics

Get all the timeline metrics for a given topic


/api/v1/admin/replication-stats/topics/{topic}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/replication-stats/topics/{topic}?duration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerMonitoringOperationsApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerMonitoringOperationsApi apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
        String topic = topic_example; // String | Topic name
        String duration = duration_example; // String | Time span
        try {
            TopicTimelineMetricsDTO result = apiInstance.topicTimelineMetrics(topic, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsApi#topicTimelineMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsApi;

public class StreamsReplicationManagerMonitoringOperationsApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerMonitoringOperationsApi apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
        String topic = topic_example; // String | Topic name
        String duration = duration_example; // String | Time span
        try {
            TopicTimelineMetricsDTO result = apiInstance.topicTimelineMetrics(topic, duration);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsApi#topicTimelineMetrics");
            e.printStackTrace();
        }
    }
}
String *topic = topic_example; // Topic name
String *duration = duration_example; // Time span (optional)

StreamsReplicationManagerMonitoringOperationsApi *apiInstance = [[StreamsReplicationManagerMonitoringOperationsApi alloc] init];

// Get all the timeline metrics for a given topic
[apiInstance topicTimelineMetricsWith:topic
    duration:duration
              completionHandler: ^(TopicTimelineMetricsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerMonitoringOperationsApi()
var topic = topic_example; // {{String}} Topic name
var opts = { 
  'duration': duration_example // {{String}} Time span
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.topicTimelineMetrics(topic, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class topicTimelineMetricsExample
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerMonitoringOperationsApi();
            var topic = topic_example;  // String | Topic name
            var duration = duration_example;  // String | Time span (optional) 

            try
            {
                // Get all the timeline metrics for a given topic
                TopicTimelineMetricsDTO result = apiInstance.topicTimelineMetrics(topic, duration);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerMonitoringOperationsApi.topicTimelineMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerMonitoringOperationsApi();
$topic = topic_example; // String | Topic name
$duration = duration_example; // String | Time span

try {
    $result = $api_instance->topicTimelineMetrics($topic, $duration);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerMonitoringOperationsApi->topicTimelineMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsApi->new();
my $topic = topic_example; # String | Topic name
my $duration = duration_example; # String | Time span

eval { 
    my $result = $api_instance->topicTimelineMetrics(topic => $topic, duration => $duration);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerMonitoringOperationsApi->topicTimelineMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerMonitoringOperationsApi()
topic = topic_example # String | Topic name
duration = duration_example # String | Time span (optional)

try: 
    # Get all the timeline metrics for a given topic
    api_response = api_instance.topic_timeline_metrics(topic, duration=duration)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerMonitoringOperationsApi->topicTimelineMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
topic*
String
Topic name
Required
Query parameters
Name Description
duration
String
Time span

Responses

Status: 200 - successful operation


StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPI

clusterReplicationStats1

Get replication stats for all the streams that are being replicated


/api/v2/admin/replication-stats

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/replication-stats?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
        String duration = duration_example; // String | Time span
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ClusterReplicationStatsDTO result = apiInstance.clusterReplicationStats1(duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi#clusterReplicationStats1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

public class StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
        String duration = duration_example; // String | Time span
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            ClusterReplicationStatsDTO result = apiInstance.clusterReplicationStats1(duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi#clusterReplicationStats1");
            e.printStackTrace();
        }
    }
}
String *duration = duration_example; // Time span (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi *apiInstance = [[StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi alloc] init];

// Get replication stats for all the streams that are being replicated
[apiInstance clusterReplicationStats1With:duration
    from:from
    to:to
              completionHandler: ^(ClusterReplicationStatsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi()
var opts = { 
  'duration': duration_example, // {{String}} Time span
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clusterReplicationStats1(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class clusterReplicationStats1Example
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
            var duration = duration_example;  // String | Time span (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get replication stats for all the streams that are being replicated
                ClusterReplicationStatsDTO result = apiInstance.clusterReplicationStats1(duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi.clusterReplicationStats1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
$duration = duration_example; // String | Time span
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->clusterReplicationStats1($duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->clusterReplicationStats1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->new();
my $duration = duration_example; # String | Time span
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->clusterReplicationStats1(duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->clusterReplicationStats1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi()
duration = duration_example # String | Time span (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get replication stats for all the streams that are being replicated
    api_response = api_instance.cluster_replication_stats1(duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->clusterReplicationStats1: %s\n" % e)

Parameters

Query parameters
Name Description
duration
String
Time span
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


downstreamTopicMetricsForColocatedCluster

Get topic metrics from colocated SRM Service for a specific (downstream) topic


/api/v2/admin/replication-stats/topics/{downstreamTopic}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/replication-stats/topics/{downstreamTopic}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
        String downstreamTopic = downstreamTopic_example; // String | Downstream topic name
        String duration = duration_example; // String | Time span
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicTimelineMetricsDTO result = apiInstance.downstreamTopicMetricsForColocatedCluster(downstreamTopic, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi#downstreamTopicMetricsForColocatedCluster");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

public class StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
        String downstreamTopic = downstreamTopic_example; // String | Downstream topic name
        String duration = duration_example; // String | Time span
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicTimelineMetricsDTO result = apiInstance.downstreamTopicMetricsForColocatedCluster(downstreamTopic, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi#downstreamTopicMetricsForColocatedCluster");
            e.printStackTrace();
        }
    }
}
String *downstreamTopic = downstreamTopic_example; // Downstream topic name
String *duration = duration_example; // Time span (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi *apiInstance = [[StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi alloc] init];

// Get topic metrics from colocated SRM Service for a specific (downstream) topic
[apiInstance downstreamTopicMetricsForColocatedClusterWith:downstreamTopic
    duration:duration
    from:from
    to:to
              completionHandler: ^(TopicTimelineMetricsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi()
var downstreamTopic = downstreamTopic_example; // {{String}} Downstream topic name
var opts = { 
  'duration': duration_example, // {{String}} Time span
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.downstreamTopicMetricsForColocatedCluster(downstreamTopic, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class downstreamTopicMetricsForColocatedClusterExample
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
            var downstreamTopic = downstreamTopic_example;  // String | Downstream topic name
            var duration = duration_example;  // String | Time span (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get topic metrics from colocated SRM Service for a specific (downstream) topic
                TopicTimelineMetricsDTO result = apiInstance.downstreamTopicMetricsForColocatedCluster(downstreamTopic, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi.downstreamTopicMetricsForColocatedCluster: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
$downstreamTopic = downstreamTopic_example; // String | Downstream topic name
$duration = duration_example; // String | Time span
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->downstreamTopicMetricsForColocatedCluster($downstreamTopic, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->downstreamTopicMetricsForColocatedCluster: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->new();
my $downstreamTopic = downstreamTopic_example; # String | Downstream topic name
my $duration = duration_example; # String | Time span
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->downstreamTopicMetricsForColocatedCluster(downstreamTopic => $downstreamTopic, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->downstreamTopicMetricsForColocatedCluster: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi()
downstreamTopic = downstreamTopic_example # String | Downstream topic name
duration = duration_example # String | Time span (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get topic metrics from colocated SRM Service for a specific (downstream) topic
    api_response = api_instance.downstream_topic_metrics_for_colocated_cluster(downstreamTopic, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->downstreamTopicMetricsForColocatedCluster: %s\n" % e)

Parameters

Path parameters
Name Description
downstreamTopic*
String
Downstream topic name
Required
Query parameters
Name Description
duration
String
Time span
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


topicReplicationStats1

Get all the topic replication stats for a given source cluster


/api/v2/admin/replication-stats/topics/{source}/{target}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/replication-stats/topics/{source}/{target}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
        String source = source_example; // String | Source name
        String target = target_example; // String | Target name
        String duration = duration_example; // String | Time span
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicReplicationStatsDTO result = apiInstance.topicReplicationStats1(source, target, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi#topicReplicationStats1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

public class StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
        String source = source_example; // String | Source name
        String target = target_example; // String | Target name
        String duration = duration_example; // String | Time span
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicReplicationStatsDTO result = apiInstance.topicReplicationStats1(source, target, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi#topicReplicationStats1");
            e.printStackTrace();
        }
    }
}
String *source = source_example; // Source name
String *target = target_example; // Target name
String *duration = duration_example; // Time span (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi *apiInstance = [[StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi alloc] init];

// Get all the topic replication stats for a given source cluster
[apiInstance topicReplicationStats1With:source
    target:target
    duration:duration
    from:from
    to:to
              completionHandler: ^(TopicReplicationStatsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi()
var source = source_example; // {{String}} Source name
var target = target_example; // {{String}} Target name
var opts = { 
  'duration': duration_example, // {{String}} Time span
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.topicReplicationStats1(source, target, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class topicReplicationStats1Example
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
            var source = source_example;  // String | Source name
            var target = target_example;  // String | Target name
            var duration = duration_example;  // String | Time span (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get all the topic replication stats for a given source cluster
                TopicReplicationStatsDTO result = apiInstance.topicReplicationStats1(source, target, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi.topicReplicationStats1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
$source = source_example; // String | Source name
$target = target_example; // String | Target name
$duration = duration_example; // String | Time span
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->topicReplicationStats1($source, $target, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->topicReplicationStats1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->new();
my $source = source_example; # String | Source name
my $target = target_example; # String | Target name
my $duration = duration_example; # String | Time span
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->topicReplicationStats1(source => $source, target => $target, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->topicReplicationStats1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi()
source = source_example # String | Source name
target = target_example # String | Target name
duration = duration_example # String | Time span (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get all the topic replication stats for a given source cluster
    api_response = api_instance.topic_replication_stats1(source, target, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->topicReplicationStats1: %s\n" % e)

Parameters

Path parameters
Name Description
source*
String
Source name
Required
target*
String
Target name
Required
Query parameters
Name Description
duration
String
Time span
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


topicTimelineMetrics1

Get all the timeline metrics for a given topic


/api/v2/admin/replication-stats/topics/{source}/{target}/{upstreamtopic}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v2/admin/replication-stats/topics/{source}/{target}/{upstreamtopic}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

import java.io.File;
import java.util.*;

public class StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApiExample {

    public static void main(String[] args) {
        
        StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
        String source = source_example; // String | Source name
        String target = target_example; // String | Target name
        String upstreamtopic = upstreamtopic_example; // String | Upstream topic name
        String duration = duration_example; // String | Time span
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicTimelineMetricsDTO result = apiInstance.topicTimelineMetrics1(source, target, upstreamtopic, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi#topicTimelineMetrics1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

public class StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApiExample {

    public static void main(String[] args) {
        StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
        String source = source_example; // String | Source name
        String target = target_example; // String | Target name
        String upstreamtopic = upstreamtopic_example; // String | Upstream topic name
        String duration = duration_example; // String | Time span
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicTimelineMetricsDTO result = apiInstance.topicTimelineMetrics1(source, target, upstreamtopic, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi#topicTimelineMetrics1");
            e.printStackTrace();
        }
    }
}
String *source = source_example; // Source name
String *target = target_example; // Target name
String *upstreamtopic = upstreamtopic_example; // Upstream topic name
String *duration = duration_example; // Time span (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi *apiInstance = [[StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi alloc] init];

// Get all the timeline metrics for a given topic
[apiInstance topicTimelineMetrics1With:source
    target:target
    upstreamtopic:upstreamtopic
    duration:duration
    from:from
    to:to
              completionHandler: ^(TopicTimelineMetricsDTO output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi()
var source = source_example; // {{String}} Source name
var target = target_example; // {{String}} Target name
var upstreamtopic = upstreamtopic_example; // {{String}} Upstream topic name
var opts = { 
  'duration': duration_example, // {{String}} Time span
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.topicTimelineMetrics1(source, target, upstreamtopic, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class topicTimelineMetrics1Example
    {
        public void main()
        {

            var apiInstance = new StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
            var source = source_example;  // String | Source name
            var target = target_example;  // String | Target name
            var upstreamtopic = upstreamtopic_example;  // String | Upstream topic name
            var duration = duration_example;  // String | Time span (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get all the timeline metrics for a given topic
                TopicTimelineMetricsDTO result = apiInstance.topicTimelineMetrics1(source, target, upstreamtopic, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi.topicTimelineMetrics1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiStreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi();
$source = source_example; // String | Source name
$target = target_example; // String | Target name
$upstreamtopic = upstreamtopic_example; // String | Upstream topic name
$duration = duration_example; // String | Time span
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->topicTimelineMetrics1($source, $target, $upstreamtopic, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->topicTimelineMetrics1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi;

my $api_instance = WWW::SwaggerClient::StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->new();
my $source = source_example; # String | Source name
my $target = target_example; # String | Target name
my $upstreamtopic = upstreamtopic_example; # String | Upstream topic name
my $duration = duration_example; # String | Time span
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->topicTimelineMetrics1(source => $source, target => $target, upstreamtopic => $upstreamtopic, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->topicTimelineMetrics1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi()
source = source_example # String | Source name
target = target_example # String | Target name
upstreamtopic = upstreamtopic_example # String | Upstream topic name
duration = duration_example # String | Time span (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get all the timeline metrics for a given topic
    api_response = api_instance.topic_timeline_metrics1(source, target, upstreamtopic, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StreamsReplicationManagerMonitoringOperationsUsingV2SRMAPIApi->topicTimelineMetrics1: %s\n" % e)

Parameters

Path parameters
Name Description
source*
String
Source name
Required
target*
String
Target name
Required
upstreamtopic*
String
Upstream topic name
Required
Query parameters
Name Description
duration
String
Time span
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


TopicConsumptionOperations

getTopicContent

Get topic content for a given topic, its partition and the offset range with in the partition


/api/v1/admin/topics/{topicName}/partition/{partitionId}/payloads

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/topics/{topicName}/partition/{partitionId}/payloads?startOffset=&endOffset=&numOfRecords=&keyMaxCharLength=&valueMaxCharLength=&keyDeserializer=&valueDeserializer=&responseWaitTimeInMs=&consumerIsolationLevel="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicConsumptionOperationsApi;

import java.io.File;
import java.util.*;

public class TopicConsumptionOperationsApiExample {

    public static void main(String[] args) {
        
        TopicConsumptionOperationsApi apiInstance = new TopicConsumptionOperationsApi();
        String topicName = topicName_example; // String | 
        Integer partitionId = 56; // Integer | 
        Long startOffset = 789; // Long | 
        Long endOffset = 789; // Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed
        Long numOfRecords = 789; // Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed
        Integer keyMaxCharLength = 56; // Integer | Only supported for String keys
        Integer valueMaxCharLength = 56; // Integer | Only supported for String values
        String keyDeserializer = keyDeserializer_example; // String | 
        String valueDeserializer = valueDeserializer_example; // String | 
        Long responseWaitTimeInMs = 789; // Long | 
        String consumerIsolationLevel = consumerIsolationLevel_example; // String | the isolation.level ConsumerConfig passed down to the consumer
        try {
            TopicContent result = apiInstance.getTopicContent(topicName, partitionId, startOffset, endOffset, numOfRecords, keyMaxCharLength, valueMaxCharLength, keyDeserializer, valueDeserializer, responseWaitTimeInMs, consumerIsolationLevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicConsumptionOperationsApi#getTopicContent");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicConsumptionOperationsApi;

public class TopicConsumptionOperationsApiExample {

    public static void main(String[] args) {
        TopicConsumptionOperationsApi apiInstance = new TopicConsumptionOperationsApi();
        String topicName = topicName_example; // String | 
        Integer partitionId = 56; // Integer | 
        Long startOffset = 789; // Long | 
        Long endOffset = 789; // Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed
        Long numOfRecords = 789; // Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed
        Integer keyMaxCharLength = 56; // Integer | Only supported for String keys
        Integer valueMaxCharLength = 56; // Integer | Only supported for String values
        String keyDeserializer = keyDeserializer_example; // String | 
        String valueDeserializer = valueDeserializer_example; // String | 
        Long responseWaitTimeInMs = 789; // Long | 
        String consumerIsolationLevel = consumerIsolationLevel_example; // String | the isolation.level ConsumerConfig passed down to the consumer
        try {
            TopicContent result = apiInstance.getTopicContent(topicName, partitionId, startOffset, endOffset, numOfRecords, keyMaxCharLength, valueMaxCharLength, keyDeserializer, valueDeserializer, responseWaitTimeInMs, consumerIsolationLevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicConsumptionOperationsApi#getTopicContent");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 
Integer *partitionId = 56; // 
Long *startOffset = 789; //  (optional)
Long *endOffset = 789; // Either endOffset or numOfRecords must be provided! Both or neither are not allowed (optional)
Long *numOfRecords = 789; // Either endOffset or numOfRecords must be provided! Both or neither are not allowed (optional)
Integer *keyMaxCharLength = 56; // Only supported for String keys (optional)
Integer *valueMaxCharLength = 56; // Only supported for String values (optional)
String *keyDeserializer = keyDeserializer_example; //  (optional)
String *valueDeserializer = valueDeserializer_example; //  (optional)
Long *responseWaitTimeInMs = 789; //  (optional)
String *consumerIsolationLevel = consumerIsolationLevel_example; // the isolation.level ConsumerConfig passed down to the consumer (optional)

TopicConsumptionOperationsApi *apiInstance = [[TopicConsumptionOperationsApi alloc] init];

// Get topic content for a given topic, its partition and the offset range with in the partition
[apiInstance getTopicContentWith:topicName
    partitionId:partitionId
    startOffset:startOffset
    endOffset:endOffset
    numOfRecords:numOfRecords
    keyMaxCharLength:keyMaxCharLength
    valueMaxCharLength:valueMaxCharLength
    keyDeserializer:keyDeserializer
    valueDeserializer:valueDeserializer
    responseWaitTimeInMs:responseWaitTimeInMs
    consumerIsolationLevel:consumerIsolationLevel
              completionHandler: ^(TopicContent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicConsumptionOperationsApi()
var topicName = topicName_example; // {{String}} 
var partitionId = 56; // {{Integer}} 
var opts = { 
  'startOffset': 789, // {{Long}} 
  'endOffset': 789, // {{Long}} Either endOffset or numOfRecords must be provided! Both or neither are not allowed
  'numOfRecords': 789, // {{Long}} Either endOffset or numOfRecords must be provided! Both or neither are not allowed
  'keyMaxCharLength': 56, // {{Integer}} Only supported for String keys
  'valueMaxCharLength': 56, // {{Integer}} Only supported for String values
  'keyDeserializer': keyDeserializer_example, // {{String}} 
  'valueDeserializer': valueDeserializer_example, // {{String}} 
  'responseWaitTimeInMs': 789, // {{Long}} 
  'consumerIsolationLevel': consumerIsolationLevel_example // {{String}} the isolation.level ConsumerConfig passed down to the consumer
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicContent(topicName, partitionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicContentExample
    {
        public void main()
        {

            var apiInstance = new TopicConsumptionOperationsApi();
            var topicName = topicName_example;  // String | 
            var partitionId = 56;  // Integer | 
            var startOffset = 789;  // Long |  (optional) 
            var endOffset = 789;  // Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed (optional) 
            var numOfRecords = 789;  // Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed (optional) 
            var keyMaxCharLength = 56;  // Integer | Only supported for String keys (optional) 
            var valueMaxCharLength = 56;  // Integer | Only supported for String values (optional) 
            var keyDeserializer = keyDeserializer_example;  // String |  (optional) 
            var valueDeserializer = valueDeserializer_example;  // String |  (optional) 
            var responseWaitTimeInMs = 789;  // Long |  (optional) 
            var consumerIsolationLevel = consumerIsolationLevel_example;  // String | the isolation.level ConsumerConfig passed down to the consumer (optional) 

            try
            {
                // Get topic content for a given topic, its partition and the offset range with in the partition
                TopicContent result = apiInstance.getTopicContent(topicName, partitionId, startOffset, endOffset, numOfRecords, keyMaxCharLength, valueMaxCharLength, keyDeserializer, valueDeserializer, responseWaitTimeInMs, consumerIsolationLevel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicConsumptionOperationsApi.getTopicContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicConsumptionOperationsApi();
$topicName = topicName_example; // String | 
$partitionId = 56; // Integer | 
$startOffset = 789; // Long | 
$endOffset = 789; // Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed
$numOfRecords = 789; // Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed
$keyMaxCharLength = 56; // Integer | Only supported for String keys
$valueMaxCharLength = 56; // Integer | Only supported for String values
$keyDeserializer = keyDeserializer_example; // String | 
$valueDeserializer = valueDeserializer_example; // String | 
$responseWaitTimeInMs = 789; // Long | 
$consumerIsolationLevel = consumerIsolationLevel_example; // String | the isolation.level ConsumerConfig passed down to the consumer

try {
    $result = $api_instance->getTopicContent($topicName, $partitionId, $startOffset, $endOffset, $numOfRecords, $keyMaxCharLength, $valueMaxCharLength, $keyDeserializer, $valueDeserializer, $responseWaitTimeInMs, $consumerIsolationLevel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicConsumptionOperationsApi->getTopicContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicConsumptionOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicConsumptionOperationsApi->new();
my $topicName = topicName_example; # String | 
my $partitionId = 56; # Integer | 
my $startOffset = 789; # Long | 
my $endOffset = 789; # Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed
my $numOfRecords = 789; # Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed
my $keyMaxCharLength = 56; # Integer | Only supported for String keys
my $valueMaxCharLength = 56; # Integer | Only supported for String values
my $keyDeserializer = keyDeserializer_example; # String | 
my $valueDeserializer = valueDeserializer_example; # String | 
my $responseWaitTimeInMs = 789; # Long | 
my $consumerIsolationLevel = consumerIsolationLevel_example; # String | the isolation.level ConsumerConfig passed down to the consumer

eval { 
    my $result = $api_instance->getTopicContent(topicName => $topicName, partitionId => $partitionId, startOffset => $startOffset, endOffset => $endOffset, numOfRecords => $numOfRecords, keyMaxCharLength => $keyMaxCharLength, valueMaxCharLength => $valueMaxCharLength, keyDeserializer => $keyDeserializer, valueDeserializer => $valueDeserializer, responseWaitTimeInMs => $responseWaitTimeInMs, consumerIsolationLevel => $consumerIsolationLevel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicConsumptionOperationsApi->getTopicContent: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicConsumptionOperationsApi()
topicName = topicName_example # String | 
partitionId = 56 # Integer | 
startOffset = 789 # Long |  (optional)
endOffset = 789 # Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed (optional)
numOfRecords = 789 # Long | Either endOffset or numOfRecords must be provided! Both or neither are not allowed (optional)
keyMaxCharLength = 56 # Integer | Only supported for String keys (optional)
valueMaxCharLength = 56 # Integer | Only supported for String values (optional)
keyDeserializer = keyDeserializer_example # String |  (optional)
valueDeserializer = valueDeserializer_example # String |  (optional)
responseWaitTimeInMs = 789 # Long |  (optional)
consumerIsolationLevel = consumerIsolationLevel_example # String | the isolation.level ConsumerConfig passed down to the consumer (optional)

try: 
    # Get topic content for a given topic, its partition and the offset range with in the partition
    api_response = api_instance.get_topic_content(topicName, partitionId, startOffset=startOffset, endOffset=endOffset, numOfRecords=numOfRecords, keyMaxCharLength=keyMaxCharLength, valueMaxCharLength=valueMaxCharLength, keyDeserializer=keyDeserializer, valueDeserializer=valueDeserializer, responseWaitTimeInMs=responseWaitTimeInMs, consumerIsolationLevel=consumerIsolationLevel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicConsumptionOperationsApi->getTopicContent: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required
partitionId*
Integer (int32)
Required
Query parameters
Name Description
startOffset
Long (int64)
endOffset
Long (int64)
Either endOffset or numOfRecords must be provided! Both or neither are not allowed
numOfRecords
Long (int64)
Either endOffset or numOfRecords must be provided! Both or neither are not allowed
keyMaxCharLength
Integer (int32)
Only supported for String keys
valueMaxCharLength
Integer (int32)
Only supported for String values
keyDeserializer
String
valueDeserializer
String
responseWaitTimeInMs
Long (int64)
consumerIsolationLevel
String
the isolation.level ConsumerConfig passed down to the consumer

Responses

Status: 200 - successful operation


getTopicOffsets

Get offsets for all the partition for a given kafka topic name


/api/v1/admin/topics/{topicName}/offsets

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/topics/{topicName}/offsets?consumerIsolationLevel="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicConsumptionOperationsApi;

import java.io.File;
import java.util.*;

public class TopicConsumptionOperationsApiExample {

    public static void main(String[] args) {
        
        TopicConsumptionOperationsApi apiInstance = new TopicConsumptionOperationsApi();
        String topicName = topicName_example; // String | 
        String consumerIsolationLevel = consumerIsolationLevel_example; // String | isolation.level config for consumer used
        try {
            TopicOffsetInfo result = apiInstance.getTopicOffsets(topicName, consumerIsolationLevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicConsumptionOperationsApi#getTopicOffsets");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicConsumptionOperationsApi;

public class TopicConsumptionOperationsApiExample {

    public static void main(String[] args) {
        TopicConsumptionOperationsApi apiInstance = new TopicConsumptionOperationsApi();
        String topicName = topicName_example; // String | 
        String consumerIsolationLevel = consumerIsolationLevel_example; // String | isolation.level config for consumer used
        try {
            TopicOffsetInfo result = apiInstance.getTopicOffsets(topicName, consumerIsolationLevel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicConsumptionOperationsApi#getTopicOffsets");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 
String *consumerIsolationLevel = consumerIsolationLevel_example; // isolation.level config for consumer used (optional)

TopicConsumptionOperationsApi *apiInstance = [[TopicConsumptionOperationsApi alloc] init];

// Get offsets for all the partition for a given kafka topic name
[apiInstance getTopicOffsetsWith:topicName
    consumerIsolationLevel:consumerIsolationLevel
              completionHandler: ^(TopicOffsetInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicConsumptionOperationsApi()
var topicName = topicName_example; // {{String}} 
var opts = { 
  'consumerIsolationLevel': consumerIsolationLevel_example // {{String}} isolation.level config for consumer used
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicOffsets(topicName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicOffsetsExample
    {
        public void main()
        {

            var apiInstance = new TopicConsumptionOperationsApi();
            var topicName = topicName_example;  // String | 
            var consumerIsolationLevel = consumerIsolationLevel_example;  // String | isolation.level config for consumer used (optional) 

            try
            {
                // Get offsets for all the partition for a given kafka topic name
                TopicOffsetInfo result = apiInstance.getTopicOffsets(topicName, consumerIsolationLevel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicConsumptionOperationsApi.getTopicOffsets: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicConsumptionOperationsApi();
$topicName = topicName_example; // String | 
$consumerIsolationLevel = consumerIsolationLevel_example; // String | isolation.level config for consumer used

try {
    $result = $api_instance->getTopicOffsets($topicName, $consumerIsolationLevel);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicConsumptionOperationsApi->getTopicOffsets: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicConsumptionOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicConsumptionOperationsApi->new();
my $topicName = topicName_example; # String | 
my $consumerIsolationLevel = consumerIsolationLevel_example; # String | isolation.level config for consumer used

eval { 
    my $result = $api_instance->getTopicOffsets(topicName => $topicName, consumerIsolationLevel => $consumerIsolationLevel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicConsumptionOperationsApi->getTopicOffsets: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicConsumptionOperationsApi()
topicName = topicName_example # String | 
consumerIsolationLevel = consumerIsolationLevel_example # String | isolation.level config for consumer used (optional)

try: 
    # Get offsets for all the partition for a given kafka topic name
    api_response = api_instance.get_topic_offsets(topicName, consumerIsolationLevel=consumerIsolationLevel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicConsumptionOperationsApi->getTopicOffsets: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required
Query parameters
Name Description
consumerIsolationLevel
String
isolation.level config for consumer used

Responses

Status: 200 - successful operation


TopicMetadataRelatedOperations

allTopicInfos

Get respective details for all the topics.


/api/v1/admin/topics

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/topics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        try {
            array[TopicInfo] result = apiInstance.allTopicInfos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#allTopicInfos");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        try {
            array[TopicInfo] result = apiInstance.allTopicInfos();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#allTopicInfos");
            e.printStackTrace();
        }
    }
}

TopicMetadataRelatedOperationsApi *apiInstance = [[TopicMetadataRelatedOperationsApi alloc] init];

// Get respective details for all the topics. 
[apiInstance allTopicInfosWithCompletionHandler: 
              ^(array[TopicInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetadataRelatedOperationsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.allTopicInfos(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class allTopicInfosExample
    {
        public void main()
        {

            var apiInstance = new TopicMetadataRelatedOperationsApi();

            try
            {
                // Get respective details for all the topics. 
                array[TopicInfo] result = apiInstance.allTopicInfos();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetadataRelatedOperationsApi.allTopicInfos: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetadataRelatedOperationsApi();

try {
    $result = $api_instance->allTopicInfos();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetadataRelatedOperationsApi->allTopicInfos: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetadataRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetadataRelatedOperationsApi->new();

eval { 
    my $result = $api_instance->allTopicInfos();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicMetadataRelatedOperationsApi->allTopicInfos: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetadataRelatedOperationsApi()

try: 
    # Get respective details for all the topics. 
    api_response = api_instance.all_topic_infos()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicMetadataRelatedOperationsApi->allTopicInfos: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


createPartitions

Alter topic partitions


/api/v1/admin/topics

Usage and SDK Samples

curl -X PUT\
-H "Content-Type: */*"\
"//api/v1/admin/topics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        NewTopicPartitions body = ; // NewTopicPartitions | 
        try {
            apiInstance.createPartitions(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#createPartitions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        NewTopicPartitions body = ; // NewTopicPartitions | 
        try {
            apiInstance.createPartitions(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#createPartitions");
            e.printStackTrace();
        }
    }
}
NewTopicPartitions *body = ; //  (optional)

TopicMetadataRelatedOperationsApi *apiInstance = [[TopicMetadataRelatedOperationsApi alloc] init];

// Alter topic partitions
[apiInstance createPartitionsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetadataRelatedOperationsApi()
var opts = { 
  'body':  // {{NewTopicPartitions}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createPartitions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createPartitionsExample
    {
        public void main()
        {

            var apiInstance = new TopicMetadataRelatedOperationsApi();
            var body = new NewTopicPartitions(); // NewTopicPartitions |  (optional) 

            try
            {
                // Alter topic partitions
                apiInstance.createPartitions(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetadataRelatedOperationsApi.createPartitions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetadataRelatedOperationsApi();
$body = ; // NewTopicPartitions | 

try {
    $api_instance->createPartitions($body);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetadataRelatedOperationsApi->createPartitions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetadataRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetadataRelatedOperationsApi->new();
my $body = WWW::SwaggerClient::Object::NewTopicPartitions->new(); # NewTopicPartitions | 

eval { 
    $api_instance->createPartitions(body => $body);
};
if ($@) {
    warn "Exception when calling TopicMetadataRelatedOperationsApi->createPartitions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetadataRelatedOperationsApi()
body =  # NewTopicPartitions |  (optional)

try: 
    # Alter topic partitions
    api_instance.create_partitions(body=body)
except ApiException as e:
    print("Exception when calling TopicMetadataRelatedOperationsApi->createPartitions: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: default - successful operation


createTopics

Create topics


/api/v1/admin/topics

Usage and SDK Samples

curl -X POST\
-H "Content-Type: */*"\
"//api/v1/admin/topics"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        NewTopics body = ; // NewTopics | 
        try {
            apiInstance.createTopics(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#createTopics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        NewTopics body = ; // NewTopics | 
        try {
            apiInstance.createTopics(body);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#createTopics");
            e.printStackTrace();
        }
    }
}
NewTopics *body = ; //  (optional)

TopicMetadataRelatedOperationsApi *apiInstance = [[TopicMetadataRelatedOperationsApi alloc] init];

// Create topics
[apiInstance createTopicsWith:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetadataRelatedOperationsApi()
var opts = { 
  'body':  // {{NewTopics}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createTopics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createTopicsExample
    {
        public void main()
        {

            var apiInstance = new TopicMetadataRelatedOperationsApi();
            var body = new NewTopics(); // NewTopics |  (optional) 

            try
            {
                // Create topics
                apiInstance.createTopics(body);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetadataRelatedOperationsApi.createTopics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetadataRelatedOperationsApi();
$body = ; // NewTopics | 

try {
    $api_instance->createTopics($body);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetadataRelatedOperationsApi->createTopics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetadataRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetadataRelatedOperationsApi->new();
my $body = WWW::SwaggerClient::Object::NewTopics->new(); # NewTopics | 

eval { 
    $api_instance->createTopics(body => $body);
};
if ($@) {
    warn "Exception when calling TopicMetadataRelatedOperationsApi->createTopics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetadataRelatedOperationsApi()
body =  # NewTopics |  (optional)

try: 
    # Create topics
    api_instance.create_topics(body=body)
except ApiException as e:
    print("Exception when calling TopicMetadataRelatedOperationsApi->createTopics: %s\n" % e)

Parameters

Body parameters
Name Description
body

Responses

Status: default - successful operation


deleteTopics

Delete topics


/api/v1/admin/topics

Usage and SDK Samples

curl -X DELETE\
"//api/v1/admin/topics?topicName="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        array[String] topicName = ; // array[String] | 
        try {
            apiInstance.deleteTopics(topicName);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#deleteTopics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        array[String] topicName = ; // array[String] | 
        try {
            apiInstance.deleteTopics(topicName);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#deleteTopics");
            e.printStackTrace();
        }
    }
}
array[String] *topicName = ; //  (optional)

TopicMetadataRelatedOperationsApi *apiInstance = [[TopicMetadataRelatedOperationsApi alloc] init];

// Delete topics
[apiInstance deleteTopicsWith:topicName
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetadataRelatedOperationsApi()
var opts = { 
  'topicName':  // {{array[String]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteTopics(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteTopicsExample
    {
        public void main()
        {

            var apiInstance = new TopicMetadataRelatedOperationsApi();
            var topicName = new array[String](); // array[String] |  (optional) 

            try
            {
                // Delete topics
                apiInstance.deleteTopics(topicName);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetadataRelatedOperationsApi.deleteTopics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetadataRelatedOperationsApi();
$topicName = ; // array[String] | 

try {
    $api_instance->deleteTopics($topicName);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetadataRelatedOperationsApi->deleteTopics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetadataRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetadataRelatedOperationsApi->new();
my $topicName = []; # array[String] | 

eval { 
    $api_instance->deleteTopics(topicName => $topicName);
};
if ($@) {
    warn "Exception when calling TopicMetadataRelatedOperationsApi->deleteTopics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetadataRelatedOperationsApi()
topicName =  # array[String] |  (optional)

try: 
    # Delete topics
    api_instance.delete_topics(topicName=topicName)
except ApiException as e:
    print("Exception when calling TopicMetadataRelatedOperationsApi->deleteTopics: %s\n" % e)

Parameters

Query parameters
Name Description
topicName
array[String]

Responses

Status: default - successful operation


getTopicDescription

Get respective description about topic with the given `topicName`. This is an experimental endpoint and may be subject to change.


/api/v1/admin/topics/{topicName}/description

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/topics/{topicName}/description"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            TopicDescribeInfo result = apiInstance.getTopicDescription(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#getTopicDescription");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            TopicDescribeInfo result = apiInstance.getTopicDescription(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#getTopicDescription");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 

TopicMetadataRelatedOperationsApi *apiInstance = [[TopicMetadataRelatedOperationsApi alloc] init];

// Get respective description about topic with the given `topicName`. This is an experimental endpoint and may be subject to change.
[apiInstance getTopicDescriptionWith:topicName
              completionHandler: ^(TopicDescribeInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetadataRelatedOperationsApi()
var topicName = topicName_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicDescription(topicName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicDescriptionExample
    {
        public void main()
        {

            var apiInstance = new TopicMetadataRelatedOperationsApi();
            var topicName = topicName_example;  // String | 

            try
            {
                // Get respective description about topic with the given `topicName`. This is an experimental endpoint and may be subject to change.
                TopicDescribeInfo result = apiInstance.getTopicDescription(topicName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetadataRelatedOperationsApi.getTopicDescription: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetadataRelatedOperationsApi();
$topicName = topicName_example; // String | 

try {
    $result = $api_instance->getTopicDescription($topicName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetadataRelatedOperationsApi->getTopicDescription: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetadataRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetadataRelatedOperationsApi->new();
my $topicName = topicName_example; # String | 

eval { 
    my $result = $api_instance->getTopicDescription(topicName => $topicName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicMetadataRelatedOperationsApi->getTopicDescription: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetadataRelatedOperationsApi()
topicName = topicName_example # String | 

try: 
    # Get respective description about topic with the given `topicName`. This is an experimental endpoint and may be subject to change.
    api_response = api_instance.get_topic_description(topicName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicMetadataRelatedOperationsApi->getTopicDescription: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required

Responses

Status: 200 - successful operation


getTopicInfo

Get respective details about topic with the given `topicName`


/api/v1/admin/topics/{topicName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/topics/{topicName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            TopicInfo result = apiInstance.getTopicInfo(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#getTopicInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            TopicInfo result = apiInstance.getTopicInfo(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#getTopicInfo");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 

TopicMetadataRelatedOperationsApi *apiInstance = [[TopicMetadataRelatedOperationsApi alloc] init];

// Get respective details about topic with the given `topicName`
[apiInstance getTopicInfoWith:topicName
              completionHandler: ^(TopicInfo output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetadataRelatedOperationsApi()
var topicName = topicName_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicInfo(topicName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicInfoExample
    {
        public void main()
        {

            var apiInstance = new TopicMetadataRelatedOperationsApi();
            var topicName = topicName_example;  // String | 

            try
            {
                // Get respective details about topic with the given `topicName`
                TopicInfo result = apiInstance.getTopicInfo(topicName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetadataRelatedOperationsApi.getTopicInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetadataRelatedOperationsApi();
$topicName = topicName_example; // String | 

try {
    $result = $api_instance->getTopicInfo($topicName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetadataRelatedOperationsApi->getTopicInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetadataRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetadataRelatedOperationsApi->new();
my $topicName = topicName_example; # String | 

eval { 
    my $result = $api_instance->getTopicInfo(topicName => $topicName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicMetadataRelatedOperationsApi->getTopicInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetadataRelatedOperationsApi()
topicName = topicName_example # String | 

try: 
    # Get respective details about topic with the given `topicName`
    api_response = api_instance.get_topic_info(topicName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicMetadataRelatedOperationsApi->getTopicInfo: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required

Responses

Status: 200 - successful operation


getTopicPartitions

Get respective partitions for the given topic with topicName


/api/v1/admin/topics/{topicName}/partitions

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/topics/{topicName}/partitions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            array[TopicPartitionInfo] result = apiInstance.getTopicPartitions(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#getTopicPartitions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetadataRelatedOperationsApi;

public class TopicMetadataRelatedOperationsApiExample {

    public static void main(String[] args) {
        TopicMetadataRelatedOperationsApi apiInstance = new TopicMetadataRelatedOperationsApi();
        String topicName = topicName_example; // String | 
        try {
            array[TopicPartitionInfo] result = apiInstance.getTopicPartitions(topicName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetadataRelatedOperationsApi#getTopicPartitions");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // 

TopicMetadataRelatedOperationsApi *apiInstance = [[TopicMetadataRelatedOperationsApi alloc] init];

// Get respective partitions for the given topic with topicName
[apiInstance getTopicPartitionsWith:topicName
              completionHandler: ^(array[TopicPartitionInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetadataRelatedOperationsApi()
var topicName = topicName_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicPartitions(topicName, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicPartitionsExample
    {
        public void main()
        {

            var apiInstance = new TopicMetadataRelatedOperationsApi();
            var topicName = topicName_example;  // String | 

            try
            {
                // Get respective partitions for the given topic with topicName
                array[TopicPartitionInfo] result = apiInstance.getTopicPartitions(topicName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetadataRelatedOperationsApi.getTopicPartitions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetadataRelatedOperationsApi();
$topicName = topicName_example; // String | 

try {
    $result = $api_instance->getTopicPartitions($topicName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetadataRelatedOperationsApi->getTopicPartitions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetadataRelatedOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetadataRelatedOperationsApi->new();
my $topicName = topicName_example; # String | 

eval { 
    my $result = $api_instance->getTopicPartitions(topicName => $topicName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicMetadataRelatedOperationsApi->getTopicPartitions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetadataRelatedOperationsApi()
topicName = topicName_example # String | 

try: 
    # Get respective partitions for the given topic with topicName
    api_response = api_instance.get_topic_partitions(topicName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicMetadataRelatedOperationsApi->getTopicPartitions: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Required

Responses

Status: 200 - successful operation


TopicMetricsOperations

getTopicMetrics1

Get topic metrics for the given topic.


/api/v1/admin/metrics/topics/{topicName}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/topics/{topicName}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetricsOperationsApi apiInstance = new TopicMetricsOperationsApi();
        String topicName = topicName_example; // String | Name of the topic
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicMetrics result = apiInstance.getTopicMetrics1(topicName, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetricsOperationsApi#getTopicMetrics1");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetricsOperationsApi;

public class TopicMetricsOperationsApiExample {

    public static void main(String[] args) {
        TopicMetricsOperationsApi apiInstance = new TopicMetricsOperationsApi();
        String topicName = topicName_example; // String | Name of the topic
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicMetrics result = apiInstance.getTopicMetrics1(topicName, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetricsOperationsApi#getTopicMetrics1");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Name of the topic
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

TopicMetricsOperationsApi *apiInstance = [[TopicMetricsOperationsApi alloc] init];

// Get topic metrics for the given topic.
[apiInstance getTopicMetrics1With:topicName
    duration:duration
    from:from
    to:to
              completionHandler: ^(TopicMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetricsOperationsApi()
var topicName = topicName_example; // {{String}} Name of the topic
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicMetrics1(topicName, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicMetrics1Example
    {
        public void main()
        {

            var apiInstance = new TopicMetricsOperationsApi();
            var topicName = topicName_example;  // String | Name of the topic
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get topic metrics for the given topic.
                TopicMetrics result = apiInstance.getTopicMetrics1(topicName, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetricsOperationsApi.getTopicMetrics1: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetricsOperationsApi();
$topicName = topicName_example; // String | Name of the topic
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getTopicMetrics1($topicName, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetricsOperationsApi->getTopicMetrics1: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetricsOperationsApi->new();
my $topicName = topicName_example; # String | Name of the topic
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getTopicMetrics1(topicName => $topicName, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicMetricsOperationsApi->getTopicMetrics1: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetricsOperationsApi()
topicName = topicName_example # String | Name of the topic
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get topic metrics for the given topic.
    api_response = api_instance.get_topic_metrics1(topicName, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicMetricsOperationsApi->getTopicMetrics1: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Name of the topic
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation


getTopicPartitionMetrics

Get topic-partition metrics for the given topic-partition.


/api/v1/admin/metrics/topics/{topicName}/{partitionNum}

Usage and SDK Samples

curl -X GET\
-H "Accept: application/json"\
"//api/v1/admin/metrics/topics/{topicName}/{partitionNum}?duration=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TopicMetricsOperationsApi;

import java.io.File;
import java.util.*;

public class TopicMetricsOperationsApiExample {

    public static void main(String[] args) {
        
        TopicMetricsOperationsApi apiInstance = new TopicMetricsOperationsApi();
        String topicName = topicName_example; // String | Name of the topic
        Integer partitionNum = 56; // Integer | Partition number
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicPartitionMetrics result = apiInstance.getTopicPartitionMetrics(topicName, partitionNum, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetricsOperationsApi#getTopicPartitionMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TopicMetricsOperationsApi;

public class TopicMetricsOperationsApiExample {

    public static void main(String[] args) {
        TopicMetricsOperationsApi apiInstance = new TopicMetricsOperationsApi();
        String topicName = topicName_example; // String | Name of the topic
        Integer partitionNum = 56; // Integer | Partition number
        String duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
        Long from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
        Long to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value
        try {
            TopicPartitionMetrics result = apiInstance.getTopicPartitionMetrics(topicName, partitionNum, duration, from, to);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TopicMetricsOperationsApi#getTopicPartitionMetrics");
            e.printStackTrace();
        }
    }
}
String *topicName = topicName_example; // Name of the topic
Integer *partitionNum = 56; // Partition number
String *duration = duration_example; // Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
Long *from = 789; // Beginning of the time period. Provide '-1' to fetch the latest value (optional)
Long *to = 789; // End of the time period. Provide '-1' to fetch the latest value (optional)

TopicMetricsOperationsApi *apiInstance = [[TopicMetricsOperationsApi alloc] init];

// Get topic-partition metrics for the given topic-partition.
[apiInstance getTopicPartitionMetricsWith:topicName
    partitionNum:partitionNum
    duration:duration
    from:from
    to:to
              completionHandler: ^(TopicPartitionMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var SwaggerJsClient = require('swagger-js-client');

var api = new SwaggerJsClient.TopicMetricsOperationsApi()
var topicName = topicName_example; // {{String}} Name of the topic
var partitionNum = 56; // {{Integer}} Partition number
var opts = { 
  'duration': duration_example, // {{String}} Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
  'from': 789, // {{Long}} Beginning of the time period. Provide '-1' to fetch the latest value
  'to': 789 // {{Long}} End of the time period. Provide '-1' to fetch the latest value
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTopicPartitionMetrics(topicName, partitionNum, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTopicPartitionMetricsExample
    {
        public void main()
        {

            var apiInstance = new TopicMetricsOperationsApi();
            var topicName = topicName_example;  // String | Name of the topic
            var partitionNum = 56;  // Integer | Partition number
            var duration = duration_example;  // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional) 
            var from = 789;  // Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional) 
            var to = 789;  // Long | End of the time period. Provide '-1' to fetch the latest value (optional) 

            try
            {
                // Get topic-partition metrics for the given topic-partition.
                TopicPartitionMetrics result = apiInstance.getTopicPartitionMetrics(topicName, partitionNum, duration, from, to);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TopicMetricsOperationsApi.getTopicPartitionMetrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiTopicMetricsOperationsApi();
$topicName = topicName_example; // String | Name of the topic
$partitionNum = 56; // Integer | Partition number
$duration = duration_example; // String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
$from = 789; // Long | Beginning of the time period. Provide '-1' to fetch the latest value
$to = 789; // Long | End of the time period. Provide '-1' to fetch the latest value

try {
    $result = $api_instance->getTopicPartitionMetrics($topicName, $partitionNum, $duration, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TopicMetricsOperationsApi->getTopicPartitionMetrics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TopicMetricsOperationsApi;

my $api_instance = WWW::SwaggerClient::TopicMetricsOperationsApi->new();
my $topicName = topicName_example; # String | Name of the topic
my $partitionNum = 56; # Integer | Partition number
my $duration = duration_example; # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
my $from = 789; # Long | Beginning of the time period. Provide '-1' to fetch the latest value
my $to = 789; # Long | End of the time period. Provide '-1' to fetch the latest value

eval { 
    my $result = $api_instance->getTopicPartitionMetrics(topicName => $topicName, partitionNum => $partitionNum, duration => $duration, from => $from, to => $to);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TopicMetricsOperationsApi->getTopicPartitionMetrics: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.TopicMetricsOperationsApi()
topicName = topicName_example # String | Name of the topic
partitionNum = 56 # Integer | Partition number
duration = duration_example # String | Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params (optional)
from = 789 # Long | Beginning of the time period. Provide '-1' to fetch the latest value (optional)
to = 789 # Long | End of the time period. Provide '-1' to fetch the latest value (optional)

try: 
    # Get topic-partition metrics for the given topic-partition.
    api_response = api_instance.get_topic_partition_metrics(topicName, partitionNum, duration=duration, from=from, to=to)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TopicMetricsOperationsApi->getTopicPartitionMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
topicName*
String
Name of the topic
Required
partitionNum*
Integer (int32)
Partition number
Required
Query parameters
Name Description
duration
String
Pre-defined Time duration. Supply either 'duration' [OR] 'from' & 'to' params
from
Long (int64)
Beginning of the time period. Provide '-1' to fetch the latest value
to
Long (int64)
End of the time period. Provide '-1' to fetch the latest value

Responses

Status: 200 - successful operation