Managed Service for Apache Kafka API . projects . locations . schemaRegistries . config

Instance Methods

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Delete schema config for a subject.

get(name, defaultToGlobal=None, x__xgafv=None)

Get schema config at global level or for a subject.

update(name, body=None, x__xgafv=None)

Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.

Method Details

close()
Close httplib2 connections.
delete(name, x__xgafv=None)
Delete schema config for a subject.

Args:
  name: string, Required. The resource name of subject to delete the config for. The format is * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # SchemaConfig represents configuration for a schema registry or a specific subject.
  "alias": "A String", # Optional. The subject to which this subject is an alias of. Only applicable for subject config.
  "compatibility": "A String", # Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
  "normalize": True or False, # Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
}
get(name, defaultToGlobal=None, x__xgafv=None)
Get schema config at global level or for a subject.

Args:
  name: string, Required. The resource name to get the config for. It can be either of following: * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config: Get config at global level. * projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/config/{subject}: Get config for a specific subject. (required)
  defaultToGlobal: boolean, Optional. If true, the config will fall back to the config at the global level if no subject level config is found.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # SchemaConfig represents configuration for a schema registry or a specific subject.
  "alias": "A String", # Optional. The subject to which this subject is an alias of. Only applicable for subject config.
  "compatibility": "A String", # Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
  "normalize": True or False, # Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
}
update(name, body=None, x__xgafv=None)
Update config at global level or for a subject. Creates a SchemaSubject-level SchemaConfig if it does not exist.

Args:
  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. (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for updating schema config. On a SchemaSubject-level SchemaConfig, an unset field will be removed from the SchemaConfig.
  "compatibility": "A String", # 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": True or False, # 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.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # SchemaConfig represents configuration for a schema registry or a specific subject.
  "alias": "A String", # Optional. The subject to which this subject is an alias of. Only applicable for subject config.
  "compatibility": "A String", # Required. The compatibility type of the schema. The default value is BACKWARD. If unset in a SchemaSubject-level SchemaConfig, defaults to the global value. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
  "normalize": True or False, # Optional. If true, the schema will be normalized before being stored or looked up. The default is false. If unset in a SchemaSubject-level SchemaConfig, the global value will be used. If unset in a SchemaRegistry-level SchemaConfig, reverts to the default value.
}