Managed Service for Apache Kafka V1 API - Class Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client (v0.1.0)

Reference documentation and code samples for the Managed Service for Apache Kafka V1 API class Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.

Client for the ManagedSchemaRegistry service.

SchemaRegistry is a service that allows users to manage schemas for their Kafka clusters. It provides APIs to register, list, and delete schemas, as well as to get the schema for a given schema id or a given version id under a subject, to update the global or subject-specific compatibility mode, and to check the compatibility of a schema against a subject or a version. The main resource hierarchy is as follows:

  • SchemaRegistry
  • SchemaRegistry/Context
  • SchemaRegistry/Context/Schema
  • SchemaRegistry/Context/Subject
  • SchemaRegistry/Context/Subject/Version
  • SchemaRegistry/Config
  • SchemaRegistry/Mode

SchemaRegistry is the root resource to represent a schema registry instance. A customer can have multiple schema registry instances in a project.

Context is a context resource that represents a group of schemas, subjects and versions. A schema registry instance can have multiple contexts and always has a 'default' context. Contexts are independent of each other. Context is optional and if not specified, it falls back to the 'default' context.

Schema is a schema resource that represents a unique schema in a context of a schema registry instance. Each schema has a unique schema id, and can be referenced by a version of a subject.

Subject refers to the name under which the schema is registered. A typical subject is the Kafka topic name. A schema registry instance can have multiple subjects.

Version represents a version of a subject. A subject can have multiple versions. Creation of new version of a subject is guarded by the compatibility mode configured globally or for the subject specifically.

Config represents a config at global level cross all registry instances or at subject level. Currently, only compatibility is supported in config.

Mode represents the mode of a schema registry or a specific subject. Three modes are supported:

  • READONLY: The schema registry is in read-only mode, no write operations allowed..
  • READWRITE: The schema registry is in read-write mode, which allows limited write operations on the schema.
  • IMPORT: The schema registry is in import mode, which allows more editing operations on the schema for data importing purposes.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ManagedSchemaRegistry Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ManagedSchemaRegistry clients
::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.configure do |config|
  config.timeout = 10.0
end

#check_compatibility

def check_compatibility(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CheckCompatibilityResponse
def check_compatibility(name: nil, schema_type: nil, schema: nil, references: nil, verbose: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CheckCompatibilityResponse

Check compatibility of a schema with all versions or a specific version of a subject.

Overloads 
def check_compatibility(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CheckCompatibilityResponse
Pass arguments to check_compatibility via a request object, either of type CheckCompatibilityRequest or an equivalent Hash.
Parameters 
def check_compatibility(name: nil, schema_type: nil, schema: nil, references: nil, verbose: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CheckCompatibilityResponse
Pass arguments to check_compatibility via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • 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 (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaType) — Optional. The schema type of the schema.
  • schema (::String) — Required. The schema payload
  • references (::Array<::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaReference, ::Hash>) — Optional. The schema references used by the schema.
  • verbose (::Boolean) — Optional. If true, the response will contain the compatibility check result with reasons for failed checks. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::CheckCompatibilityRequest.new

# Call the check_compatibility method.
result = client.check_compatibility request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::CheckCompatibilityResponse.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ManagedSchemaRegistry Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_schema_registry

def create_schema_registry(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry
def create_schema_registry(parent: nil, schema_registry_id: nil, schema_registry: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry

Create a schema registry instance.

Overloads 
def create_schema_registry(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry
Pass arguments to create_schema_registry via a request object, either of type CreateSchemaRegistryRequest or an equivalent Hash.
Parameters 
def create_schema_registry(parent: nil, schema_registry_id: nil, schema_registry: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry
Pass arguments to create_schema_registry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent whose schema registry instance is to be created. Structured like: projects/{project}/locations/{location}
  • schema_registry_id (::String) — Required. The schema registry instance ID to use for this schema registry. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (-). The maximum length is 63 characters. The ID must not start with a number.
  • schema_registry (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry, ::Hash) — Required. The schema registry instance to create. The name field is ignored.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::CreateSchemaRegistryRequest.new

# Call the create_schema_registry method.
result = client.create_schema_registry request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry.
p result

#create_version

def create_version(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CreateVersionResponse
def create_version(parent: nil, version: nil, id: nil, schema_type: nil, schema: nil, references: nil, normalize: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CreateVersionResponse

Register a new version under a given subject with the given schema.

Overloads 
def create_version(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CreateVersionResponse
Pass arguments to create_version via a request object, either of type CreateVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CreateVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_version(parent: nil, version: nil, id: nil, schema_type: nil, schema: nil, references: nil, normalize: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::CreateVersionResponse
Pass arguments to create_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The subject to create the version for. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}
  • version (::Integer) — Optional. The version to create. It is optional. If not specified, the version will be created with the max version ID of the subject increased by 1. If the version ID is specified, it will be used as the new version ID and must not be used by an existing version of the subject.
  • id (::Integer) — Optional. The schema ID of the schema. If not specified, the schema ID will be generated by the server. If the schema ID is specified, it must not be used by an existing schema that is different from the schema to be created.
  • schema_type (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaType) — Optional. The type of the schema. It is optional. If not specified, the schema type will be AVRO.
  • schema (::String) — Required. The schema payload
  • references (::Array<::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaReference, ::Hash>) — Optional. The schema references used by the schema.
  • normalize (::Boolean) — Optional. If true, the schema will be normalized before being stored. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::CreateVersionRequest.new

# Call the create_version method.
result = client.create_version request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::CreateVersionResponse.
p result

#delete_schema_config

def delete_schema_config(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
def delete_schema_config(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig

Delete schema config for a subject.

Overloads 
def delete_schema_config(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
Pass arguments to delete_schema_config via a request object, either of type DeleteSchemaConfigRequest or an equivalent Hash.
Parameters 
def delete_schema_config(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
Pass arguments to delete_schema_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • 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}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::DeleteSchemaConfigRequest.new

# Call the delete_schema_config method.
result = client.delete_schema_config request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig.
p result

#delete_schema_mode

def delete_schema_mode(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
def delete_schema_mode(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode

Delete schema mode for a subject.

Overloads 
def delete_schema_mode(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
Pass arguments to delete_schema_mode via a request object, either of type DeleteSchemaModeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::DeleteSchemaModeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_schema_mode(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
Pass arguments to delete_schema_mode via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) —

    Required. The resource name of subject to delete the mode for. The format is

    • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}
    • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::DeleteSchemaModeRequest.new

# Call the delete_schema_mode method.
result = client.delete_schema_mode request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode.
p result

#delete_schema_registry

def delete_schema_registry(request, options = nil) -> ::Google::Protobuf::Empty
def delete_schema_registry(name: nil) -> ::Google::Protobuf::Empty

Delete a schema registry instance.

Overloads 
def delete_schema_registry(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_schema_registry via a request object, either of type DeleteSchemaRegistryRequest or an equivalent Hash.
Parameters 
def delete_schema_registry(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to delete_schema_registry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the schema registry instance to delete. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::DeleteSchemaRegistryRequest.new

# Call the delete_schema_registry method.
result = client.delete_schema_registry request

# The returned object is of type Google::Protobuf::Empty.
p result

#delete_subject

def delete_subject(request, options = nil) -> ::Google::Api::HttpBody
def delete_subject(name: nil, permanent: nil) -> ::Google::Api::HttpBody

Delete a subject. The response will be an array of versions of the deleted subject.

Overloads 
def delete_subject(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to delete_subject via a request object, either of type DeleteSubjectRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::DeleteSubjectRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_subject(name: nil, permanent: nil) -> ::Google::Api::HttpBody
Pass arguments to delete_subject via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the subject to delete. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}
  • permanent (::Boolean) — Optional. If true, the subject and all associated metadata including the schema ID will be deleted permanently. Otherwise, only the subject is soft-deleted. The default is false. Soft-deleted subjects can still be searched in ListSubjects API call with deleted=true query parameter. A soft-delete of a subject must be performed before a hard-delete.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::DeleteSubjectRequest.new

# Call the delete_subject method.
result = client.delete_subject request

# The returned object is of type Google::Api::HttpBody.
p result

#delete_version

def delete_version(request, options = nil) -> ::Google::Api::HttpBody
def delete_version(name: nil, permanent: nil) -> ::Google::Api::HttpBody

Delete a version of a subject. The response will be the deleted version id.

Overloads 
def delete_version(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to delete_version via a request object, either of type DeleteVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::DeleteVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def delete_version(name: nil, permanent: nil) -> ::Google::Api::HttpBody
Pass arguments to delete_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the subject version to delete. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}
  • permanent (::Boolean) — Optional. If true, both the version and the referenced schema ID will be permanently deleted. The default is false. If false, the version will be deleted but the schema ID will be retained. Soft-deleted versions can still be searched in ListVersions API call with deleted=true query parameter. A soft-delete of a version must be performed before a hard-delete.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::DeleteVersionRequest.new

# Call the delete_version method.
result = client.delete_version request

# The returned object is of type Google::Api::HttpBody.
p result

#get_context

def get_context(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Context
def get_context(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Context

Get the context.

Overloads 
def get_context(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Context
Pass arguments to get_context via a request object, either of type GetContextRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetContextRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_context(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Context
Pass arguments to get_context via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the context to return. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetContextRequest.new

# Call the get_context method.
result = client.get_context request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::Context.
p result

#get_raw_schema

def get_raw_schema(request, options = nil) -> ::Google::Api::HttpBody
def get_raw_schema(name: nil, subject: nil) -> ::Google::Api::HttpBody

Get the schema string for the given schema id. The response will be the schema string.

Overloads 
def get_raw_schema(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to get_raw_schema via a request object, either of type GetSchemaRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_raw_schema(name: nil, subject: nil) -> ::Google::Api::HttpBody
Pass arguments to get_raw_schema via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the schema to return. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}
  • subject (::String) — Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaRequest.new

# Call the get_raw_schema method.
result = client.get_raw_schema request

# The returned object is of type Google::Api::HttpBody.
p result

#get_raw_schema_version

def get_raw_schema_version(request, options = nil) -> ::Google::Api::HttpBody
def get_raw_schema_version(name: nil, deleted: nil) -> ::Google::Api::HttpBody

Get the schema string only for a version of a subject. The response will be the schema string.

Overloads 
def get_raw_schema_version(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to get_raw_schema_version via a request object, either of type GetVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_raw_schema_version(name: nil, deleted: nil) -> ::Google::Api::HttpBody
Pass arguments to get_raw_schema_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the subject to return versions. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}
  • deleted (::Boolean) — Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetVersionRequest.new

# Call the get_raw_schema_version method.
result = client.get_raw_schema_version request

# The returned object is of type Google::Api::HttpBody.
p result

#get_schema

def get_schema(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema
def get_schema(name: nil, subject: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema

Get the schema for the given schema id.

Overloads 
def get_schema(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema
Pass arguments to get_schema via a request object, either of type GetSchemaRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_schema(name: nil, subject: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema
Pass arguments to get_schema via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the schema to return. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema}
  • subject (::String) — Optional. Used to limit the search for the schema ID to a specific subject, otherwise the schema ID will be searched for in all subjects in the given specified context.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaRequest.new

# Call the get_schema method.
result = client.get_schema request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema.
p result

#get_schema_config

def get_schema_config(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
def get_schema_config(name: nil, default_to_global: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig

Get schema config at global level or for a subject.

Overloads 
def get_schema_config(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
Pass arguments to get_schema_config via a request object, either of type GetSchemaConfigRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaConfigRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_schema_config(name: nil, default_to_global: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
Pass arguments to get_schema_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • 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.
  • default_to_global (::Boolean) — Optional. If true, the config will fall back to the config at the global level if no subject level config is found.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaConfigRequest.new

# Call the get_schema_config method.
result = client.get_schema_config request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig.
p result

#get_schema_mode

def get_schema_mode(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
def get_schema_mode(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode

Get mode at global level or for a subject.

Overloads 
def get_schema_mode(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
Pass arguments to get_schema_mode via a request object, either of type GetSchemaModeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaModeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_schema_mode(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
Pass arguments to get_schema_mode via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) —

    Required. The resource name of the mode. The format is

    • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or
    • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaModeRequest.new

# Call the get_schema_mode method.
result = client.get_schema_mode request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode.
p result

#get_schema_registry

def get_schema_registry(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry
def get_schema_registry(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry

Get the schema registry instance.

Overloads 
def get_schema_registry(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry
Pass arguments to get_schema_registry via a request object, either of type GetSchemaRegistryRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaRegistryRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_schema_registry(name: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry
Pass arguments to get_schema_registry via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. The name of the schema registry instance to return. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetSchemaRegistryRequest.new

# Call the get_schema_registry method.
result = client.get_schema_registry request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaRegistry.
p result

#get_version

def get_version(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion
def get_version(name: nil, deleted: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion

Get a versioned schema (schema with subject/version) of a subject.

Overloads 
def get_version(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion
Pass arguments to get_version via a request object, either of type GetVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_version(name: nil, deleted: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion
Pass arguments to get_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. The name of the subject to return versions. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}
  • deleted (::Boolean) — Optional. If true, no matter if the subject/version is soft-deleted or not, it returns the version details. If false, it returns NOT_FOUND error if the subject/version is soft-deleted. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::GetVersionRequest.new

# Call the get_version method.
result = client.get_version request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new ManagedSchemaRegistry client object.

Yields
  • (config) — Configure the ManagedSchemaRegistry client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new do |config|
  config.timeout = 10.0
end

#list_contexts

def list_contexts(request, options = nil) -> ::Google::Api::HttpBody
def list_contexts(parent: nil) -> ::Google::Api::HttpBody

List contexts for a schema registry.

Overloads 
def list_contexts(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to list_contexts via a request object, either of type ListContextsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListContextsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_contexts(parent: nil) -> ::Google::Api::HttpBody
Pass arguments to list_contexts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • parent (::String) — Required. The parent of the contexts. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListContextsRequest.new

# Call the list_contexts method.
result = client.list_contexts request

# The returned object is of type Google::Api::HttpBody.
p result

#list_referenced_schemas

def list_referenced_schemas(request, options = nil) -> ::Google::Api::HttpBody
def list_referenced_schemas(parent: nil) -> ::Google::Api::HttpBody

Get a list of IDs of schemas that reference the schema with the given subject and version.

Overloads 
def list_referenced_schemas(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to list_referenced_schemas via a request object, either of type ListReferencedSchemasRequest or an equivalent Hash.
Parameters 
def list_referenced_schemas(parent: nil) -> ::Google::Api::HttpBody
Pass arguments to list_referenced_schemas via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • parent (::String) — Required. The version to list referenced by. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject}/versions/{version} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}/versions/{version}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListReferencedSchemasRequest.new

# Call the list_referenced_schemas method.
result = client.list_referenced_schemas request

# The returned object is of type Google::Api::HttpBody.
p result

#list_schema_registries

def list_schema_registries(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaRegistriesResponse
def list_schema_registries(parent: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaRegistriesResponse

List schema registries.

Overloads 
def list_schema_registries(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaRegistriesResponse
Pass arguments to list_schema_registries via a request object, either of type ListSchemaRegistriesRequest or an equivalent Hash.
Parameters 
def list_schema_registries(parent: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaRegistriesResponse
Pass arguments to list_schema_registries via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • parent (::String) — Required. The parent whose schema registry instances are to be listed. Structured like: projects/{project}/locations/{location}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaRegistriesRequest.new

# Call the list_schema_registries method.
result = client.list_schema_registries request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaRegistriesResponse.
p result

#list_schema_types

def list_schema_types(request, options = nil) -> ::Google::Api::HttpBody
def list_schema_types(parent: nil) -> ::Google::Api::HttpBody

List the supported schema types. The response will be an array of schema types.

Overloads 
def list_schema_types(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to list_schema_types via a request object, either of type ListSchemaTypesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaTypesRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_schema_types(parent: nil) -> ::Google::Api::HttpBody
Pass arguments to list_schema_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • parent (::String) — Required. The parent schema registry whose schema types are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaTypesRequest.new

# Call the list_schema_types method.
result = client.list_schema_types request

# The returned object is of type Google::Api::HttpBody.
p result

#list_schema_versions

def list_schema_versions(request, options = nil) -> ::Google::Api::HttpBody
def list_schema_versions(parent: nil, subject: nil, deleted: nil) -> ::Google::Api::HttpBody

List the schema versions for the given schema id. The response will be an array of subject-version pairs as: [{"subject":"subject1", "version":1}, {"subject":"subject2", "version":2}].

Overloads 
def list_schema_versions(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to list_schema_versions via a request object, either of type ListSchemaVersionsRequest or an equivalent Hash.
Parameters 
def list_schema_versions(parent: nil, subject: nil, deleted: nil) -> ::Google::Api::HttpBody
Pass arguments to list_schema_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The schema whose schema versions are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}
  • subject (::String) — Optional. The subject to filter the subjects by.
  • deleted (::Boolean) — Optional. If true, the response will include soft-deleted versions of the schema, even if the subject is soft-deleted. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSchemaVersionsRequest.new

# Call the list_schema_versions method.
result = client.list_schema_versions request

# The returned object is of type Google::Api::HttpBody.
p result

#list_subjects

def list_subjects(request, options = nil) -> ::Google::Api::HttpBody
def list_subjects(parent: nil, subject_prefix: nil, deleted: nil) -> ::Google::Api::HttpBody

List subjects in the schema registry. The response will be an array of subject names.

Overloads 
def list_subjects(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to list_subjects via a request object, either of type ListSubjectsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSubjectsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_subjects(parent: nil, subject_prefix: nil, deleted: nil) -> ::Google::Api::HttpBody
Pass arguments to list_subjects via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The parent schema registry/context whose subjects are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}
  • subject_prefix (::String) — Optional. The context to filter the subjects by, in the format of :.{context}:. If unset, all subjects in the registry are returned. Set to empty string or add as '?subjectPrefix=' at the end of this request to list subjects in the default context.
  • deleted (::Boolean) — Optional. If true, the response will include soft-deleted subjects. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSubjectsRequest.new

# Call the list_subjects method.
result = client.list_subjects request

# The returned object is of type Google::Api::HttpBody.
p result

#list_subjects_by_schema_id

def list_subjects_by_schema_id(request, options = nil) -> ::Google::Api::HttpBody
def list_subjects_by_schema_id(parent: nil, subject: nil, deleted: nil) -> ::Google::Api::HttpBody

List subjects which reference a particular schema id. The response will be an array of subject names.

Overloads 
def list_subjects_by_schema_id(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to list_subjects_by_schema_id via a request object, either of type ListSubjectsBySchemaIdRequest or an equivalent Hash.
Parameters 
def list_subjects_by_schema_id(parent: nil, subject: nil, deleted: nil) -> ::Google::Api::HttpBody
Pass arguments to list_subjects_by_schema_id via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The schema resource whose associated subjects are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/schemas/ids/{schema} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/schemas/ids/{schema}
  • subject (::String) — Optional. The subject to filter the subjects by.
  • deleted (::Boolean) — Optional. If true, the response will include soft-deleted subjects. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListSubjectsBySchemaIdRequest.new

# Call the list_subjects_by_schema_id method.
result = client.list_subjects_by_schema_id request

# The returned object is of type Google::Api::HttpBody.
p result

#list_versions

def list_versions(request, options = nil) -> ::Google::Api::HttpBody
def list_versions(parent: nil, deleted: nil) -> ::Google::Api::HttpBody

Get all versions of a subject. The response will be an array of versions of the subject.

Overloads 
def list_versions(request, options = nil) -> ::Google::Api::HttpBody
Pass arguments to list_versions via a request object, either of type ListVersionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListVersionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_versions(parent: nil, deleted: nil) -> ::Google::Api::HttpBody
Pass arguments to list_versions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The subject whose versions are to be listed. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}
  • deleted (::Boolean) — Optional. If true, the response will include soft-deleted versions of an active or soft-deleted subject. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ListVersionsRequest.new

# Call the list_versions method.
result = client.list_versions request

# The returned object is of type Google::Api::HttpBody.
p result

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#lookup_version

def lookup_version(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion
def lookup_version(parent: nil, schema_type: nil, schema: nil, references: nil, normalize: nil, deleted: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion

Lookup a schema under the specified subject.

Overloads 
def lookup_version(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion
Pass arguments to lookup_version via a request object, either of type LookupVersionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::LookupVersionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def lookup_version(parent: nil, schema_type: nil, schema: nil, references: nil, normalize: nil, deleted: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion
Pass arguments to lookup_version via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. The subject to lookup the schema in. Structured like: projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/subjects/{subject} or projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/subjects/{subject}
  • schema_type (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaType) — Optional. The schema type of the schema.
  • schema (::String) — Required. The schema payload
  • references (::Array<::Google::Cloud::ManagedKafka::SchemaRegistry::V1::Schema::SchemaReference, ::Hash>) — Optional. The schema references used by the schema.
  • normalize (::Boolean) — Optional. If true, the schema will be normalized before being looked up. The default is false.
  • deleted (::Boolean) — Optional. If true, soft-deleted versions will be included in lookup, no matter if the subject is active or soft-deleted. If false, soft-deleted versions will be excluded. The default is false.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::LookupVersionRequest.new

# Call the lookup_version method.
result = client.lookup_version request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaVersion.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_schema_config

def update_schema_config(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
def update_schema_config(name: nil, compatibility: nil, normalize: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig

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

Overloads 
def update_schema_config(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
Pass arguments to update_schema_config via a request object, either of type UpdateSchemaConfigRequest or an equivalent Hash.
Parameters 
def update_schema_config(name: nil, compatibility: nil, normalize: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig
Pass arguments to update_schema_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • 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 (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig::CompatibilityType) — 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 (::Boolean) — 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.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::UpdateSchemaConfigRequest.new

# Call the update_schema_config method.
result = client.update_schema_config request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaConfig.
p result

#update_schema_mode

def update_schema_mode(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
def update_schema_mode(name: nil, mode: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode

Update mode at global level or for a subject.

Overloads 
def update_schema_mode(request, options = nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
Pass arguments to update_schema_mode via a request object, either of type UpdateSchemaModeRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::UpdateSchemaModeRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def update_schema_mode(name: nil, mode: nil) -> ::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode
Pass arguments to update_schema_mode via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) —

    Required. The resource name of the mode. The format is

    • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/mode/{subject}: mode for a schema registry, or
    • projects/{project}/locations/{location}/schemaRegistries/{schema_registry}/contexts/{context}/mode/{subject}: mode for a specific subject in a specific context
  • mode (::Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode::ModeType) — Required. The mode type.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/managed_kafka/schema_registry/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::ManagedKafka::SchemaRegistry::V1::ManagedSchemaRegistry::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::ManagedKafka::SchemaRegistry::V1::UpdateSchemaModeRequest.new

# Call the update_schema_mode method.
result = client.update_schema_mode request

# The returned object is of type Google::Cloud::ManagedKafka::SchemaRegistry::V1::SchemaMode.
p result