| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -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_v1.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1.projects.html">projects</a> . <a href="pubsub_v1.projects.schemas.html">schemas</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"> |
| 81 | <code><a href="#create">create(parent, body=None, schemaId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Creates a schema.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Deletes a schema.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Gets a schema.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Lists schemas in a 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="#validate">validate(parent, body=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Validates a schema.</p> |
| 98 | <p class="toc_element"> |
| 99 | <code><a href="#validateMessage">validateMessage(parent, body=None, x__xgafv=None)</a></code></p> |
| 100 | <p class="firstline">Validates a message against a schema.</p> |
| 101 | <h3>Method Details</h3> |
| 102 | <div class="method"> |
| 103 | <code class="details" id="close">close()</code> |
| 104 | <pre>Close httplib2 connections.</pre> |
| 105 | </div> |
| 106 | |
| 107 | <div class="method"> |
| 108 | <code class="details" id="create">create(parent, body=None, schemaId=None, x__xgafv=None)</code> |
| 109 | <pre>Creates a schema. |
| 110 | |
| 111 | Args: |
| 112 | parent: string, Required. The name of the project in which to create the schema. Format is `projects/{project-id}`. (required) |
| 113 | body: object, The request body. |
| 114 | The object takes the form of: |
| 115 | |
| 116 | { # A schema resource. |
| 117 | "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. |
| 118 | "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. |
| 119 | "type": "A String", # The type of the schema definition. |
| 120 | } |
| 121 | |
| 122 | schemaId: string, The ID to use for the schema, which will become the final component of the schema's resource name. See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints. |
| 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 | { # A schema resource. |
| 132 | "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. |
| 133 | "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. |
| 134 | "type": "A String", # The type of the schema definition. |
| 135 | }</pre> |
| 136 | </div> |
| 137 | |
| 138 | <div class="method"> |
| 139 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 140 | <pre>Deletes a schema. |
| 141 | |
| 142 | Args: |
| 143 | name: string, Required. Name of the schema to delete. Format is `projects/{project}/schemas/{schema}`. (required) |
| 144 | x__xgafv: string, V1 error format. |
| 145 | Allowed values |
| 146 | 1 - v1 error format |
| 147 | 2 - v2 error format |
| 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
| 152 | { # 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 `{}`. |
| 153 | }</pre> |
| 154 | </div> |
| 155 | |
| 156 | <div class="method"> |
| 157 | <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> |
| 158 | <pre>Gets a schema. |
| 159 | |
| 160 | Args: |
| 161 | name: string, Required. The name of the schema to get. Format is `projects/{project}/schemas/{schema}`. (required) |
| 162 | view: string, The set of fields to return in the response. If not set, returns a Schema with `name` and `type`, but not `definition`. Set to `FULL` to retrieve all fields. |
| 163 | Allowed values |
| 164 | SCHEMA_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. |
| 165 | BASIC - Include the name and type of the schema, but not the definition. |
| 166 | FULL - Include all Schema object fields. |
| 167 | x__xgafv: string, V1 error format. |
| 168 | Allowed values |
| 169 | 1 - v1 error format |
| 170 | 2 - v2 error format |
| 171 | |
| 172 | Returns: |
| 173 | An object of the form: |
| 174 | |
| 175 | { # A schema resource. |
| 176 | "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. |
| 177 | "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. |
| 178 | "type": "A String", # The type of the schema definition. |
| 179 | }</pre> |
| 180 | </div> |
| 181 | |
| 182 | <div class="method"> |
| 183 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code> |
| 184 | <pre>Lists schemas in a project. |
| 185 | |
| 186 | Args: |
| 187 | parent: string, Required. The name of the project in which to list schemas. Format is `projects/{project-id}`. (required) |
| 188 | pageSize: integer, Maximum number of schemas to return. |
| 189 | pageToken: string, The value returned by the last `ListSchemasResponse`; indicates that this is a continuation of a prior `ListSchemas` call, and that the system should return the next page of data. |
| 190 | view: string, The set of Schema fields to return in the response. If not set, returns Schemas with `name` and `type`, but not `definition`. Set to `FULL` to retrieve all fields. |
| 191 | Allowed values |
| 192 | SCHEMA_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view. |
| 193 | BASIC - Include the name and type of the schema, but not the definition. |
| 194 | FULL - Include all Schema object fields. |
| 195 | x__xgafv: string, V1 error format. |
| 196 | Allowed values |
| 197 | 1 - v1 error format |
| 198 | 2 - v2 error format |
| 199 | |
| 200 | Returns: |
| 201 | An object of the form: |
| 202 | |
| 203 | { # Response for the `ListSchemas` method. |
| 204 | "nextPageToken": "A String", # If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new `ListSchemasRequest`. |
| 205 | "schemas": [ # The resulting schemas. |
| 206 | { # A schema resource. |
| 207 | "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. |
| 208 | "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. |
| 209 | "type": "A String", # The type of the schema definition. |
| 210 | }, |
| 211 | ], |
| 212 | }</pre> |
| 213 | </div> |
| 214 | |
| 215 | <div class="method"> |
| 216 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 217 | <pre>Retrieves the next page of results. |
| 218 | |
| 219 | Args: |
| 220 | previous_request: The request for the previous page. (required) |
| 221 | previous_response: The response from the request for the previous page. (required) |
| 222 | |
| 223 | Returns: |
| 224 | A request object that you can call 'execute()' on to request the next |
| 225 | page. Returns None if there are no more items in the collection. |
| 226 | </pre> |
| 227 | </div> |
| 228 | |
| 229 | <div class="method"> |
| 230 | <code class="details" id="validate">validate(parent, body=None, x__xgafv=None)</code> |
| 231 | <pre>Validates a schema. |
| 232 | |
| 233 | Args: |
| 234 | parent: string, Required. The name of the project in which to validate schemas. Format is `projects/{project-id}`. (required) |
| 235 | body: object, The request body. |
| 236 | The object takes the form of: |
| 237 | |
| 238 | { # Request for the `ValidateSchema` method. |
| 239 | "schema": { # A schema resource. # Required. The schema object to validate. |
| 240 | "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. |
| 241 | "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. |
| 242 | "type": "A String", # The type of the schema definition. |
| 243 | }, |
| 244 | } |
| 245 | |
| 246 | x__xgafv: string, V1 error format. |
| 247 | Allowed values |
| 248 | 1 - v1 error format |
| 249 | 2 - v2 error format |
| 250 | |
| 251 | Returns: |
| 252 | An object of the form: |
| 253 | |
| 254 | { # Response for the `ValidateSchema` method. Empty for now. |
| 255 | }</pre> |
| 256 | </div> |
| 257 | |
| 258 | <div class="method"> |
| 259 | <code class="details" id="validateMessage">validateMessage(parent, body=None, x__xgafv=None)</code> |
| 260 | <pre>Validates a message against a schema. |
| 261 | |
| 262 | Args: |
| 263 | parent: string, Required. The name of the project in which to validate schemas. Format is `projects/{project-id}`. (required) |
| 264 | body: object, The request body. |
| 265 | The object takes the form of: |
| 266 | |
| 267 | { # Request for the `ValidateMessage` method. |
| 268 | "encoding": "A String", # The encoding expected for messages |
| 269 | "message": "A String", # Message to validate against the provided `schema_spec`. |
| 270 | "name": "A String", # Name of the schema against which to validate. Format is `projects/{project}/schemas/{schema}`. |
| 271 | "schema": { # A schema resource. # Ad-hoc schema against which to validate |
| 272 | "definition": "A String", # The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. |
| 273 | "name": "A String", # Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. |
| 274 | "type": "A String", # The type of the schema definition. |
| 275 | }, |
| 276 | } |
| 277 | |
| 278 | x__xgafv: string, V1 error format. |
| 279 | Allowed values |
| 280 | 1 - v1 error format |
| 281 | 2 - v2 error format |
| 282 | |
| 283 | Returns: |
| 284 | An object of the form: |
| 285 | |
| 286 | { # Response for the `ValidateMessage` method. Empty for now. |
| 287 | }</pre> |
| 288 | </div> |
| 289 | |
| 290 | </body></html> |