Cloud PubSub V1 Client - Class SchemaSettings (2.1.2)

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

setEncoding

Optional. The encoding of messages validated against schema .

Parameter
Name
Description
var
int
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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: