| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.subscriptions.html">subscriptions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 81 | <code><a href="#create">create(parent, body=None, skipBacklog=None, subscriptionId=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 82 | <p class="firstline">Creates a new subscription.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes the specified subscription.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Returns the subscription configuration.</p> |
| 89 | <p class="toc_element"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 91 | <p class="firstline">Returns the list of subscriptions for the given project.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Updates properties of the specified subscription.</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 105 | <code class="details" id="create">create(parent, body=None, skipBacklog=None, subscriptionId=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | <pre>Creates a new subscription. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, Required. The parent location in which to create the subscription. Structured like `projects/{project_number}/locations/{location}`. (required) |
| 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # Metadata about a subscription resource. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 114 | "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery. |
| 115 | "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription. |
| 116 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 117 | "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 118 | "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} |
| 119 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 120 | |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 121 | skipBacklog: boolean, If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 122 | subscriptionId: string, Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`. |
| 123 | x__xgafv: string, V1 error format. |
| 124 | Allowed values |
| 125 | 1 - v1 error format |
| 126 | 2 - v2 error format |
| 127 | |
| 128 | Returns: |
| 129 | An object of the form: |
| 130 | |
| 131 | { # Metadata about a subscription resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 132 | "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery. |
| 133 | "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription. |
| 134 | }, |
| 135 | "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} |
| 136 | "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} |
| 137 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 138 | </div> |
| 139 | |
| 140 | <div class="method"> |
| 141 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 142 | <pre>Deletes the specified subscription. |
| 143 | |
| 144 | Args: |
| 145 | name: string, Required. The name of the subscription to delete. (required) |
| 146 | x__xgafv: string, V1 error format. |
| 147 | Allowed values |
| 148 | 1 - v1 error format |
| 149 | 2 - v2 error format |
| 150 | |
| 151 | Returns: |
| 152 | An object of the form: |
| 153 | |
| 154 | { # 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 `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 155 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 156 | </div> |
| 157 | |
| 158 | <div class="method"> |
| 159 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 160 | <pre>Returns the subscription configuration. |
| 161 | |
| 162 | Args: |
| 163 | name: string, Required. The name of the subscription whose configuration to return. (required) |
| 164 | x__xgafv: string, V1 error format. |
| 165 | Allowed values |
| 166 | 1 - v1 error format |
| 167 | 2 - v2 error format |
| 168 | |
| 169 | Returns: |
| 170 | An object of the form: |
| 171 | |
| 172 | { # Metadata about a subscription resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 173 | "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery. |
| 174 | "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription. |
| 175 | }, |
| 176 | "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} |
| 177 | "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} |
| 178 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 179 | </div> |
| 180 | |
| 181 | <div class="method"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 182 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 183 | <pre>Returns the list of subscriptions for the given project. |
| 184 | |
| 185 | Args: |
| 186 | parent: string, Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number}/locations/{location}`. (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 187 | pageSize: integer, The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 188 | pageToken: string, A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 189 | x__xgafv: string, V1 error format. |
| 190 | Allowed values |
| 191 | 1 - v1 error format |
| 192 | 2 - v2 error format |
| 193 | |
| 194 | Returns: |
| 195 | An object of the form: |
| 196 | |
| 197 | { # Response for ListSubscriptions. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 198 | "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. |
| 199 | "subscriptions": [ # The list of subscriptions in the requested parent. The order of the subscriptions is unspecified. |
| 200 | { # Metadata about a subscription resource. |
| 201 | "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery. |
| 202 | "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 203 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 204 | "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} |
| 205 | "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} |
| 206 | }, |
| 207 | ], |
| 208 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 209 | </div> |
| 210 | |
| 211 | <div class="method"> |
| 212 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 213 | <pre>Retrieves the next page of results. |
| 214 | |
| 215 | Args: |
| 216 | previous_request: The request for the previous page. (required) |
| 217 | previous_response: The response from the request for the previous page. (required) |
| 218 | |
| 219 | Returns: |
| 220 | A request object that you can call 'execute()' on to request the next |
| 221 | page. Returns None if there are no more items in the collection. |
| 222 | </pre> |
| 223 | </div> |
| 224 | |
| 225 | <div class="method"> |
| 226 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 227 | <pre>Updates properties of the specified subscription. |
| 228 | |
| 229 | Args: |
| 230 | name: string, The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} (required) |
| 231 | body: object, The request body. |
| 232 | The object takes the form of: |
| 233 | |
| 234 | { # Metadata about a subscription resource. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 235 | "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery. |
| 236 | "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription. |
| 237 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 238 | "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 239 | "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} |
| 240 | } |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 241 | |
| 242 | updateMask: string, Required. A mask specifying the subscription fields to change. |
| 243 | x__xgafv: string, V1 error format. |
| 244 | Allowed values |
| 245 | 1 - v1 error format |
| 246 | 2 - v2 error format |
| 247 | |
| 248 | Returns: |
| 249 | An object of the form: |
| 250 | |
| 251 | { # Metadata about a subscription resource. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 252 | "deliveryConfig": { # The settings for a subscription's message delivery. # The settings for this subscription's message delivery. |
| 253 | "deliveryRequirement": "A String", # The DeliveryRequirement for this subscription. |
| 254 | }, |
| 255 | "name": "A String", # The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} |
| 256 | "topic": "A String", # The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} |
| 257 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 258 | </div> |
| 259 | |
| 260 | </body></html> |