Reference documentation and code samples for the Cloud PubSub V1 Client class GetSchemaRequest.
Request for the GetSchema method.
Generated from protobuf messagegoogle.pubsub.v1.GetSchemaRequest
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the schema to get. Format isprojects/{project}/schemas/{schema}.
↳ view
int
The set of fields to return in the response. If not set, returns a Schema with all fields filled out. Set toBASICto omit thedefinition.
getName
Required. The name of the schema to get.
Format isprojects/{project}/schemas/{schema}.
Returns
Type
Description
string
setName
Required. The name of the schema to get.
Format isprojects/{project}/schemas/{schema}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getView
The set of fields to return in the response. If not set, returns a Schema
with all fields filled out. Set toBASICto omit thedefinition.
Returns
Type
Description
int
Enum of typeSchemaView.
setView
The set of fields to return in the response. If not set, returns a Schema
with all fields filled out. Set toBASICto omit thedefinition.
Parameter
Name
Description
var
int
Enum of typeSchemaView.
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The name of the schema to get.
Format isprojects/{project}/schemas/{schema}. Please seeSchemaServiceClient::schemaName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Cloud PubSub V1 Client - Class GetSchemaRequest (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.GetSchemaRequest)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.GetSchemaRequest)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.GetSchemaRequest)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.GetSchemaRequest)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.GetSchemaRequest)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.GetSchemaRequest)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.GetSchemaRequest)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.GetSchemaRequest)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.GetSchemaRequest)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.GetSchemaRequest)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.GetSchemaRequest)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.GetSchemaRequest)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.GetSchemaRequest)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.GetSchemaRequest)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.GetSchemaRequest)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.GetSchemaRequest)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.GetSchemaRequest)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.GetSchemaRequest)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.GetSchemaRequest)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.GetSchemaRequest)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.GetSchemaRequest)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.GetSchemaRequest)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.GetSchemaRequest)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.GetSchemaRequest)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.GetSchemaRequest)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.GetSchemaRequest) \nReference documentation and code samples for the Cloud PubSub V1 Client class GetSchemaRequest.\n\nRequest for the GetSchema method.\n\nGenerated from protobuf message `google.pubsub.v1.GetSchemaRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The name of the schema to get.\n\nFormat is `projects/{project}/schemas/{schema}`.\n\n### setName\n\nRequired. The name of the schema to get.\n\nFormat is `projects/{project}/schemas/{schema}`.\n\n### getView\n\nThe set of fields to return in the response. If not set, returns a Schema\nwith all fields filled out. Set to `BASIC` to omit the `definition`.\n\n### setView\n\nThe set of fields to return in the response. If not set, returns a Schema\nwith all fields filled out. Set to `BASIC` to omit the `definition`.\n\n### static::build"]]
