# Models

## The ClusterReadList object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"ClusterReadList":{"allOf":[{"type":"object","required":["id","type","href"],"properties":{"id":{"description":"ID of the list of Cluster resources.","type":"string","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["collection"]},"href":{"description":"The URL of the list of Cluster resources.","type":"string"},"items":{"description":"The list of Cluster resources.","type":"array","items":{"$ref":"#/components/schemas/ClusterRead"}}}}]},"ClusterRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Cluster.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["cluster"]},"href":{"description":"The URL of the Cluster.","type":"string"},"metadata":{"$ref":"#/components/schemas/ClusterMetadata"},"properties":{"$ref":"#/components/schemas/Cluster"}}},"ClusterMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","properties":{"brokerAddresses":{"type":"array","description":"IP addresses and ports of cluster brokers.","items":{"type":"string","description":"IP address and port of cluster broker."}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"},"Cluster":{"type":"object","description":"A Kafka cluster that stores data and serve client requests.\nKafka clusters typically have multiple brokers to handle more data\nand provide high availability. Each broker is identified by a unique\nID and manages partitions of different topics.\n","required":["name","version","size","connections"],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/KafkaClusterName"},"version":{"$ref":"#/components/schemas/KafkaVersion"},"size":{"$ref":"#/components/schemas/KafkaClusterSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/KafkaClusterConnection"}}}},"KafkaClusterName":{"type":"string","description":"The name of your Kafka cluster.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63},"KafkaVersion":{"type":"string","pattern":"^(3.9.0|3.9.1)$","maxLength":32,"description":"The version of Kafka. Allowed values are `3.9.0` and `3.9.1`.\n"},"KafkaClusterSize":{"type":"string","description":"The size of your Kafka cluster.\nThe size of the Kafka cluster is given in T-shirt sizes. Valid values are: `XS`, `S`, `M`, `L`, and `XL`.\n","pattern":"^(XS|S|M|L|XL)$"},"KafkaClusterConnection":{"description":"Connection information of the Kafka cluster.\n","type":"object","required":["datacenterId","lanId","brokerAddresses"],"properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"brokerAddresses":{"type":"array","description":"IP addresses and subnet of cluster brokers.\nNote the following unavailable IP range:\n10.224.0.0/11\n","items":{"$ref":"#/components/schemas/KafkaClusterBrokerIp"}}}},"KafkaClusterBrokerIp":{"type":"string","description":"The IP and subnet for a cluster broker.\nNote the following unavailable IP range:\n10.224.0.0/11\n"}}}}
```

## The ClusterRead object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"ClusterRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Cluster.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["cluster"]},"href":{"description":"The URL of the Cluster.","type":"string"},"metadata":{"$ref":"#/components/schemas/ClusterMetadata"},"properties":{"$ref":"#/components/schemas/Cluster"}}},"ClusterMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","properties":{"brokerAddresses":{"type":"array","description":"IP addresses and ports of cluster brokers.","items":{"type":"string","description":"IP address and port of cluster broker."}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"},"Cluster":{"type":"object","description":"A Kafka cluster that stores data and serve client requests.\nKafka clusters typically have multiple brokers to handle more data\nand provide high availability. Each broker is identified by a unique\nID and manages partitions of different topics.\n","required":["name","version","size","connections"],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/KafkaClusterName"},"version":{"$ref":"#/components/schemas/KafkaVersion"},"size":{"$ref":"#/components/schemas/KafkaClusterSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/KafkaClusterConnection"}}}},"KafkaClusterName":{"type":"string","description":"The name of your Kafka cluster.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63},"KafkaVersion":{"type":"string","pattern":"^(3.9.0|3.9.1)$","maxLength":32,"description":"The version of Kafka. Allowed values are `3.9.0` and `3.9.1`.\n"},"KafkaClusterSize":{"type":"string","description":"The size of your Kafka cluster.\nThe size of the Kafka cluster is given in T-shirt sizes. Valid values are: `XS`, `S`, `M`, `L`, and `XL`.\n","pattern":"^(XS|S|M|L|XL)$"},"KafkaClusterConnection":{"description":"Connection information of the Kafka cluster.\n","type":"object","required":["datacenterId","lanId","brokerAddresses"],"properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"brokerAddresses":{"type":"array","description":"IP addresses and subnet of cluster brokers.\nNote the following unavailable IP range:\n10.224.0.0/11\n","items":{"$ref":"#/components/schemas/KafkaClusterBrokerIp"}}}},"KafkaClusterBrokerIp":{"type":"string","description":"The IP and subnet for a cluster broker.\nNote the following unavailable IP range:\n10.224.0.0/11\n"}}}}
```

## The ClusterCreate object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"ClusterCreate":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/Cluster"}}},"Cluster":{"type":"object","description":"A Kafka cluster that stores data and serve client requests.\nKafka clusters typically have multiple brokers to handle more data\nand provide high availability. Each broker is identified by a unique\nID and manages partitions of different topics.\n","required":["name","version","size","connections"],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/KafkaClusterName"},"version":{"$ref":"#/components/schemas/KafkaVersion"},"size":{"$ref":"#/components/schemas/KafkaClusterSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/KafkaClusterConnection"}}}},"KafkaClusterName":{"type":"string","description":"The name of your Kafka cluster.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63},"KafkaVersion":{"type":"string","pattern":"^(3.9.0|3.9.1)$","maxLength":32,"description":"The version of Kafka. Allowed values are `3.9.0` and `3.9.1`.\n"},"KafkaClusterSize":{"type":"string","description":"The size of your Kafka cluster.\nThe size of the Kafka cluster is given in T-shirt sizes. Valid values are: `XS`, `S`, `M`, `L`, and `XL`.\n","pattern":"^(XS|S|M|L|XL)$"},"KafkaClusterConnection":{"description":"Connection information of the Kafka cluster.\n","type":"object","required":["datacenterId","lanId","brokerAddresses"],"properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"brokerAddresses":{"type":"array","description":"IP addresses and subnet of cluster brokers.\nNote the following unavailable IP range:\n10.224.0.0/11\n","items":{"$ref":"#/components/schemas/KafkaClusterBrokerIp"}}}},"KafkaClusterBrokerIp":{"type":"string","description":"The IP and subnet for a cluster broker.\nNote the following unavailable IP range:\n10.224.0.0/11\n"}}}}
```

## The TopicReadList object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"TopicReadList":{"allOf":[{"type":"object","required":["id","type","href"],"properties":{"id":{"description":"ID of the list of Topic resources.","type":"string","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["collection"]},"href":{"description":"The URL of the list of Topic resources.","type":"string"},"items":{"description":"The list of Topic resources.","type":"array","items":{"$ref":"#/components/schemas/TopicRead"}}}}]},"TopicRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Topic.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["topic"]},"href":{"description":"The URL of the Topic.","type":"string"},"metadata":{"$ref":"#/components/schemas/ResourceMetadata"},"properties":{"$ref":"#/components/schemas/Topic"}}},"ResourceMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"},"Topic":{"type":"object","description":"A topic is a category or feed name to which records are\npublished. Topics are the way Kafka organizes messages. They act as logical\nchannels for data streams. Topics are split into partitions, making them\nscalable and allowing parallelism.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Kafka cluster topic.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63},"replicationFactor":{"type":"integer","description":"The number of replicas of the topic. The replication factor\ndetermines how many copies of the topic are stored on different\nbrokers. The replication factor must be less than or equal to the\nnumber of brokers in the Kafka cluster.\n","minimum":1,"default":3},"numberOfPartitions":{"type":"integer","description":"The number of partitions of the topic. Partitions allow for parallel processing of messages.\n","minimum":1,"default":3},"logRetention":{"type":"object","properties":{"retentionTime":{"type":"integer","description":"This configuration controls the maximum time we will retain a log before we will discard old log\n segments to free up space.\n This represents an SLA on how soon consumers must read their data. If set to -1,\n no time limit is applied.\n","default":604800000},"segmentBytes":{"type":"integer","description":"This configuration controls the segment file size for the log. Retention and cleaning is always done\na file at a time so a larger segment size means fewer files but less granular control over retention.\n","default":1073741824}}}}}}}}
```

## The TopicRead object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"TopicRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the Topic.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["topic"]},"href":{"description":"The URL of the Topic.","type":"string"},"metadata":{"$ref":"#/components/schemas/ResourceMetadata"},"properties":{"$ref":"#/components/schemas/Topic"}}},"ResourceMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"},"Topic":{"type":"object","description":"A topic is a category or feed name to which records are\npublished. Topics are the way Kafka organizes messages. They act as logical\nchannels for data streams. Topics are split into partitions, making them\nscalable and allowing parallelism.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Kafka cluster topic.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63},"replicationFactor":{"type":"integer","description":"The number of replicas of the topic. The replication factor\ndetermines how many copies of the topic are stored on different\nbrokers. The replication factor must be less than or equal to the\nnumber of brokers in the Kafka cluster.\n","minimum":1,"default":3},"numberOfPartitions":{"type":"integer","description":"The number of partitions of the topic. Partitions allow for parallel processing of messages.\n","minimum":1,"default":3},"logRetention":{"type":"object","properties":{"retentionTime":{"type":"integer","description":"This configuration controls the maximum time we will retain a log before we will discard old log\n segments to free up space.\n This represents an SLA on how soon consumers must read their data. If set to -1,\n no time limit is applied.\n","default":604800000},"segmentBytes":{"type":"integer","description":"This configuration controls the segment file size for the log. Retention and cleaning is always done\na file at a time so a larger segment size means fewer files but less granular control over retention.\n","default":1073741824}}}}}}}}
```

## The TopicCreate object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"TopicCreate":{"type":"object","required":["properties"],"properties":{"properties":{"$ref":"#/components/schemas/Topic"}}},"Topic":{"type":"object","description":"A topic is a category or feed name to which records are\npublished. Topics are the way Kafka organizes messages. They act as logical\nchannels for data streams. Topics are split into partitions, making them\nscalable and allowing parallelism.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Kafka cluster topic.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63},"replicationFactor":{"type":"integer","description":"The number of replicas of the topic. The replication factor\ndetermines how many copies of the topic are stored on different\nbrokers. The replication factor must be less than or equal to the\nnumber of brokers in the Kafka cluster.\n","minimum":1,"default":3},"numberOfPartitions":{"type":"integer","description":"The number of partitions of the topic. Partitions allow for parallel processing of messages.\n","minimum":1,"default":3},"logRetention":{"type":"object","properties":{"retentionTime":{"type":"integer","description":"This configuration controls the maximum time we will retain a log before we will discard old log\n segments to free up space.\n This represents an SLA on how soon consumers must read their data. If set to -1,\n no time limit is applied.\n","default":604800000},"segmentBytes":{"type":"integer","description":"This configuration controls the segment file size for the log. Retention and cleaning is always done\na file at a time so a larger segment size means fewer files but less granular control over retention.\n","default":1073741824}}}}}}}}
```

## The UserReadList object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"UserReadList":{"allOf":[{"type":"object","required":["id","type","href"],"properties":{"id":{"description":"ID of the list of User resources.","type":"string","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["collection"]},"href":{"description":"The URL of the list of User resources.","type":"string"},"items":{"description":"The list of User resources.","type":"array","items":{"$ref":"#/components/schemas/UserRead"}}}}]},"UserRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the User.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["user"]},"href":{"description":"The URL of the User.","type":"string"},"metadata":{"$ref":"#/components/schemas/ResourceMetadata"},"properties":{"$ref":"#/components/schemas/User"}}},"ResourceMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"},"User":{"type":"object","description":"The user of the cluster. Access is managed by certificates. The certificates are\nretrieved by the access endpoint.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Kafka cluster user.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63}}}}}}
```

## The UserRead object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"UserRead":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the User.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["user"]},"href":{"description":"The URL of the User.","type":"string"},"metadata":{"$ref":"#/components/schemas/ResourceMetadata"},"properties":{"$ref":"#/components/schemas/User"}}},"ResourceMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"},"User":{"type":"object","description":"The user of the cluster. Access is managed by certificates. The certificates are\nretrieved by the access endpoint.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Kafka cluster user.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63}}}}}}
```

## The Cluster object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"Cluster":{"type":"object","description":"A Kafka cluster that stores data and serve client requests.\nKafka clusters typically have multiple brokers to handle more data\nand provide high availability. Each broker is identified by a unique\nID and manages partitions of different topics.\n","required":["name","version","size","connections"],"additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/KafkaClusterName"},"version":{"$ref":"#/components/schemas/KafkaVersion"},"size":{"$ref":"#/components/schemas/KafkaClusterSize"},"connections":{"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/KafkaClusterConnection"}}}},"KafkaClusterName":{"type":"string","description":"The name of your Kafka cluster.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63},"KafkaVersion":{"type":"string","pattern":"^(3.9.0|3.9.1)$","maxLength":32,"description":"The version of Kafka. Allowed values are `3.9.0` and `3.9.1`.\n"},"KafkaClusterSize":{"type":"string","description":"The size of your Kafka cluster.\nThe size of the Kafka cluster is given in T-shirt sizes. Valid values are: `XS`, `S`, `M`, `L`, and `XL`.\n","pattern":"^(XS|S|M|L|XL)$"},"KafkaClusterConnection":{"description":"Connection information of the Kafka cluster.\n","type":"object","required":["datacenterId","lanId","brokerAddresses"],"properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"brokerAddresses":{"type":"array","description":"IP addresses and subnet of cluster brokers.\nNote the following unavailable IP range:\n10.224.0.0/11\n","items":{"$ref":"#/components/schemas/KafkaClusterBrokerIp"}}}},"KafkaClusterBrokerIp":{"type":"string","description":"The IP and subnet for a cluster broker.\nNote the following unavailable IP range:\n10.224.0.0/11\n"}}}}
```

## The KafkaClusterName object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"KafkaClusterName":{"type":"string","description":"The name of your Kafka cluster.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63}}}}
```

## The KafkaClusterSize object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"KafkaClusterSize":{"type":"string","description":"The size of your Kafka cluster.\nThe size of the Kafka cluster is given in T-shirt sizes. Valid values are: `XS`, `S`, `M`, `L`, and `XL`.\n","pattern":"^(XS|S|M|L|XL)$"}}}}
```

## The KafkaVersion object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"KafkaVersion":{"type":"string","pattern":"^(3.9.0|3.9.1)$","maxLength":32,"description":"The version of Kafka. Allowed values are `3.9.0` and `3.9.1`.\n"}}}}
```

## The ResourceMetadata object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"ResourceMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"}}}}
```

## The ClusterMetadata object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"ClusterMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"},{"type":"object","properties":{"brokerAddresses":{"type":"array","description":"IP addresses and ports of cluster brokers.","items":{"type":"string","description":"IP address and port of cluster broker."}}}}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"}}}}
```

## The KafkaClusterConnection object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"KafkaClusterConnection":{"description":"Connection information of the Kafka cluster.\n","type":"object","required":["datacenterId","lanId","brokerAddresses"],"properties":{"datacenterId":{"description":"The datacenter to connect your instance to.","type":"string"},"lanId":{"description":"The numeric LAN ID to connect your instance to.","type":"string"},"brokerAddresses":{"type":"array","description":"IP addresses and subnet of cluster brokers.\nNote the following unavailable IP range:\n10.224.0.0/11\n","items":{"$ref":"#/components/schemas/KafkaClusterBrokerIp"}}}},"KafkaClusterBrokerIp":{"type":"string","description":"The IP and subnet for a cluster broker.\nNote the following unavailable IP range:\n10.224.0.0/11\n"}}}}
```

## The KafkaClusterBrokerIp object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"KafkaClusterBrokerIp":{"type":"string","description":"The IP and subnet for a cluster broker.\nNote the following unavailable IP range:\n10.224.0.0/11\n"}}}}
```

## The User object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"User":{"type":"object","description":"The user of the cluster. Access is managed by certificates. The certificates are\nretrieved by the access endpoint.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Kafka cluster user.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63}}}}}}
```

## The UserReadAccess object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"UserReadAccess":{"type":"object","required":["id","type","href","metadata","properties"],"properties":{"id":{"type":"string","description":"The ID (UUID) of the user.","format":"uuid"},"type":{"description":"The type of the resource.","type":"string","enum":["user"]},"href":{"description":"The URL of the user.","type":"string"},"metadata":{"$ref":"#/components/schemas/UserAccessMetadata"},"properties":{"$ref":"#/components/schemas/User"}}},"UserAccessMetadata":{"allOf":[{"$ref":"#/components/schemas/ResourceMetadata"},{"type":"object","additionalProperties":false,"properties":{"certificateAuthority":{"type":"string","description":"PEM for the certificate authority."},"privateKey":{"type":"string","description":"PEM for the private key."},"certificate":{"type":"string","description":"PEM for the certificate."}}}]},"ResourceMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"},"User":{"type":"object","description":"The user of the cluster. Access is managed by certificates. The certificates are\nretrieved by the access endpoint.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Kafka cluster user.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63}}}}}}
```

## The UserAccessMetadata object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"UserAccessMetadata":{"allOf":[{"$ref":"#/components/schemas/ResourceMetadata"},{"type":"object","additionalProperties":false,"properties":{"certificateAuthority":{"type":"string","description":"PEM for the certificate authority."},"privateKey":{"type":"string","description":"PEM for the private key."},"certificate":{"type":"string","description":"PEM for the certificate."}}}]},"ResourceMetadata":{"allOf":[{"$ref":"#/components/schemas/Metadata"},{"$ref":"#/components/schemas/ResourceState"}]},"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}},"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"}}}}
```

## The Topic object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"Topic":{"type":"object","description":"A topic is a category or feed name to which records are\npublished. Topics are the way Kafka organizes messages. They act as logical\nchannels for data streams. Topics are split into partitions, making them\nscalable and allowing parallelism.\n","required":["name"],"properties":{"name":{"type":"string","description":"The name of the Kafka cluster topic.\nMust be 63 characters or less and must begin and end with an alphanumeric character (`[a-z0-9A-Z]`)\nwith dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.\n","pattern":"^[A-Za-z0-9][-A-Za-z0-9_.]*[A-Za-z0-9]$","minLength":2,"maxLength":63},"replicationFactor":{"type":"integer","description":"The number of replicas of the topic. The replication factor\ndetermines how many copies of the topic are stored on different\nbrokers. The replication factor must be less than or equal to the\nnumber of brokers in the Kafka cluster.\n","minimum":1,"default":3},"numberOfPartitions":{"type":"integer","description":"The number of partitions of the topic. Partitions allow for parallel processing of messages.\n","minimum":1,"default":3},"logRetention":{"type":"object","properties":{"retentionTime":{"type":"integer","description":"This configuration controls the maximum time we will retain a log before we will discard old log\n segments to free up space.\n This represents an SLA on how soon consumers must read their data. If set to -1,\n no time limit is applied.\n","default":604800000},"segmentBytes":{"type":"integer","description":"This configuration controls the segment file size for the log. Retention and cleaning is always done\na file at a time so a larger segment size means fewer files but less granular control over retention.\n","default":1073741824}}}}}}}}
```

## The ResourceState object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"ResourceState":{"type":"object","description":"The current status of the resource.","required":["state"],"properties":{"state":{"$ref":"#/components/schemas/State"},"message":{"type":"string","description":"A human readable message describing the current state.\nIn case of an error, the message will contain a detailed error message.\n"}}},"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"}}}}
```

## The State object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"State":{"type":"string","description":"State of the resource. Resource states:\n`AVAILABLE`: There are no pending modification requests for this item.\n`BUSY`: There is at least one modification request pending and all following requests will be queued.\n`DEPLOYING`: The resource is being created.\n`FAILED`: The creation of the resource failed.\n`UPDATING`: The resource is being updated.\n`FAILED_UPDATING`: An update to the resource was not successful.\n`DESTROYING`: A delete command was issued, and the resource is being deleted.\n"}}}}
```

## The Error object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"Error":{"description":"The Error object is used to represent an error response from the API.\n","type":"object","properties":{"httpStatus":{"type":"integer","description":"The HTTP status code of the operation."},"messages":{"type":"array","description":"A list of error messages.\n","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Application internal error code\n"},"message":{"type":"string","description":"A human readable explanation specific to this occurrence of the\nproblem.\n"}}}}}}}}}
```

## The Metadata object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"Metadata":{"type":"object","description":"Metadata of the resource.","properties":{"createdDate":{"type":"string","format":"date-time","description":"The ISO 8601 creation timestamp.","readOnly":true},"createdBy":{"type":"string","description":"Unique name of the identity that created the resource.","readOnly":true},"createdByUserId":{"type":"string","description":"Unique id of the identity that created the resource.","readOnly":true},"lastModifiedDate":{"type":"string","format":"date-time","description":"The ISO 8601 modified timestamp.","readOnly":true},"lastModifiedBy":{"type":"string","description":"Unique name of the identity that last modified the resource.","readOnly":true},"lastModifiedByUserId":{"type":"string","description":"Unique id of the identity that last modified the resource.","readOnly":true},"resourceURN":{"type":"string","description":"Unique name of the resource.","readOnly":true}}}}}}
```

## The Pagination object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"Pagination":{"required":["offset","limit","_links"],"description":"Pagination information. The offset and limit parameters are used to\nnavigate the list of elements. The _links object contains URLs to\nnavigate the different pages.\n","type":"object","properties":{"offset":{"$ref":"#/components/schemas/Offset"},"limit":{"$ref":"#/components/schemas/Limit"},"_links":{"$ref":"#/components/schemas/Links"}}},"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true},"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true},"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```

## The Offset object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"Offset":{"description":"The offset specified in the request (if none was specified, the default\noffset is 0).\n","type":"integer","minimum":0,"readOnly":true}}}}
```

## The Limit object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"Limit":{"description":"The limit specified in the request (if none was specified, use the\nendpoint's default pagination limit).\n","type":"integer","minimum":0,"readOnly":true}}}}
```

## The Links object

```json
{"openapi":"3.0.3","info":{"title":"Event Streams for Apache Kafka API","version":"3.1.0"},"components":{"schemas":{"Links":{"description":"URLs to navigate the different pages. As of now we always only return a\nsingle page.\n","type":"object","properties":{"prev":{"description":"URL (with offset and limit parameters) of the previous page; only\npresent if offset is greater than 0.\n","type":"string","format":"uri","readOnly":true},"self":{"description":"URL (with offset and limit parameters) of the current page.\n","type":"string","format":"uri","readOnly":true},"next":{"description":"URL (with offset and limit parameters) of the next page; only\npresent if offset + limit is less than the total number of elements.\n","type":"string","format":"uri","readOnly":true}}}}}}
```