Package-level declarations

Types

data class AzureBlobStorageSinkConnectorServiceInfoResponse(val connectorServiceType: String, val storageAccountKey: String? = null, val storageAccountName: String? = null, val storageContainerName: String? = null)

The authentication info when auth_type is azureBlobStorageSinkConnector

data class AzureBlobStorageSourceConnectorServiceInfoResponse(val connectorServiceType: String, val storageAccountKey: String? = null, val storageAccountName: String? = null, val storageContainerName: String? = null)

The connector service type is AzureBlobStorageSourceConnector

data class AzureCosmosDBSinkConnectorServiceInfoResponse(val connectorServiceType: String, val cosmosConnectionEndpoint: String? = null, val cosmosContainersTopicMapping: String? = null, val cosmosDatabaseName: String? = null, val cosmosIdStrategy: String? = null, val cosmosMasterKey: String? = null)

The authentication info when auth_type is AzureCosmosDBSinkConnector

data class AzureCosmosDBSourceConnectorServiceInfoResponse(val connectorServiceType: String, val cosmosConnectionEndpoint: String? = null, val cosmosContainersTopicMapping: String? = null, val cosmosDatabaseName: String? = null, val cosmosMasterKey: String? = null, val cosmosMessageKeyEnabled: Boolean? = null, val cosmosMessageKeyField: String? = null)

The authentication info when auth_type is AzureCosmosDBSourceConnector

data class AzureSynapseAnalyticsSinkConnectorServiceInfoResponse(val connectorServiceType: String, val synapseSqlDatabaseName: String? = null, val synapseSqlPassword: String? = null, val synapseSqlServerName: String? = null, val synapseSqlUser: String? = null)

The authentication info when auth_type is AzureSynapseAnalyticsSinkConnector

Link copied to clipboard
data class ClusterByokEntityResponse(val id: String? = null, val related: String? = null, val resourceName: String? = null)

The network associated with this object

Link copied to clipboard
data class ClusterConfigEntityResponse(val kind: String? = null)

The configuration of the Kafka cluster

Link copied to clipboard
data class ClusterEnvironmentEntityResponse(val environment: String? = null, val id: String? = null, val related: String? = null, val resourceName: String? = null)

The environment to which cluster belongs

Link copied to clipboard
data class ClusterNetworkEntityResponse(val environment: String? = null, val id: String? = null, val related: String? = null, val resourceName: String? = null)

The network associated with this object

Link copied to clipboard
data class ClusterRecordResponse(val displayName: String? = null, val id: String? = null, val kind: String? = null, val metadata: MetadataEntityResponse? = null, val spec: ClusterSpecEntityResponse? = null, val status: ClusterStatusEntityResponse? = null)

Record of the environment

Link copied to clipboard
data class ClusterSpecEntityResponse(val apiEndpoint: String? = null, val availability: String? = null, val byok: ClusterByokEntityResponse? = null, val cloud: String? = null, val config: ClusterConfigEntityResponse? = null, val displayName: String? = null, val environment: ClusterEnvironmentEntityResponse? = null, val httpEndpoint: String? = null, val kafkaBootstrapEndpoint: String? = null, val network: ClusterNetworkEntityResponse? = null, val region: String? = null, val zone: String? = null)

Spec of the cluster record

Link copied to clipboard
data class ClusterStatusEntityResponse(val cku: Int? = null, val phase: String? = null)

Status of the cluster record

Link copied to clipboard
data class ConfluentListMetadataResponse(val first: String? = null, val last: String? = null, val next: String? = null, val prev: String? = null, val totalSize: Int? = null)

Metadata of the list

Link copied to clipboard
data class ConnectorInfoBaseResponse(val connectorClass: String? = null, val connectorId: String? = null, val connectorName: String? = null, val connectorState: String? = null, val connectorType: String? = null)

Connector Info Base properties

Link copied to clipboard
data class EnvironmentRecordResponse(val displayName: String? = null, val id: String? = null, val kind: String? = null, val metadata: MetadataEntityResponse? = null)

Record of the environment

Link copied to clipboard
data class GetConnectorResult(val connectorBasicInfo: ConnectorInfoBaseResponse? = null, val connectorServiceTypeInfo: Any? = null, val id: String, val name: String, val partnerConnectorInfo: Any? = null, val systemData: SystemDataResponse, val type: String)

Details of connector record

Link copied to clipboard
data class GetOrganizationClusterByIdResult(val id: String? = null, val kind: String? = null, val metadata: SCMetadataEntityResponse? = null, val name: String? = null, val spec: SCClusterSpecEntityResponse? = null, val status: ClusterStatusEntityResponse? = null, val type: String? = null)

Details of cluster record

Link copied to clipboard
data class GetOrganizationEnvironmentByIdResult(val id: String? = null, val kind: String? = null, val metadata: SCMetadataEntityResponse? = null, val name: String? = null, val streamGovernanceConfig: StreamGovernanceConfigResponse? = null, val type: String? = null)

Details about environment name, metadata and environment id of an environment

Link copied to clipboard
data class GetOrganizationResult(val createdTime: String, val id: String, val location: String? = null, val name: String, val offerDetail: OfferDetailResponse, val organizationId: String, val provisioningState: String, val ssoUrl: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val userDetail: UserDetailResponse)

Organization resource.

Link copied to clipboard
data class GetTopicResult(val configs: TopicsRelatedLinkResponse? = null, val id: String, val inputConfigs: List<TopicsInputConfigResponse>? = null, val kind: String? = null, val metadata: TopicMetadataEntityResponse? = null, val name: String, val partitions: TopicsRelatedLinkResponse? = null, val partitionsCount: String? = null, val partitionsReassignments: TopicsRelatedLinkResponse? = null, val replicationFactor: String? = null, val topicId: String? = null, val type: String)

Details of topic record

Link copied to clipboard
data class InvitationRecordResponse(val acceptedAt: String? = null, val authType: String? = null, val email: String? = null, val expiresAt: String? = null, val id: String? = null, val kind: String? = null, val metadata: MetadataEntityResponse? = null, val status: String? = null)

Record of the invitation

data class KafkaAzureBlobStorageSinkConnectorInfoResponse(val apiKey: String? = null, val apiSecret: String? = null, val authType: String? = null, val flushSize: String? = null, val inputFormat: String? = null, val maxTasks: String? = null, val outputFormat: String? = null, val partnerConnectorType: String, val serviceAccountId: String? = null, val timeInterval: String? = null, val topics: List<String>? = null, val topicsDir: String? = null)

The partner connector type is KafkaAzureBlobStorageSink

data class KafkaAzureBlobStorageSourceConnectorInfoResponse(val apiKey: String? = null, val apiSecret: String? = null, val authType: String? = null, val inputFormat: String? = null, val maxTasks: String? = null, val outputFormat: String? = null, val partnerConnectorType: String, val serviceAccountId: String? = null, val topicRegex: String? = null, val topicsDir: String? = null)

The partner connector type is KafkaAzureBlobStorageSource

data class KafkaAzureCosmosDBSinkConnectorInfoResponse(val apiKey: String? = null, val apiSecret: String? = null, val authType: String? = null, val flushSize: String? = null, val inputFormat: String? = null, val maxTasks: String? = null, val outputFormat: String? = null, val partnerConnectorType: String, val serviceAccountId: String? = null, val timeInterval: String? = null, val topics: List<String>? = null, val topicsDir: String? = null)

The partner connector type is KafkaAzureCosmosDBSink

data class KafkaAzureCosmosDBSourceConnectorInfoResponse(val apiKey: String? = null, val apiSecret: String? = null, val authType: String? = null, val inputFormat: String? = null, val maxTasks: String? = null, val outputFormat: String? = null, val partnerConnectorType: String, val serviceAccountId: String? = null, val topicRegex: String? = null, val topicsDir: String? = null)

The partner connector type is KafkaAzureCosmosDBSource

data class KafkaAzureSynapseAnalyticsSinkConnectorInfoResponse(val apiKey: String? = null, val apiSecret: String? = null, val authType: String? = null, val flushSize: String? = null, val inputFormat: String? = null, val maxTasks: String? = null, val outputFormat: String? = null, val partnerConnectorType: String, val serviceAccountId: String? = null, val timeInterval: String? = null, val topics: List<String>? = null, val topicsDir: String? = null)

The partner connector type is KafkaAzureSynapseAnalyticsSink

Link copied to clipboard
data class ListAccessClustersResult(val data: List<ClusterRecordResponse>? = null, val kind: String? = null, val metadata: ConfluentListMetadataResponse? = null)

List cluster success response

Link copied to clipboard
data class ListAccessEnvironmentsResult(val data: List<EnvironmentRecordResponse>? = null, val kind: String? = null, val metadata: ConfluentListMetadataResponse? = null)

List environments success response

Link copied to clipboard
data class ListAccessInvitationsResult(val data: List<InvitationRecordResponse>? = null, val kind: String? = null, val metadata: ConfluentListMetadataResponse? = null)

List invitations success response

Link copied to clipboard
data class ListAccessRoleBindingNameResult(val data: List<String>? = null, val kind: String? = null, val metadata: ConfluentListMetadataResponse? = null)

Details of the role binding names returned on successful response

Link copied to clipboard
data class ListAccessRoleBindingsResult(val data: List<RoleBindingRecordResponse>? = null, val kind: String? = null, val metadata: ConfluentListMetadataResponse? = null)

List cluster success response

Link copied to clipboard
data class ListAccessServiceAccountsResult(val data: List<ServiceAccountRecordResponse>? = null, val kind: String? = null, val metadata: ConfluentListMetadataResponse? = null)

List service accounts success response

Link copied to clipboard
data class ListAccessUsersResult(val data: List<UserRecordResponse>? = null, val kind: String? = null, val metadata: ConfluentListMetadataResponse? = null)

List users success response

Link copied to clipboard

Result of POST request to list regions supported by confluent

Link copied to clipboard
data class MetadataEntityResponse(val createdAt: String? = null, val deletedAt: String? = null, val resourceName: String? = null, val self: String? = null, val updatedAt: String? = null)

Metadata of the data record

Link copied to clipboard
data class OfferDetailResponse(val id: String, val planId: String, val planName: String, val publisherId: String, val status: String, val termUnit: String)

Confluent Offer detail

Link copied to clipboard
data class RegionRecordResponse(val id: String? = null, val kind: String? = null, val metadata: SCMetadataEntityResponse? = null, val spec: RegionSpecEntityResponse? = null)

Details of region record

Link copied to clipboard
data class RegionSpecEntityResponse(val cloud: String? = null, val name: String? = null, val packages: List<String>? = null, val regionName: String? = null)

Region spec details

Link copied to clipboard
data class RoleBindingRecordResponse(val crnPattern: String? = null, val id: String? = null, val kind: String? = null, val metadata: MetadataEntityResponse? = null, val principal: String? = null, val roleName: String? = null)

Record of the environment

Link copied to clipboard
data class SCClusterByokEntityResponse(val id: String? = null, val related: String? = null, val resourceName: String? = null)

The network associated with this object

data class SCClusterNetworkEnvironmentEntityResponse(val environment: String? = null, val id: String? = null, val related: String? = null, val resourceName: String? = null)

The environment or the network to which cluster belongs

Link copied to clipboard
data class SCClusterSpecEntityResponse(val apiEndpoint: String? = null, val availability: String? = null, val byok: SCClusterByokEntityResponse? = null, val cloud: String? = null, val config: ClusterConfigEntityResponse? = null, val environment: SCClusterNetworkEnvironmentEntityResponse? = null, val httpEndpoint: String? = null, val kafkaBootstrapEndpoint: String? = null, val name: String? = null, val network: SCClusterNetworkEnvironmentEntityResponse? = null, val package: String? = null, val region: String? = null, val zone: String? = null)

Spec of the cluster record

Link copied to clipboard
data class SCMetadataEntityResponse(val createdTimestamp: String? = null, val deletedTimestamp: String? = null, val resourceName: String? = null, val self: String? = null, val updatedTimestamp: String? = null)

Metadata of the data record

Link copied to clipboard
data class ServiceAccountRecordResponse(val description: String? = null, val displayName: String? = null, val id: String? = null, val kind: String? = null, val metadata: MetadataEntityResponse? = null)

Record of the service account

Link copied to clipboard
data class StreamGovernanceConfigResponse(val package: String? = null)

Stream governance configuration

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TopicMetadataEntityResponse(val resourceName: String? = null, val self: String? = null)

Metadata of the data record

Link copied to clipboard
data class TopicsInputConfigResponse(val name: String? = null, val value: String? = null)

Topics input config

Link copied to clipboard
data class TopicsRelatedLinkResponse(val related: String? = null)

Partition Config spec of the topic record

Link copied to clipboard
data class UserDetailResponse(val emailAddress: String, val firstName: String? = null, val lastName: String? = null)

Subscriber detail

Link copied to clipboard
data class UserRecordResponse(val authType: String? = null, val email: String? = null, val fullName: String? = null, val id: String? = null, val kind: String? = null, val metadata: MetadataEntityResponse? = null)

Record of the user