| Craig Citro | e633be1 | 2015-03-02 13:40:36 -0800 | [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="pubsub_v1beta2.html">Google Cloud Pub/Sub API</a> . <a href="pubsub_v1beta2.projects.html">projects</a> . <a href="pubsub_v1beta2.projects.topics.html">topics</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="pubsub_v1beta2.projects.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="#create">create(name, body)</a></code></p> |
| 84 | <p class="firstline">Creates the given topic with the given name.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#delete">delete(topic)</a></code></p> |
| 87 | <p class="firstline">Deletes the topic with the given name. All subscriptions to this topic are detached from the topic. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#get">get(topic)</a></code></p> |
| 90 | <p class="firstline">Gets the configuration of a topic.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list">list(project, pageSize=None, pageToken=None)</a></code></p> |
| 93 | <p class="firstline">Lists matching topics.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <p class="toc_element"> |
| 98 | <code><a href="#publish">publish(topic, body)</a></code></p> |
| 99 | <p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.</p> |
| 100 | <h3>Method Details</h3> |
| 101 | <div class="method"> |
| 102 | <code class="details" id="create">create(name, body)</code> |
| 103 | <pre>Creates the given topic with the given name. |
| 104 | |
| 105 | Args: |
| 106 | name: string, A parameter (required) |
| 107 | body: object, The request body. (required) |
| 108 | The object takes the form of: |
| 109 | |
| 110 | { |
| 111 | "name": "A String", |
| 112 | } |
| 113 | |
| 114 | |
| 115 | Returns: |
| 116 | An object of the form: |
| 117 | |
| 118 | { |
| 119 | "name": "A String", |
| 120 | }</pre> |
| 121 | </div> |
| 122 | |
| 123 | <div class="method"> |
| 124 | <code class="details" id="delete">delete(topic)</code> |
| 125 | <pre>Deletes the topic with the given name. All subscriptions to this topic are detached from the topic. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. |
| 126 | |
| 127 | Args: |
| 128 | topic: string, A parameter (required) |
| 129 | |
| 130 | Returns: |
| 131 | An object of the form: |
| 132 | |
| 133 | { |
| 134 | }</pre> |
| 135 | </div> |
| 136 | |
| 137 | <div class="method"> |
| 138 | <code class="details" id="get">get(topic)</code> |
| 139 | <pre>Gets the configuration of a topic. |
| 140 | |
| 141 | Args: |
| 142 | topic: string, A parameter (required) |
| 143 | |
| 144 | Returns: |
| 145 | An object of the form: |
| 146 | |
| 147 | { |
| 148 | "name": "A String", |
| 149 | }</pre> |
| 150 | </div> |
| 151 | |
| 152 | <div class="method"> |
| 153 | <code class="details" id="list">list(project, pageSize=None, pageToken=None)</code> |
| 154 | <pre>Lists matching topics. |
| 155 | |
| 156 | Args: |
| 157 | project: string, A parameter (required) |
| 158 | pageSize: integer, A parameter |
| 159 | pageToken: string, A parameter |
| 160 | |
| 161 | Returns: |
| 162 | An object of the form: |
| 163 | |
| 164 | { |
| 165 | "nextPageToken": "A String", |
| 166 | "topics": [ |
| 167 | { |
| 168 | "name": "A String", |
| 169 | }, |
| 170 | ], |
| 171 | }</pre> |
| 172 | </div> |
| 173 | |
| 174 | <div class="method"> |
| 175 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 176 | <pre>Retrieves the next page of results. |
| 177 | |
| 178 | Args: |
| 179 | previous_request: The request for the previous page. (required) |
| 180 | previous_response: The response from the request for the previous page. (required) |
| 181 | |
| 182 | Returns: |
| 183 | A request object that you can call 'execute()' on to request the next |
| 184 | page. Returns None if there are no more items in the collection. |
| 185 | </pre> |
| 186 | </div> |
| 187 | |
| 188 | <div class="method"> |
| 189 | <code class="details" id="publish">publish(topic, body)</code> |
| 190 | <pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. |
| 191 | |
| 192 | Args: |
| 193 | topic: string, A parameter (required) |
| 194 | body: object, The request body. (required) |
| 195 | The object takes the form of: |
| 196 | |
| 197 | { |
| 198 | "messages": [ |
| 199 | { |
| 200 | "attributes": { |
| 201 | "a_key": "A String", |
| 202 | }, |
| 203 | "data": "A String", |
| 204 | "messageId": "A String", |
| 205 | }, |
| 206 | ], |
| 207 | } |
| 208 | |
| 209 | |
| 210 | Returns: |
| 211 | An object of the form: |
| 212 | |
| 213 | { |
| 214 | "messageIds": [ |
| 215 | "A String", |
| 216 | ], |
| 217 | }</pre> |
| 218 | </div> |
| 219 | |
| 220 | </body></html> |