Google Cloud Managed Kafka Schema Registry V1 Client - Class UpdateSchemaConfigRequest (0.1.1)

Reference documentation and code samples for the Google Cloud Managed Kafka Schema Registry V1 Client class UpdateSchemaConfigRequest.

Request for updating schema config.

On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig.

Generated from protobuf message google.cloud.managedkafka.schemaregistry.v1.UpdateSchemaConfigRequest

Namespace

Google \ Cloud \ ManagedKafka \ SchemaRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The resource name to update the config for. It can be either of following: * * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Update config at global level. * * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Update config for a specific subject.
↳ compatibility int

Required. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.
↳ normalize bool

Optional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.

getName

Required. The resource name to update the config for. It can be either of following:

  • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Update config at global level.
  • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Update config for a specific subject.
Returns
Type Description
string

setName

Required. The resource name to update the config for. It can be either of following:

  • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Update config at global level.
  • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Update config for a specific subject.
Parameter
Name Description
var string
Returns
Type Description
$this

getCompatibility

Required. The compatibility type of the schemas.

Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.

Returns
Type Description
int

hasCompatibility

clearCompatibility

setCompatibility

Required. The compatibility type of the schemas.

Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig.

Parameter
Name Description
var int
Returns
Type Description
$this

getNormalize

Optional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.

Returns
Type Description
bool

hasNormalize

clearNormalize

setNormalize

Optional. If true, the schema will be normalized before being stored or looked up. The default is false. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the normalize field for the SchemaConfig.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. The resource name to update the config for. It can be either of following:

  • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Update config at global level.
  • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Update config for a specific subject. Please see ManagedSchemaRegistryClient::schemaConfigName() for help formatting this field.
compatibility int

Required. The compatibility type of the schemas. Cannot be unset for a SchemaRegistry-level SchemaConfig. If unset on a SchemaSubject-level SchemaConfig, removes the compatibility field for the SchemaConfig. For allowed values, use constants defined on SchemaConfig\CompatibilityType
Returns
Type Description
UpdateSchemaConfigRequest