Cloud PubSub V1 Client - Class SchemaSettings (1.40.1)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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

The encoding of messages validated against schema.

↳ first_revision_id string

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

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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getEncoding

The encoding of messages validated against schema.

Returns
TypeDescription
int

setEncoding

The encoding of messages validated against schema.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFirstRevisionId

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
TypeDescription
string

setFirstRevisionId

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
NameDescription
var string
Returns
TypeDescription
$this

getLastRevisionId

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
TypeDescription
string

setLastRevisionId

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this