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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The name of the project in which to validate schemas. Format is |
↳ name |
string
Name of the schema against which to validate. Format is |
↳ schema |
Google\Cloud\PubSub\V1\Schema
Ad-hoc schema against which to validate |
↳ message |
string
Message to validate against the provided |
↳ encoding |
int
The encoding expected for messages |
getParent
Required. The name of the project in which to validate schemas.
Format is projects/{project-id}.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The name of the project in which to validate schemas.
Format is projects/{project-id}.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
Name of the schema against which to validate.
Format is projects/{project}/schemas/{schema}.
Generated from protobuf field string name = 2 [(.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
setName
Name of the schema against which to validate.
Format is projects/{project}/schemas/{schema}.
Generated from protobuf field string name = 2 [(.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchema
Ad-hoc schema against which to validate
Generated from protobuf field .google.pubsub.v1.Schema schema = 3;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\PubSub\V1\Schema|null | |
hasSchema
setSchema
Ad-hoc schema against which to validate
Generated from protobuf field .google.pubsub.v1.Schema schema = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\PubSub\V1\Schema
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMessage
Message to validate against the provided schema_spec.
Generated from protobuf field bytes message = 4;
| Returns | |
|---|---|
| Type | Description |
string | |
setMessage
Message to validate against the provided schema_spec.
Generated from protobuf field bytes message = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncoding
The encoding expected for messages
Generated from protobuf field .google.pubsub.v1.Encoding encoding = 5;
| Returns | |
|---|---|
| Type | Description |
int | |
setEncoding
The encoding expected for messages
Generated from protobuf field .google.pubsub.v1.Encoding encoding = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSchemaSpec
| Returns | |
|---|---|
| Type | Description |
string | |