# Managed Service for Apache Kafka V1 API - Class Google::Cloud::ManagedKafka::SchemaRegistry::V1::CheckCompatibilityRequest (v0.5.0)

0.5.0 (latest) 0.4.0 0.3.0 0.2.1 0.1.0 Reference documentation and code samples for the Managed Service for Apache Kafka V1 API class Google::Cloud::ManagedKafka::SchemaRegistry::V1::CheckCompatibilityRequest.

Request for CheckCompatibility.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #name

    def name() -> ::String

**Returns**

- (::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.

### #name=

    def name=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #references

    def references() -> ::Array<::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaReference>

**Returns**

- (::Array\<[::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaReference](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-managed_kafka-schema_registry-v1/latest/Google-Cloud-ManagedKafka-SchemaRegistry-V1-Schema-SchemaReference)\>) --- Optional. The schema references used by the schema.

### #references=

    def references=(value) -> ::Array<::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaReference>

**Parameter**

- **value** (::Array\<[::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaReference](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-managed_kafka-schema_registry-v1/latest/Google-Cloud-ManagedKafka-SchemaRegistry-V1-Schema-SchemaReference)\>) --- Optional. The schema references used by the schema.
**Returns**

- (::Array\<[::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaReference](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-managed_kafka-schema_registry-v1/latest/Google-Cloud-ManagedKafka-SchemaRegistry-V1-Schema-SchemaReference)\>) --- Optional. The schema references used by the schema.

### #schema

    def schema() -> ::String

**Returns**

- (::String) --- Required. The schema payload

### #schema=

    def schema=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The schema payload
**Returns**

- (::String) --- Required. The schema payload

### #schema_type

    def schema_type() -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaType

**Returns**

- ([::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-managed_kafka-schema_registry-v1/latest/Google-Cloud-ManagedKafka-SchemaRegistry-V1-Schema-SchemaType)) --- Optional. The schema type of the schema.

### #schema_type=

    def schema_type=(value) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaType

**Parameter**

- **value** ([::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-managed_kafka-schema_registry-v1/latest/Google-Cloud-ManagedKafka-SchemaRegistry-V1-Schema-SchemaType)) --- Optional. The schema type of the schema.
**Returns**

- ([::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-managed_kafka-schema_registry-v1/latest/Google-Cloud-ManagedKafka-SchemaRegistry-V1-Schema-SchemaType)) --- Optional. The schema type of the schema.

### #verbose

    def verbose() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.

### #verbose=

    def verbose=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.
**Returns**

- (::Boolean) --- Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.