From bd4e2f30be4adbfc0e3268c348ee277cb92bc01a Mon Sep 17 00:00:00 2001 From: API Engineering Date: Mon, 16 Oct 2023 18:23:54 +0000 Subject: [PATCH] [bot] Updated client based on openapi-b0a1e19/clientgen --- DO_OPENAPI_COMMIT_SHA.txt | 2 +- src/pydo/aio/operations/_operations.py | 244 +++++++++++++------------ src/pydo/operations/_operations.py | 244 +++++++++++++------------ 3 files changed, 263 insertions(+), 227 deletions(-) diff --git a/DO_OPENAPI_COMMIT_SHA.txt b/DO_OPENAPI_COMMIT_SHA.txt index 103265bb..65d9f414 100644 --- a/DO_OPENAPI_COMMIT_SHA.txt +++ b/DO_OPENAPI_COMMIT_SHA.txt @@ -1 +1 @@ -ff8c689 +b0a1e19 diff --git a/src/pydo/aio/operations/_operations.py b/src/pydo/aio/operations/_operations.py index 255ce3dd..11a211d3 100644 --- a/src/pydo/aio/operations/_operations.py +++ b/src/pydo/aio/operations/_operations.py @@ -71042,6 +71042,10 @@ async def list_clusters( "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added + to the cluster, in MiB. If null, no additional storage is added to the + cluster, beyond what is provided as a base amount from the 'size' and any + previously added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -71322,6 +71326,10 @@ async def create_cluster( "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the cluster, + in MiB. If null, no additional storage is added to the cluster, beyond what is + provided as a base amount from the 'size' and any previously added additional + storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -71476,6 +71484,10 @@ async def create_cluster( "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the + cluster, in MiB. If null, no additional storage is added to the cluster, + beyond what is provided as a base amount from the 'size' and any previously + added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -71680,6 +71692,10 @@ async def create_cluster( "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the + cluster, in MiB. If null, no additional storage is added to the cluster, + beyond what is provided as a base amount from the 'size' and any previously + added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -71882,6 +71898,10 @@ async def create_cluster(self, body: Union[JSON, IO], **kwargs: Any) -> JSON: "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the + cluster, in MiB. If null, no additional storage is added to the cluster, + beyond what is provided as a base amount from the 'size' and any previously + added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -72158,6 +72178,10 @@ async def get_cluster(self, database_cluster_uuid: str, **kwargs: Any) -> JSON: "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the + cluster, in MiB. If null, no additional storage is added to the cluster, + beyond what is provided as a base amount from the 'size' and any previously + added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -73535,8 +73559,12 @@ async def update_cluster_size( "num_nodes": 0, # The number of nodes in the database cluster. Valid values are are 1-3. In addition to the primary node, up to two standby nodes may be added for highly available configurations. Required. - "size": "str" # A slug identifier representing desired the size of the nodes - in the database cluster. Required. + "size": "str", # A slug identifier representing desired the size of the + nodes in the database cluster. Required. + "storage_size_mib": 0 # Optional. Additional storage added to the cluster, + in MiB. If null, no additional storage is added to the cluster, beyond what is + provided as a base amount from the 'size' and any previously added additional + storage. } # response body for status code(s): 404 @@ -79484,7 +79512,7 @@ async def create_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -79655,7 +79683,7 @@ async def create_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -79824,7 +79852,7 @@ async def create_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -80074,7 +80102,7 @@ async def get_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -80221,110 +80249,100 @@ async def update_kafka_topic( # JSON input template you can fill out and use as your body input. body = { - "topic": { - "config": { - "cleanup_policy": "delete", # Optional. Default value is - "delete". The cleanup_policy sets the retention policy to use on log - segments. 'delete' will discard old segments when retention time/size - limits are reached. 'compact' will enable log compaction, resulting in - retention of the latest value for each key. Known values are: "delete", - "compact", and "compact_delete". - "compression_type": "producer", # Optional. Default value is - "producer". The compression_type specifies the compression type of the - topic. Known values are: "producer", "gzip", "snappy", "Iz4", "zstd", and - "uncompressed". - "delete_retention_ms": 86400000, # Optional. Default value - is 86400000. The delete_retention_ms specifies how long (in ms) to retain - delete tombstone markers for topics. - "file_delete_delay_ms": 60000, # Optional. Default value is - 60000. The file_delete_delay_ms specifies the time (in ms) to wait before - deleting a file from the filesystem. - "flush_messages": 9223372036854776000, # Optional. Default - value is 9223372036854776000. The flush_messages specifies the number of - messages to accumulate on a log partition before messages are flushed to - disk. - "flush_ms": 9223372036854776000, # Optional. Default value - is 9223372036854776000. The flush_ms specifies the maximum time (in ms) - that a message is kept in memory before being flushed to disk. - "index_interval_bytes": 4096, # Optional. Default value is - 4096. The index_interval_bytes specifies the number of bytes between - entries being added into te offset index. - "max_compaction_lag_ms": 9223372036854776000, # Optional. - Default value is 9223372036854776000. The max_compaction_lag_ms specifies - the maximum amount of time (in ms) that a message will remain - uncompacted. This is only applicable if the logs are have compaction - enabled. - "max_message_bytes": 1048588, # Optional. Default value is - 1048588. The max_messages_bytes specifies the largest record batch size - (in bytes) that can be sent to the server. This is calculated after - compression if compression is enabled. - "message_down_conversion_enable": True, # Optional. Default - value is True. The message_down_conversion_enable specifies whether - down-conversion of message formats is enabled to satisfy consumer - requests. When 'false', the broker will not perform conversion for - consumers expecting older message formats. The broker will respond with - an ``UNSUPPORTED_VERSION`` error for consume requests from these older - clients. - "message_format_version": "3.0-IV1", # Optional. Default - value is "3.0-IV1". The message_format_version specifies the message - format version used by the broker to append messages to the logs. The - value of this setting is assumed to be 3.0-IV1 if the broker protocol - version is 3.0 or higher. By setting a particular message format - version, all existing messages on disk must be smaller or equal to the - specified version. Known values are: "0.8.0", "0.8.1", "0.8.2", "0.9.0", - "0.10.0-IV0", "0.10.0-IV1", "0.10.1-IV0", "0.10.1-IV1", "0.10.1-IV2", - "0.10.2-IV0", "0.11.0-IV0", "0.11.0-IV1", "0.11.0-IV2", "1.0-IV0", - "1.1-IV0", "2.0-IV0", "2.0-IV1", "2.1-IV0", "2.1-IV1", "2.1-IV2", - "2.2-IV0", "2.2-IV1", "2.3-IV0", "2.3-IV1", "2.4-IV0", "2.4-IV1", - "2.5-IV0", "2.6-IV0", "2.7-IV0", "2.7-IV1", "2.7-IV2", "2.8-IV0", - "2.8-IV1", "3.0-IV0", "3.0-IV1", "3.1-IV0", "3.2-IV0", "3.3-IV0", - "3.3-IV1", "3.3-IV2", and "3.3-IV3". - "message_timestamp_type": "create_time", # Optional. Default - value is "create_time". The message_timestamp_type specifies whether to - use the message create time or log append time as the timestamp on a - message. Known values are: "create_time" and "log_append_time". - "min_cleanable_dirty_ratio": 0.5, # Optional. Default value - is 0.5. The min_cleanable_dirty_ratio specifies the frequency of log - compaction (if enabled) in relation to duplicates present in the logs. - For example, at 0.5, at most 50% of the log could be duplicates before - compaction would begin. - "min_compaction_lag_ms": 0, # Optional. Default value is 0. - The min_compaction_lag_ms specifies the minimum time (in ms) that a - message will remain uncompacted in the log. Only relevant if log - compaction is enabled. - "min_insync_replicas": 1, # Optional. Default value is 1. - The min_insync_replicas specifies the number of replicas that must ACK a - write for the write to be considered successful. - "preallocate": False, # Optional. Default value is False. - The preallocate specifies whether a file should be preallocated on disk - when creating a new log segment. - "retention_bytes": -1, # Optional. Default value is -1. The - retention_bytes specifies the maximum size of the log (in bytes) before - deleting messages. -1 indicates that there is no limit. - "retention_ms": 604800000, # Optional. Default value is - 604800000. The retention_ms specifies the maximum amount of time (in ms) - to keep a message before deleting it. - "segment_bytes": 209715200, # Optional. Default value is - 209715200. The segment_bytes specifies the maximum size of a single log - file (in bytes). - "segment_jitter_ms": 0, # Optional. Default value is 0. The - segment_jitter_ms specifies the maximum random jitter subtracted from the - scheduled segment roll time to avoid thundering herds of segment rolling. - "segment_ms": 604800000, # Optional. Default value is - 604800000. The segment_ms specifies the period of time after which the - log will be forced to roll if the segment file isn't full. This ensures - that retention can delete or compact old data. - "unclean_leader_election_enable": False # Optional. Default - value is False. Whether unclean_leader_election_enable specifies whether - to allow replicas that are not insync to be elected as leaders as a last - resort. This may result in data loss since those leaders are not insync. - }, - "name": "str", # Optional. The name of the Kafka topic. - "partition_count": 0, # Optional. The number of partitions available - for the topic. On update, this value can only be increased. - "replication_factor": 0 # Optional. The number of nodes to replicate - data across the cluster. - } + "config": { + "cleanup_policy": "delete", # Optional. Default value is "delete". + The cleanup_policy sets the retention policy to use on log segments. 'delete' + will discard old segments when retention time/size limits are reached. + 'compact' will enable log compaction, resulting in retention of the latest + value for each key. Known values are: "delete", "compact", and + "compact_delete". + "compression_type": "producer", # Optional. Default value is + "producer". The compression_type specifies the compression type of the topic. + Known values are: "producer", "gzip", "snappy", "Iz4", "zstd", and + "uncompressed". + "delete_retention_ms": 86400000, # Optional. Default value is + 86400000. The delete_retention_ms specifies how long (in ms) to retain delete + tombstone markers for topics. + "file_delete_delay_ms": 60000, # Optional. Default value is 60000. + The file_delete_delay_ms specifies the time (in ms) to wait before deleting a + file from the filesystem. + "flush_messages": 9223372036854776000, # Optional. Default value is + 9223372036854776000. The flush_messages specifies the number of messages to + accumulate on a log partition before messages are flushed to disk. + "flush_ms": 9223372036854776000, # Optional. Default value is + 9223372036854776000. The flush_ms specifies the maximum time (in ms) that a + message is kept in memory before being flushed to disk. + "index_interval_bytes": 4096, # Optional. Default value is 4096. The + index_interval_bytes specifies the number of bytes between entries being + added into te offset index. + "max_compaction_lag_ms": 9223372036854776000, # Optional. Default + value is 9223372036854776000. The max_compaction_lag_ms specifies the maximum + amount of time (in ms) that a message will remain uncompacted. This is only + applicable if the logs are have compaction enabled. + "max_message_bytes": 1048588, # Optional. Default value is 1048588. + The max_messages_bytes specifies the largest record batch size (in bytes) + that can be sent to the server. This is calculated after compression if + compression is enabled. + "message_down_conversion_enable": True, # Optional. Default value is + True. The message_down_conversion_enable specifies whether down-conversion of + message formats is enabled to satisfy consumer requests. When 'false', the + broker will not perform conversion for consumers expecting older message + formats. The broker will respond with an ``UNSUPPORTED_VERSION`` error for + consume requests from these older clients. + "message_format_version": "3.0-IV1", # Optional. Default value is + "3.0-IV1". The message_format_version specifies the message format version + used by the broker to append messages to the logs. The value of this setting + is assumed to be 3.0-IV1 if the broker protocol version is 3.0 or higher. By + setting a particular message format version, all existing messages on disk + must be smaller or equal to the specified version. Known values are: "0.8.0", + "0.8.1", "0.8.2", "0.9.0", "0.10.0-IV0", "0.10.0-IV1", "0.10.1-IV0", + "0.10.1-IV1", "0.10.1-IV2", "0.10.2-IV0", "0.11.0-IV0", "0.11.0-IV1", + "0.11.0-IV2", "1.0-IV0", "1.1-IV0", "2.0-IV0", "2.0-IV1", "2.1-IV0", + "2.1-IV1", "2.1-IV2", "2.2-IV0", "2.2-IV1", "2.3-IV0", "2.3-IV1", "2.4-IV0", + "2.4-IV1", "2.5-IV0", "2.6-IV0", "2.7-IV0", "2.7-IV1", "2.7-IV2", "2.8-IV0", + "2.8-IV1", "3.0-IV0", "3.0-IV1", "3.1-IV0", "3.2-IV0", "3.3-IV0", "3.3-IV1", + "3.3-IV2", and "3.3-IV3". + "message_timestamp_type": "create_time", # Optional. Default value + is "create_time". The message_timestamp_type specifies whether to use the + message create time or log append time as the timestamp on a message. Known + values are: "create_time" and "log_append_time". + "min_cleanable_dirty_ratio": 0.5, # Optional. Default value is 0.5. + The min_cleanable_dirty_ratio specifies the frequency of log compaction (if + enabled) in relation to duplicates present in the logs. For example, at 0.5, + at most 50% of the log could be duplicates before compaction would begin. + "min_compaction_lag_ms": 0, # Optional. Default value is 0. The + min_compaction_lag_ms specifies the minimum time (in ms) that a message will + remain uncompacted in the log. Only relevant if log compaction is enabled. + "min_insync_replicas": 1, # Optional. Default value is 1. The + min_insync_replicas specifies the number of replicas that must ACK a write + for the write to be considered successful. + "preallocate": False, # Optional. Default value is False. The + preallocate specifies whether a file should be preallocated on disk when + creating a new log segment. + "retention_bytes": -1, # Optional. Default value is -1. The + retention_bytes specifies the maximum size of the log (in bytes) before + deleting messages. -1 indicates that there is no limit. + "retention_ms": 604800000, # Optional. Default value is 604800000. + The retention_ms specifies the maximum amount of time (in ms) to keep a + message before deleting it. + "segment_bytes": 209715200, # Optional. Default value is 209715200. + The segment_bytes specifies the maximum size of a single log file (in bytes). + "segment_jitter_ms": 0, # Optional. Default value is 0. The + segment_jitter_ms specifies the maximum random jitter subtracted from the + scheduled segment roll time to avoid thundering herds of segment rolling. + "segment_ms": 604800000, # Optional. Default value is 604800000. The + segment_ms specifies the period of time after which the log will be forced to + roll if the segment file isn't full. This ensures that retention can delete + or compact old data. + "unclean_leader_election_enable": False # Optional. Default value is + False. Whether unclean_leader_election_enable specifies whether to allow + replicas that are not insync to be elected as leaders as a last resort. This + may result in data loss since those leaders are not insync. + }, + "partition_count": 0, # Optional. The number of partitions available for the + topic. On update, this value can only be increased. + "replication_factor": 0 # Optional. The number of nodes to replicate data + across the cluster. } # response body for status code(s): 200 @@ -80427,7 +80445,7 @@ async def update_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -80601,7 +80619,7 @@ async def update_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -80773,7 +80791,7 @@ async def update_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ diff --git a/src/pydo/operations/_operations.py b/src/pydo/operations/_operations.py index ae2ec141..404fe220 100644 --- a/src/pydo/operations/_operations.py +++ b/src/pydo/operations/_operations.py @@ -77823,6 +77823,10 @@ def list_clusters(self, *, tag_name: Optional[str] = None, **kwargs: Any) -> JSO "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added + to the cluster, in MiB. If null, no additional storage is added to the + cluster, beyond what is provided as a base amount from the 'size' and any + previously added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -78103,6 +78107,10 @@ def create_cluster( "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the cluster, + in MiB. If null, no additional storage is added to the cluster, beyond what is + provided as a base amount from the 'size' and any previously added additional + storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -78257,6 +78265,10 @@ def create_cluster( "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the + cluster, in MiB. If null, no additional storage is added to the cluster, + beyond what is provided as a base amount from the 'size' and any previously + added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -78461,6 +78473,10 @@ def create_cluster( "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the + cluster, in MiB. If null, no additional storage is added to the cluster, + beyond what is provided as a base amount from the 'size' and any previously + added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -78663,6 +78679,10 @@ def create_cluster(self, body: Union[JSON, IO], **kwargs: Any) -> JSON: "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the + cluster, in MiB. If null, no additional storage is added to the cluster, + beyond what is provided as a base amount from the 'size' and any previously + added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -78939,6 +78959,10 @@ def get_cluster(self, database_cluster_uuid: str, **kwargs: Any) -> JSON: "status": "str", # Optional. A string representing the current status of the database cluster. Known values are: "creating", "online", "resizing", "migrating", and "forking". + "storage_size_mib": 0, # Optional. Additional storage added to the + cluster, in MiB. If null, no additional storage is added to the cluster, + beyond what is provided as a base amount from the 'size' and any previously + added additional storage. "tags": [ "str" # Optional. An array of tags that have been applied to the database cluster. @@ -80314,8 +80338,12 @@ def update_cluster_size( "num_nodes": 0, # The number of nodes in the database cluster. Valid values are are 1-3. In addition to the primary node, up to two standby nodes may be added for highly available configurations. Required. - "size": "str" # A slug identifier representing desired the size of the nodes - in the database cluster. Required. + "size": "str", # A slug identifier representing desired the size of the + nodes in the database cluster. Required. + "storage_size_mib": 0 # Optional. Additional storage added to the cluster, + in MiB. If null, no additional storage is added to the cluster, beyond what is + provided as a base amount from the 'size' and any previously added additional + storage. } # response body for status code(s): 404 @@ -86255,7 +86283,7 @@ def create_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -86426,7 +86454,7 @@ def create_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -86595,7 +86623,7 @@ def create_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -86845,7 +86873,7 @@ def get_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -86992,110 +87020,100 @@ def update_kafka_topic( # JSON input template you can fill out and use as your body input. body = { - "topic": { - "config": { - "cleanup_policy": "delete", # Optional. Default value is - "delete". The cleanup_policy sets the retention policy to use on log - segments. 'delete' will discard old segments when retention time/size - limits are reached. 'compact' will enable log compaction, resulting in - retention of the latest value for each key. Known values are: "delete", - "compact", and "compact_delete". - "compression_type": "producer", # Optional. Default value is - "producer". The compression_type specifies the compression type of the - topic. Known values are: "producer", "gzip", "snappy", "Iz4", "zstd", and - "uncompressed". - "delete_retention_ms": 86400000, # Optional. Default value - is 86400000. The delete_retention_ms specifies how long (in ms) to retain - delete tombstone markers for topics. - "file_delete_delay_ms": 60000, # Optional. Default value is - 60000. The file_delete_delay_ms specifies the time (in ms) to wait before - deleting a file from the filesystem. - "flush_messages": 9223372036854776000, # Optional. Default - value is 9223372036854776000. The flush_messages specifies the number of - messages to accumulate on a log partition before messages are flushed to - disk. - "flush_ms": 9223372036854776000, # Optional. Default value - is 9223372036854776000. The flush_ms specifies the maximum time (in ms) - that a message is kept in memory before being flushed to disk. - "index_interval_bytes": 4096, # Optional. Default value is - 4096. The index_interval_bytes specifies the number of bytes between - entries being added into te offset index. - "max_compaction_lag_ms": 9223372036854776000, # Optional. - Default value is 9223372036854776000. The max_compaction_lag_ms specifies - the maximum amount of time (in ms) that a message will remain - uncompacted. This is only applicable if the logs are have compaction - enabled. - "max_message_bytes": 1048588, # Optional. Default value is - 1048588. The max_messages_bytes specifies the largest record batch size - (in bytes) that can be sent to the server. This is calculated after - compression if compression is enabled. - "message_down_conversion_enable": True, # Optional. Default - value is True. The message_down_conversion_enable specifies whether - down-conversion of message formats is enabled to satisfy consumer - requests. When 'false', the broker will not perform conversion for - consumers expecting older message formats. The broker will respond with - an ``UNSUPPORTED_VERSION`` error for consume requests from these older - clients. - "message_format_version": "3.0-IV1", # Optional. Default - value is "3.0-IV1". The message_format_version specifies the message - format version used by the broker to append messages to the logs. The - value of this setting is assumed to be 3.0-IV1 if the broker protocol - version is 3.0 or higher. By setting a particular message format - version, all existing messages on disk must be smaller or equal to the - specified version. Known values are: "0.8.0", "0.8.1", "0.8.2", "0.9.0", - "0.10.0-IV0", "0.10.0-IV1", "0.10.1-IV0", "0.10.1-IV1", "0.10.1-IV2", - "0.10.2-IV0", "0.11.0-IV0", "0.11.0-IV1", "0.11.0-IV2", "1.0-IV0", - "1.1-IV0", "2.0-IV0", "2.0-IV1", "2.1-IV0", "2.1-IV1", "2.1-IV2", - "2.2-IV0", "2.2-IV1", "2.3-IV0", "2.3-IV1", "2.4-IV0", "2.4-IV1", - "2.5-IV0", "2.6-IV0", "2.7-IV0", "2.7-IV1", "2.7-IV2", "2.8-IV0", - "2.8-IV1", "3.0-IV0", "3.0-IV1", "3.1-IV0", "3.2-IV0", "3.3-IV0", - "3.3-IV1", "3.3-IV2", and "3.3-IV3". - "message_timestamp_type": "create_time", # Optional. Default - value is "create_time". The message_timestamp_type specifies whether to - use the message create time or log append time as the timestamp on a - message. Known values are: "create_time" and "log_append_time". - "min_cleanable_dirty_ratio": 0.5, # Optional. Default value - is 0.5. The min_cleanable_dirty_ratio specifies the frequency of log - compaction (if enabled) in relation to duplicates present in the logs. - For example, at 0.5, at most 50% of the log could be duplicates before - compaction would begin. - "min_compaction_lag_ms": 0, # Optional. Default value is 0. - The min_compaction_lag_ms specifies the minimum time (in ms) that a - message will remain uncompacted in the log. Only relevant if log - compaction is enabled. - "min_insync_replicas": 1, # Optional. Default value is 1. - The min_insync_replicas specifies the number of replicas that must ACK a - write for the write to be considered successful. - "preallocate": False, # Optional. Default value is False. - The preallocate specifies whether a file should be preallocated on disk - when creating a new log segment. - "retention_bytes": -1, # Optional. Default value is -1. The - retention_bytes specifies the maximum size of the log (in bytes) before - deleting messages. -1 indicates that there is no limit. - "retention_ms": 604800000, # Optional. Default value is - 604800000. The retention_ms specifies the maximum amount of time (in ms) - to keep a message before deleting it. - "segment_bytes": 209715200, # Optional. Default value is - 209715200. The segment_bytes specifies the maximum size of a single log - file (in bytes). - "segment_jitter_ms": 0, # Optional. Default value is 0. The - segment_jitter_ms specifies the maximum random jitter subtracted from the - scheduled segment roll time to avoid thundering herds of segment rolling. - "segment_ms": 604800000, # Optional. Default value is - 604800000. The segment_ms specifies the period of time after which the - log will be forced to roll if the segment file isn't full. This ensures - that retention can delete or compact old data. - "unclean_leader_election_enable": False # Optional. Default - value is False. Whether unclean_leader_election_enable specifies whether - to allow replicas that are not insync to be elected as leaders as a last - resort. This may result in data loss since those leaders are not insync. - }, - "name": "str", # Optional. The name of the Kafka topic. - "partition_count": 0, # Optional. The number of partitions available - for the topic. On update, this value can only be increased. - "replication_factor": 0 # Optional. The number of nodes to replicate - data across the cluster. - } + "config": { + "cleanup_policy": "delete", # Optional. Default value is "delete". + The cleanup_policy sets the retention policy to use on log segments. 'delete' + will discard old segments when retention time/size limits are reached. + 'compact' will enable log compaction, resulting in retention of the latest + value for each key. Known values are: "delete", "compact", and + "compact_delete". + "compression_type": "producer", # Optional. Default value is + "producer". The compression_type specifies the compression type of the topic. + Known values are: "producer", "gzip", "snappy", "Iz4", "zstd", and + "uncompressed". + "delete_retention_ms": 86400000, # Optional. Default value is + 86400000. The delete_retention_ms specifies how long (in ms) to retain delete + tombstone markers for topics. + "file_delete_delay_ms": 60000, # Optional. Default value is 60000. + The file_delete_delay_ms specifies the time (in ms) to wait before deleting a + file from the filesystem. + "flush_messages": 9223372036854776000, # Optional. Default value is + 9223372036854776000. The flush_messages specifies the number of messages to + accumulate on a log partition before messages are flushed to disk. + "flush_ms": 9223372036854776000, # Optional. Default value is + 9223372036854776000. The flush_ms specifies the maximum time (in ms) that a + message is kept in memory before being flushed to disk. + "index_interval_bytes": 4096, # Optional. Default value is 4096. The + index_interval_bytes specifies the number of bytes between entries being + added into te offset index. + "max_compaction_lag_ms": 9223372036854776000, # Optional. Default + value is 9223372036854776000. The max_compaction_lag_ms specifies the maximum + amount of time (in ms) that a message will remain uncompacted. This is only + applicable if the logs are have compaction enabled. + "max_message_bytes": 1048588, # Optional. Default value is 1048588. + The max_messages_bytes specifies the largest record batch size (in bytes) + that can be sent to the server. This is calculated after compression if + compression is enabled. + "message_down_conversion_enable": True, # Optional. Default value is + True. The message_down_conversion_enable specifies whether down-conversion of + message formats is enabled to satisfy consumer requests. When 'false', the + broker will not perform conversion for consumers expecting older message + formats. The broker will respond with an ``UNSUPPORTED_VERSION`` error for + consume requests from these older clients. + "message_format_version": "3.0-IV1", # Optional. Default value is + "3.0-IV1". The message_format_version specifies the message format version + used by the broker to append messages to the logs. The value of this setting + is assumed to be 3.0-IV1 if the broker protocol version is 3.0 or higher. By + setting a particular message format version, all existing messages on disk + must be smaller or equal to the specified version. Known values are: "0.8.0", + "0.8.1", "0.8.2", "0.9.0", "0.10.0-IV0", "0.10.0-IV1", "0.10.1-IV0", + "0.10.1-IV1", "0.10.1-IV2", "0.10.2-IV0", "0.11.0-IV0", "0.11.0-IV1", + "0.11.0-IV2", "1.0-IV0", "1.1-IV0", "2.0-IV0", "2.0-IV1", "2.1-IV0", + "2.1-IV1", "2.1-IV2", "2.2-IV0", "2.2-IV1", "2.3-IV0", "2.3-IV1", "2.4-IV0", + "2.4-IV1", "2.5-IV0", "2.6-IV0", "2.7-IV0", "2.7-IV1", "2.7-IV2", "2.8-IV0", + "2.8-IV1", "3.0-IV0", "3.0-IV1", "3.1-IV0", "3.2-IV0", "3.3-IV0", "3.3-IV1", + "3.3-IV2", and "3.3-IV3". + "message_timestamp_type": "create_time", # Optional. Default value + is "create_time". The message_timestamp_type specifies whether to use the + message create time or log append time as the timestamp on a message. Known + values are: "create_time" and "log_append_time". + "min_cleanable_dirty_ratio": 0.5, # Optional. Default value is 0.5. + The min_cleanable_dirty_ratio specifies the frequency of log compaction (if + enabled) in relation to duplicates present in the logs. For example, at 0.5, + at most 50% of the log could be duplicates before compaction would begin. + "min_compaction_lag_ms": 0, # Optional. Default value is 0. The + min_compaction_lag_ms specifies the minimum time (in ms) that a message will + remain uncompacted in the log. Only relevant if log compaction is enabled. + "min_insync_replicas": 1, # Optional. Default value is 1. The + min_insync_replicas specifies the number of replicas that must ACK a write + for the write to be considered successful. + "preallocate": False, # Optional. Default value is False. The + preallocate specifies whether a file should be preallocated on disk when + creating a new log segment. + "retention_bytes": -1, # Optional. Default value is -1. The + retention_bytes specifies the maximum size of the log (in bytes) before + deleting messages. -1 indicates that there is no limit. + "retention_ms": 604800000, # Optional. Default value is 604800000. + The retention_ms specifies the maximum amount of time (in ms) to keep a + message before deleting it. + "segment_bytes": 209715200, # Optional. Default value is 209715200. + The segment_bytes specifies the maximum size of a single log file (in bytes). + "segment_jitter_ms": 0, # Optional. Default value is 0. The + segment_jitter_ms specifies the maximum random jitter subtracted from the + scheduled segment roll time to avoid thundering herds of segment rolling. + "segment_ms": 604800000, # Optional. Default value is 604800000. The + segment_ms specifies the period of time after which the log will be forced to + roll if the segment file isn't full. This ensures that retention can delete + or compact old data. + "unclean_leader_election_enable": False # Optional. Default value is + False. Whether unclean_leader_election_enable specifies whether to allow + replicas that are not insync to be elected as leaders as a last resort. This + may result in data loss since those leaders are not insync. + }, + "partition_count": 0, # Optional. The number of partitions available for the + topic. On update, this value can only be increased. + "replication_factor": 0 # Optional. The number of nodes to replicate data + across the cluster. } # response body for status code(s): 200 @@ -87198,7 +87216,7 @@ def update_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -87372,7 +87390,7 @@ def update_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [ @@ -87544,7 +87562,7 @@ def update_kafka_topic( to allow replicas that are not insync to be elected as leaders as a last resort. This may result in data loss since those leaders are not insync. }, - "name": "str", # The name of the Kafka topic. Required. + "name": "str", # Optional. The name of the Kafka topic. "partitions": [ { "consumer_groups": [