Reference documentation and code samples for the Google Cloud Managed Kafka Schema Registry V1 Client class CheckCompatibilityRequest.
Request for CheckCompatibility.
Generated from protobuf message google.cloud.managedkafka.schemaregistry.v1.CheckCompatibilityRequest
Namespace
Google \ Cloud \ ManagedKafka \ SchemaRegistry \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. The name of the resource to check compatibility for. The format is either of following: * * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject. * * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/{subject}/versions/{version}: Check compatibility with a specific version of the subject. |
↳ schema_type |
int
Optional. The schema type of the schema. |
↳ schema |
string
Required. The schema payload |
↳ references |
array<Schema\SchemaReference>
Optional. The schema references used by the schema. |
↳ verbose |
bool
Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false. |
getName
Required. The name of the resource to check compatibility for. The format is either of following:
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject.
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/{subject}/versions/{version}: Check compatibility with a specific version of the subject.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. The name of the resource to check compatibility for. The format is either of following:
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/*/versions: Check compatibility with one or more versions of the specified subject.
projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/compatibility/subjects/{subject}/versions/{version}: Check compatibility with a specific version of the subject.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchemaType
Optional. The schema type of the schema.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasSchemaType
clearSchemaType
setSchemaType
Optional. The schema type of the schema.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSchema
Required. The schema payload
| Returns | |
|---|---|
| Type | Description |
string |
|
setSchema
Required. The schema payload
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReferences
Optional. The schema references used by the schema.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setReferences
Optional. The schema references used by the schema.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Schema\SchemaReference>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVerbose
Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasVerbose
clearVerbose
setVerbose
Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. The name of the resource to check compatibility for. The format is either of following:
|
schema |
string
Required. The schema payload |
| Returns | |
|---|---|
| Type | Description |
CheckCompatibilityRequest |
|