Reference documentation and code samples for the Cloud PubSub V1 Client class SchemaSettings.
Settings for validating messages published against a schema.
Generated from protobuf message google.pubsub.v1.SchemaSettings
Namespace
Google \ Cloud \ PubSub \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ schema
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.
↳ encoding
int
Optional. The encoding of messages validated against schema.
↳ first_revision_id
string
Optional. The minimum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against last_revision or any revision created before.
↳ last_revision_id
string
Optional. The maximum (inclusive) revision allowed for validating messages. If empty or not present, allow any revision to be validated against first_revision or any revision created after.
getSchema
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.
Returns
Type
Description
string
setSchema
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getEncoding
Optional. The encoding of messages validated against schema.
Returns
Type
Description
int
Enum of type Encoding.
setEncoding
Optional. The encoding of messages validated against schema.
Parameter
Name
Description
var
int
Enum of type Encoding.
Returns
Type
Description
$this
getFirstRevisionId
Optional. The minimum (inclusive) revision allowed for validating messages.
If empty or not present, allow any revision to be validated against
last_revision or any revision created before.
Returns
Type
Description
string
setFirstRevisionId
Optional. The minimum (inclusive) revision allowed for validating messages.
If empty or not present, allow any revision to be validated against
last_revision or any revision created before.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLastRevisionId
Optional. The maximum (inclusive) revision allowed for validating messages.
If empty or not present, allow any revision to be validated against
first_revision or any revision created after.
Returns
Type
Description
string
setLastRevisionId
Optional. The maximum (inclusive) revision allowed for validating messages.
If empty or not present, allow any revision to be validated against
first_revision or any revision created after.
[[["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 SchemaSettings (2.13.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.13.2 (latest)](/php/docs/reference/cloud-pubsub/latest/V1.SchemaSettings)\n- [2.13.1](/php/docs/reference/cloud-pubsub/2.13.1/V1.SchemaSettings)\n- [2.12.0](/php/docs/reference/cloud-pubsub/2.12.0/V1.SchemaSettings)\n- [2.11.3](/php/docs/reference/cloud-pubsub/2.11.3/V1.SchemaSettings)\n- [2.10.1](/php/docs/reference/cloud-pubsub/2.10.1/V1.SchemaSettings)\n- [2.9.1](/php/docs/reference/cloud-pubsub/2.9.1/V1.SchemaSettings)\n- [2.8.2](/php/docs/reference/cloud-pubsub/2.8.2/V1.SchemaSettings)\n- [2.7.0](/php/docs/reference/cloud-pubsub/2.7.0/V1.SchemaSettings)\n- [2.6.0](/php/docs/reference/cloud-pubsub/2.6.0/V1.SchemaSettings)\n- [2.5.2](/php/docs/reference/cloud-pubsub/2.5.2/V1.SchemaSettings)\n- [2.4.0](/php/docs/reference/cloud-pubsub/2.4.0/V1.SchemaSettings)\n- [2.3.0](/php/docs/reference/cloud-pubsub/2.3.0/V1.SchemaSettings)\n- [2.2.1](/php/docs/reference/cloud-pubsub/2.2.1/V1.SchemaSettings)\n- [2.1.2](/php/docs/reference/cloud-pubsub/2.1.2/V1.SchemaSettings)\n- [1.50.0](/php/docs/reference/cloud-pubsub/1.50.0/V1.SchemaSettings)\n- [1.49.0](/php/docs/reference/cloud-pubsub/1.49.0/V1.SchemaSettings)\n- [1.48.0](/php/docs/reference/cloud-pubsub/1.48.0/V1.SchemaSettings)\n- [1.47.0](/php/docs/reference/cloud-pubsub/1.47.0/V1.SchemaSettings)\n- [1.46.5](/php/docs/reference/cloud-pubsub/1.46.5/V1.SchemaSettings)\n- [1.45.2](/php/docs/reference/cloud-pubsub/1.45.2/V1.SchemaSettings)\n- [1.44.0](/php/docs/reference/cloud-pubsub/1.44.0/V1.SchemaSettings)\n- [1.43.2](/php/docs/reference/cloud-pubsub/1.43.2/V1.SchemaSettings)\n- [1.42.1](/php/docs/reference/cloud-pubsub/1.42.1/V1.SchemaSettings)\n- [1.41.3](/php/docs/reference/cloud-pubsub/1.41.3/V1.SchemaSettings)\n- [1.40.1](/php/docs/reference/cloud-pubsub/1.40.1/V1.SchemaSettings)\n- [1.39.3](/php/docs/reference/cloud-pubsub/1.39.3/V1.SchemaSettings) \nReference documentation and code samples for the Cloud PubSub V1 Client class SchemaSettings.\n\nSettings for validating messages published against a schema.\n\nGenerated from protobuf message `google.pubsub.v1.SchemaSettings`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ PubSub \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getSchema\n\nRequired. The name of the schema that messages published should be\nvalidated against. Format is `projects/{project}/schemas/{schema}`. The\nvalue of this field will be `_deleted-schema_` if the schema has been\ndeleted.\n\n### setSchema\n\nRequired. The name of the schema that messages published should be\nvalidated against. Format is `projects/{project}/schemas/{schema}`. The\nvalue of this field will be `_deleted-schema_` if the schema has been\ndeleted.\n\n### getEncoding\n\nOptional. The encoding of messages validated against `schema`.\n\n### setEncoding\n\nOptional. The encoding of messages validated against `schema`.\n\n### getFirstRevisionId\n\nOptional. The minimum (inclusive) revision allowed for validating messages.\n\nIf empty or not present, allow any revision to be validated against\nlast_revision or any revision created before.\n\n### setFirstRevisionId\n\nOptional. The minimum (inclusive) revision allowed for validating messages.\n\nIf empty or not present, allow any revision to be validated against\nlast_revision or any revision created before.\n\n### getLastRevisionId\n\nOptional. The maximum (inclusive) revision allowed for validating messages.\n\nIf empty or not present, allow any revision to be validated against\nfirst_revision or any revision created after.\n\n### setLastRevisionId\n\nOptional. The maximum (inclusive) revision allowed for validating messages.\n\nIf empty or not present, allow any revision to be validated against\nfirst_revision or any revision created after."]]
