Cloud PubSub V1 Client - Class ValidateMessageRequest (1.43.2)

Reference documentation and code samples for the Cloud PubSub V1 Client class ValidateMessageRequest.

Request for the ValidateMessage method.

Generated from protobuf message google.pubsub.v1.ValidateMessageRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The name of the project in which to validate schemas. Format is projects/{project-id}.

↳ name string

Name of the schema against which to validate. Format is projects/{project}/schemas/{schema}.

↳ schema Google\Cloud\PubSub\V1\Schema

Ad-hoc schema against which to validate

↳ message string

Message to validate against the provided schema_spec.

↳ encoding int

The encoding expected for messages

getParent

Required. The name of the project in which to validate schemas.

Format is projects/{project-id}.

Returns
TypeDescription
string

setParent

Required. The name of the project in which to validate schemas.

Format is projects/{project-id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

Name of the schema against which to validate.

Format is projects/{project}/schemas/{schema}.

Returns
TypeDescription
string

hasName

setName

Name of the schema against which to validate.

Format is projects/{project}/schemas/{schema}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSchema

Ad-hoc schema against which to validate

Returns
TypeDescription
Google\Cloud\PubSub\V1\Schema|null

hasSchema

setSchema

Ad-hoc schema against which to validate

Parameter
NameDescription
var Google\Cloud\PubSub\V1\Schema
Returns
TypeDescription
$this

getMessage

Message to validate against the provided schema_spec.

Returns
TypeDescription
string

setMessage

Message to validate against the provided schema_spec.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEncoding

The encoding expected for messages

Returns
TypeDescription
int

setEncoding

The encoding expected for messages

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getSchemaSpec

Returns
TypeDescription
string