1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="pubsublite_v1.html">Pub/Sub Lite API</a> . <a href="pubsublite_v1.admin.html">admin</a> . <a href="pubsublite_v1.admin.projects.html">projects</a> . <a href="pubsublite_v1.admin.projects.locations.html">locations</a> . <a href="pubsublite_v1.admin.projects.locations.topics.html">topics</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="pubsublite_v1.admin.projects.locations.topics.subscriptions.html">subscriptions()</a></code> 79</p> 80<p class="firstline">Returns the subscriptions Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, topicId=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a new topic.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes the specified topic.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Returns the topic configuration.</p> 94<p class="toc_element"> 95 <code><a href="#getPartitions">getPartitions(name, x__xgafv=None)</a></code></p> 96<p class="firstline">Returns the partition information for the requested topic.</p> 97<p class="toc_element"> 98 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Returns the list of topics for the given project.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates properties of the specified topic.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="close">close()</code> 109 <pre>Close httplib2 connections.</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="create">create(parent, body=None, topicId=None, x__xgafv=None)</code> 114 <pre>Creates a new topic. 115 116Args: 117 parent: string, Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`. (required) 118 body: object, The request body. 119 The object takes the form of: 120 121{ # Metadata about a topic resource. 122 "name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} 123 "partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions. 124 "capacity": { # The throughput capacity configuration for each partition. # The capacity configuration. 125 "publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16. 126 "subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32. 127 }, 128 "count": "A String", # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity 129 "scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4]. 130 }, 131 "reservationConfig": { # The settings for this topic's Reservation usage. # The settings for this topic's Reservation usage. 132 "throughputReservation": "A String", # The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} 133 }, 134 "retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention. 135 "perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`. 136 "period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`. 137 }, 138} 139 140 topicId: string, Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`. 141 x__xgafv: string, V1 error format. 142 Allowed values 143 1 - v1 error format 144 2 - v2 error format 145 146Returns: 147 An object of the form: 148 149 { # Metadata about a topic resource. 150 "name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} 151 "partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions. 152 "capacity": { # The throughput capacity configuration for each partition. # The capacity configuration. 153 "publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16. 154 "subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32. 155 }, 156 "count": "A String", # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity 157 "scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4]. 158 }, 159 "reservationConfig": { # The settings for this topic's Reservation usage. # The settings for this topic's Reservation usage. 160 "throughputReservation": "A String", # The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} 161 }, 162 "retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention. 163 "perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`. 164 "period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`. 165 }, 166}</pre> 167</div> 168 169<div class="method"> 170 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 171 <pre>Deletes the specified topic. 172 173Args: 174 name: string, Required. The name of the topic to delete. (required) 175 x__xgafv: string, V1 error format. 176 Allowed values 177 1 - v1 error format 178 2 - v2 error format 179 180Returns: 181 An object of the form: 182 183 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 184}</pre> 185</div> 186 187<div class="method"> 188 <code class="details" id="get">get(name, x__xgafv=None)</code> 189 <pre>Returns the topic configuration. 190 191Args: 192 name: string, Required. The name of the topic whose configuration to return. (required) 193 x__xgafv: string, V1 error format. 194 Allowed values 195 1 - v1 error format 196 2 - v2 error format 197 198Returns: 199 An object of the form: 200 201 { # Metadata about a topic resource. 202 "name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} 203 "partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions. 204 "capacity": { # The throughput capacity configuration for each partition. # The capacity configuration. 205 "publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16. 206 "subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32. 207 }, 208 "count": "A String", # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity 209 "scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4]. 210 }, 211 "reservationConfig": { # The settings for this topic's Reservation usage. # The settings for this topic's Reservation usage. 212 "throughputReservation": "A String", # The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} 213 }, 214 "retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention. 215 "perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`. 216 "period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`. 217 }, 218}</pre> 219</div> 220 221<div class="method"> 222 <code class="details" id="getPartitions">getPartitions(name, x__xgafv=None)</code> 223 <pre>Returns the partition information for the requested topic. 224 225Args: 226 name: string, Required. The topic whose partition information to return. (required) 227 x__xgafv: string, V1 error format. 228 Allowed values 229 1 - v1 error format 230 2 - v2 error format 231 232Returns: 233 An object of the form: 234 235 { # Response for GetTopicPartitions. 236 "partitionCount": "A String", # The number of partitions in the topic. 237}</pre> 238</div> 239 240<div class="method"> 241 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 242 <pre>Returns the list of topics for the given project. 243 244Args: 245 parent: string, Required. The parent whose topics are to be listed. Structured like `projects/{project_number}/locations/{location}`. (required) 246 pageSize: integer, The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned. 247 pageToken: string, A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token. 248 x__xgafv: string, V1 error format. 249 Allowed values 250 1 - v1 error format 251 2 - v2 error format 252 253Returns: 254 An object of the form: 255 256 { # Response for ListTopics. 257 "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. 258 "topics": [ # The list of topic in the requested parent. The order of the topics is unspecified. 259 { # Metadata about a topic resource. 260 "name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} 261 "partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions. 262 "capacity": { # The throughput capacity configuration for each partition. # The capacity configuration. 263 "publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16. 264 "subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32. 265 }, 266 "count": "A String", # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity 267 "scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4]. 268 }, 269 "reservationConfig": { # The settings for this topic's Reservation usage. # The settings for this topic's Reservation usage. 270 "throughputReservation": "A String", # The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} 271 }, 272 "retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention. 273 "perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`. 274 "period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`. 275 }, 276 }, 277 ], 278}</pre> 279</div> 280 281<div class="method"> 282 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 283 <pre>Retrieves the next page of results. 284 285Args: 286 previous_request: The request for the previous page. (required) 287 previous_response: The response from the request for the previous page. (required) 288 289Returns: 290 A request object that you can call 'execute()' on to request the next 291 page. Returns None if there are no more items in the collection. 292 </pre> 293</div> 294 295<div class="method"> 296 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 297 <pre>Updates properties of the specified topic. 298 299Args: 300 name: string, The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} (required) 301 body: object, The request body. 302 The object takes the form of: 303 304{ # Metadata about a topic resource. 305 "name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} 306 "partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions. 307 "capacity": { # The throughput capacity configuration for each partition. # The capacity configuration. 308 "publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16. 309 "subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32. 310 }, 311 "count": "A String", # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity 312 "scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4]. 313 }, 314 "reservationConfig": { # The settings for this topic's Reservation usage. # The settings for this topic's Reservation usage. 315 "throughputReservation": "A String", # The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} 316 }, 317 "retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention. 318 "perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`. 319 "period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`. 320 }, 321} 322 323 updateMask: string, Required. A mask specifying the topic fields to change. 324 x__xgafv: string, V1 error format. 325 Allowed values 326 1 - v1 error format 327 2 - v2 error format 328 329Returns: 330 An object of the form: 331 332 { # Metadata about a topic resource. 333 "name": "A String", # The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} 334 "partitionConfig": { # The settings for a topic's partitions. # The settings for this topic's partitions. 335 "capacity": { # The throughput capacity configuration for each partition. # The capacity configuration. 336 "publishMibPerSec": 42, # Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16. 337 "subscribeMibPerSec": 42, # Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32. 338 }, 339 "count": "A String", # The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity 340 "scale": 42, # DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4]. 341 }, 342 "reservationConfig": { # The settings for this topic's Reservation usage. # The settings for this topic's Reservation usage. 343 "throughputReservation": "A String", # The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} 344 }, 345 "retentionConfig": { # The settings for a topic's message retention. # The settings for this topic's message retention. 346 "perPartitionBytes": "A String", # The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`. 347 "period": "A String", # How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`. 348 }, 349}</pre> 350</div> 351 352</body></html>