You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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 `{}`.
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.
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.
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.
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.
Copy file name to clipboardExpand all lines: docs/dyn/pubsub_v1.projects.topics.html
+30Lines changed: 30 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -143,6 +143,11 @@ <h3>Method Details</h3>
143
143
],
144
144
},
145
145
"name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
146
+
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
147
+
"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
148
+
"encoding": "A String", # The encoding of messages validated against `schema`.
149
+
"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
150
+
},
146
151
}
147
152
148
153
x__xgafv: string, V1 error format.
@@ -164,6 +169,11 @@ <h3>Method Details</h3>
164
169
],
165
170
},
166
171
"name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
172
+
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
173
+
"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
174
+
"encoding": "A String", # The encoding of messages validated against `schema`.
175
+
"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
176
+
},
167
177
}</pre>
168
178
</div>
169
179
@@ -210,6 +220,11 @@ <h3>Method Details</h3>
210
220
],
211
221
},
212
222
"name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
223
+
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
224
+
"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
225
+
"encoding": "A String", # The encoding of messages validated against `schema`.
226
+
"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
227
+
},
213
228
}</pre>
214
229
</div>
215
230
@@ -278,6 +293,11 @@ <h3>Method Details</h3>
278
293
],
279
294
},
280
295
"name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
296
+
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
297
+
"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
298
+
"encoding": "A String", # The encoding of messages validated against `schema`.
299
+
"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
300
+
},
281
301
},
282
302
],
283
303
}</pre>
@@ -318,6 +338,11 @@ <h3>Method Details</h3>
318
338
],
319
339
},
320
340
"name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
341
+
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
342
+
"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
343
+
"encoding": "A String", # The encoding of messages validated against `schema`.
344
+
"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
345
+
},
321
346
},
322
347
"updateMask": "A String", # Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" but the `message_storage_policy` is not set in the `topic` provided above, then the updated value is determined by the policy configured at the project or organization level.
323
348
}
@@ -341,6 +366,11 @@ <h3>Method Details</h3>
341
366
],
342
367
},
343
368
"name": "A String", # Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`.
369
+
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
370
+
"schemaSettings": { # Settings for validating messages published against a schema. # Settings for validating messages published against a schema.
371
+
"encoding": "A String", # The encoding of messages validated against `schema`.
372
+
"schema": "A String", # Required. The name of the schema that messages published should be validated against. Format is `projects/{project}/schemas/{schema}`. The value of this field will be `_deleted-schema_` if the schema has been deleted.
0 commit comments