Gets a schema.
Arguments
Parameters | |
---|---|
name |
Required. The name of the schema to get. Format is
|
view |
The set of fields to return in the response. If not set, returns a Schema with all fields filled out. Set to
|
Enum type. Can be one of the following: | |
SCHEMA_VIEW_UNSPECIFIED |
The default / unset value. The API will default to the BASIC view. |
BASIC |
Include the name and type of the schema, but not the definition. |
FULL |
Include all Schema object fields. |
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of Schema
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- get: call: googleapis.pubsub.v1.projects.schemas.get args: name: ... view: ... result: getResult
JSON
[ { "get": { "call": "googleapis.pubsub.v1.projects.schemas.get", "args": { "name": "...", "view": "..." }, "result": "getResult" } } ]