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

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

Method Details

close()

Close httplib2 connections.

delete(name, permanent=None, x__xgafv=None)

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

Args:
  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}` (required)
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  "data": "A String", # The HTTP request/response body as raw binary.
  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
    {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  ],
}

list(parent, deleted=None, subjectPrefix=None, x__xgafv=None)

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

Args:
  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}` (required)
  deleted: boolean, Optional. If true, the response will include soft-deleted subjects. The default is false.
  subjectPrefix: 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
  "data": "A String", # The HTTP request/response body as raw binary.
  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
    {
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
  ],
}

lookupVersion(parent, body=None, x__xgafv=None)

Lookup a schema under the specified subject.

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

{ # Request for LookupVersion.
  "deleted": True or False, # 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.
  "normalize": True or False, # Optional. If true, the schema will be normalized before being looked up. The default is false.
  "references": [ # Optional. The schema references used by the schema.
    { # SchemaReference is a reference to a schema.
      "name": "A String", # Required. The name of the reference.
      "subject": "A String", # Required. The subject of the reference.
      "version": 42, # Required. The version of the reference.
    },
  ],
  "schema": "A String", # Required. The schema payload
  "schemaType": "A String", # Optional. The schema type of the schema.
}

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

Returns:
  An object of the form:

    { # Version of a schema.
  "id": 42, # Required. The schema ID.
  "references": [ # Optional. The schema references used by the schema.
    { # SchemaReference is a reference to a schema.
      "name": "A String", # Required. The name of the reference.
      "subject": "A String", # Required. The subject of the reference.
      "version": 42, # Required. The version of the reference.
    },
  ],
  "schema": "A String", # Required. The schema payload.
  "schemaType": "A String", # Optional. The schema type of the schema.
  "subject": "A String", # Required. The subject of the version.
  "version": 42, # Required. The version ID
}

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

Instance Methods

Method Details