Confluent Stream Catalog GraphQL API Reference

The Confluent Stream Catalog provides a centralized repository of schemas and other metadata entities within an environment, as well as the relationships between them. When querying for one or more related metadata entities, GraphQL can be used to return all requested metadata entities within a single response.

The full GraphQL API reference for Stream Catalog is provided here.

For a getting started guide and examples, see Stream Catalog GraphQL API.

For an overview of all Stream Catalog features, see Stream Catalog.

API Endpoints

Production:
https://psrc-xxxxx.region.provider.confluent.cloud/catalog/graphql

Queries

`cf_entity`

Type representing a Confluent entity

Returns [cf_entity]

Name	Description
`where` - `cf_entity_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[cf_entity_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query cf_entity($where: cf_entity_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [cf_entity_order], $deleted: Boolean) {
  cf_entity(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    createTime
    name
    doc
    tenant
    schemas {
      ...sr_schemaFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": cf_entity_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 987,
  "offset": 123,
  "order_by": [cf_entity_order],
  "deleted": true
}

Response

{"data": {"cf_entity": [cf_entity]}}

`cf_tenant`

Type representing a Confluent tenant

Returns [cf_tenant]

Name	Description
`where` - `cf_tenant_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[cf_tenant_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query cf_tenant($where: cf_tenant_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [cf_tenant_order], $deleted: Boolean) {
  cf_tenant(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    createTime
    name
    doc
    tenant
    schemas {
      ...sr_schemaFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": cf_tenant_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["xyz789"],
  "limit": 123,
  "offset": 123,
  "order_by": [cf_tenant_order],
  "deleted": true
}

Response

{
  "data": {
    "cf_tenant": [
      {
        "owner": "abc123",
        "userDescription": "xyz789",
        "qualifiedName": "xyz789",
        "displayName": "xyz789",
        "description": "xyz789",
        "updateTime": DateTime,
        "nameLower": "xyz789",
        "createTime": DateTime,
        "name": "abc123",
        "doc": "xyz789",
        "tenant": "xyz789",
        "schemas": [sr_schema],
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["abc123"]
      }
    ]
  }
}

`kafka_logical_cluster`

Type representing a logical Kafka cluster

Returns [kafka_logical_cluster]

Name	Description
`where` - `kafka_logical_cluster_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[kafka_logical_cluster_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query kafka_logical_cluster($where: kafka_logical_cluster_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [kafka_logical_cluster_order], $deleted: Boolean) {
  kafka_logical_cluster(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    availability
    type
    cku
    network
    createTime
    provider
    name
    doc
    id
    region
    tenant
    status
    topics {
      ...kafka_topicFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": kafka_logical_cluster_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 987,
  "offset": 123,
  "order_by": [kafka_logical_cluster_order],
  "deleted": false
}

Response

{
  "data": {
    "kafka_logical_cluster": [
      {
        "owner": "xyz789",
        "userDescription": "abc123",
        "qualifiedName": "xyz789",
        "displayName": "xyz789",
        "description": "xyz789",
        "updateTime": DateTime,
        "nameLower": "xyz789",
        "availability": "abc123",
        "type": "abc123",
        "cku": 123,
        "network": "abc123",
        "createTime": DateTime,
        "provider": "abc123",
        "name": "xyz789",
        "doc": "abc123",
        "id": "abc123",
        "region": "xyz789",
        "tenant": "xyz789",
        "status": status_enum,
        "topics": [kafka_topic],
        "schemas": [sr_schema],
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["xyz789"]
      }
    ]
  }
}

`kafka_topic`

Type representing a Kafka topic

Returns [kafka_topic]

Name	Description
`where` - `kafka_topic_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[kafka_topic_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query kafka_topic($where: kafka_topic_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [kafka_topic_order], $deleted: Boolean) {
  kafka_topic(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    retentionMs
    replicationFactor
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    isInternal
    partitionsCount
    valueSchemaValidation
    retentionBytes
    createTime
    name
    doc
    keySchemaValidation
    id
    tenant
    cleanupPolicy
    schemas {
      ...sr_schemaFragment
    }
    logical_cluster {
      ...kafka_logical_clusterFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": kafka_topic_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 987,
  "offset": 123,
  "order_by": [kafka_topic_order],
  "deleted": false
}

Response

{
  "data": {
    "kafka_topic": [
      {
        "owner": "xyz789",
        "retentionMs": Long,
        "replicationFactor": 987,
        "userDescription": "xyz789",
        "qualifiedName": "xyz789",
        "displayName": "xyz789",
        "description": "xyz789",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "isInternal": true,
        "partitionsCount": 123,
        "valueSchemaValidation": false,
        "retentionBytes": Long,
        "createTime": DateTime,
        "name": "xyz789",
        "doc": "abc123",
        "keySchemaValidation": false,
        "id": "abc123",
        "tenant": "xyz789",
        "cleanupPolicy": kafka_cleanup_policy,
        "schemas": [sr_schema],
        "logical_cluster": kafka_logical_cluster,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["xyz789"]
      }
    ]
  }
}

`sr_array`

Type representing an array datatype

Returns [sr_array]

Name	Description
`where` - `sr_array_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_array_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_array($where: sr_array_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_array_order], $deleted: Boolean) {
  sr_array(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    default
    createTime
    name
    context
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    child_types {
      ...sr_typeFragment
    }
    type {
      ...sr_typeFragment
    }
    parent_type {
      ...sr_typeFragment
    }
    field {
      ...sr_fieldFragment
    }
    array {
      ...sr_arrayFragment
    }
    map_value {
      ...sr_mapFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    map_key {
      ...sr_mapFragment
    }
    combined {
      ...sr_combinedFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_array_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 123,
  "offset": 123,
  "order_by": [sr_array_order],
  "deleted": false
}

Response

{
  "data": {
    "sr_array": [
      {
        "owner": "xyz789",
        "userDescription": "xyz789",
        "qualifiedName": "abc123",
        "displayName": "xyz789",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "default": "xyz789",
        "createTime": DateTime,
        "name": "abc123",
        "context": "abc123",
        "doc": "abc123",
        "id": 987,
        "tenant": "abc123",
        "schema": sr_schema,
        "child_types": [sr_type],
        "type": sr_type,
        "parent_type": sr_type,
        "field": sr_field,
        "array": sr_array,
        "map_value": sr_map,
        "schemas": [sr_schema],
        "map_key": sr_map,
        "combined": sr_combined,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["abc123"]
      }
    ]
  }
}

`sr_combined`

Type representing a combined datatype

Returns [sr_combined]

Name	Description
`where` - `sr_combined_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_combined_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_combined($where: sr_combined_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_combined_order], $deleted: Boolean) {
  sr_combined(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    kind
    description
    updateTime
    nameLower
    default
    createTime
    name
    context
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    types {
      ...sr_typeFragment
    }
    child_types {
      ...sr_typeFragment
    }
    parent_type {
      ...sr_typeFragment
    }
    field {
      ...sr_fieldFragment
    }
    array {
      ...sr_arrayFragment
    }
    map_value {
      ...sr_mapFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    map_key {
      ...sr_mapFragment
    }
    combined {
      ...sr_combinedFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_combined_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 123,
  "offset": 987,
  "order_by": [sr_combined_order],
  "deleted": false
}

Response

{
  "data": {
    "sr_combined": [
      {
        "owner": "xyz789",
        "userDescription": "xyz789",
        "qualifiedName": "xyz789",
        "displayName": "abc123",
        "kind": "abc123",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "default": "abc123",
        "createTime": DateTime,
        "name": "xyz789",
        "context": "xyz789",
        "doc": "xyz789",
        "id": 123,
        "tenant": "xyz789",
        "schema": sr_schema,
        "types": [sr_type],
        "child_types": [sr_type],
        "parent_type": sr_type,
        "field": sr_field,
        "array": sr_array,
        "map_value": sr_map,
        "schemas": [sr_schema],
        "map_key": sr_map,
        "combined": sr_combined,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["xyz789"]
      }
    ]
  }
}

`sr_entity`

Type representing a Schema Registry entity

Returns [sr_entity]

Name	Description
`where` - `sr_entity_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_entity_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_entity($where: sr_entity_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_entity_order], $deleted: Boolean) {
  sr_entity(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    createTime
    name
    context
    doc
    id
    tenant
    schemas {
      ...sr_schemaFragment
    }
    schema {
      ...sr_schemaFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_entity_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["xyz789"],
  "limit": 987,
  "offset": 123,
  "order_by": [sr_entity_order],
  "deleted": true
}

Response

{"data": {"sr_entity": [sr_entity]}}

`sr_enum`

Type representing an enum datatype

Returns [sr_enum]

Name	Description
`where` - `sr_enum_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_enum_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_enum($where: sr_enum_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_enum_order], $deleted: Boolean) {
  sr_enum(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    aliases
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    symbols
    default
    createTime
    name
    context
    namespace
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    field {
      ...sr_fieldFragment
    }
    array {
      ...sr_arrayFragment
    }
    map_value {
      ...sr_mapFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    child_types {
      ...sr_typeFragment
    }
    map_key {
      ...sr_mapFragment
    }
    combined {
      ...sr_combinedFragment
    }
    parent_type {
      ...sr_typeFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_enum_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["xyz789"],
  "limit": 123,
  "offset": 987,
  "order_by": [sr_enum_order],
  "deleted": true
}

Response

{
  "data": {
    "sr_enum": [
      {
        "owner": "abc123",
        "aliases": ["abc123"],
        "userDescription": "abc123",
        "qualifiedName": "abc123",
        "displayName": "abc123",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "symbols": ["xyz789"],
        "default": "abc123",
        "createTime": DateTime,
        "name": "abc123",
        "context": "xyz789",
        "namespace": "abc123",
        "doc": "xyz789",
        "id": 987,
        "tenant": "xyz789",
        "schema": sr_schema,
        "field": sr_field,
        "array": sr_array,
        "map_value": sr_map,
        "schemas": [sr_schema],
        "child_types": [sr_type],
        "map_key": sr_map,
        "combined": sr_combined,
        "parent_type": sr_type,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["abc123"]
      }
    ]
  }
}

`sr_field`

Type representing a field

Returns [sr_field]

Name	Description
`where` - `sr_field_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_field_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_field($where: sr_field_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_field_order], $deleted: Boolean) {
  sr_field(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    aliases
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    label
    default
    createTime
    name
    context
    doc
    id
    tag
    tenant
    record {
      ...sr_recordFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    type {
      ...sr_typeFragment
    }
    schema {
      ...sr_schemaFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_field_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["xyz789"],
  "limit": 123,
  "offset": 987,
  "order_by": [sr_field_order],
  "deleted": false
}

Response

{
  "data": {
    "sr_field": [
      {
        "owner": "xyz789",
        "aliases": ["abc123"],
        "userDescription": "abc123",
        "qualifiedName": "xyz789",
        "displayName": "xyz789",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "label": "abc123",
        "default": "abc123",
        "createTime": DateTime,
        "name": "xyz789",
        "context": "abc123",
        "doc": "xyz789",
        "id": 987,
        "tag": 123,
        "tenant": "abc123",
        "record": sr_record,
        "schemas": [sr_schema],
        "type": sr_type,
        "schema": sr_schema,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["abc123"]
      }
    ]
  }
}

`sr_fixed`

Type representing a fixed datatype

Returns [sr_fixed]

Name	Description
`where` - `sr_fixed_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_fixed_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_fixed($where: sr_fixed_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_fixed_order], $deleted: Boolean) {
  sr_fixed(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    aliases
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    default
    size
    createTime
    name
    context
    namespace
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    field {
      ...sr_fieldFragment
    }
    array {
      ...sr_arrayFragment
    }
    map_value {
      ...sr_mapFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    child_types {
      ...sr_typeFragment
    }
    map_key {
      ...sr_mapFragment
    }
    combined {
      ...sr_combinedFragment
    }
    parent_type {
      ...sr_typeFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_fixed_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 987,
  "offset": 987,
  "order_by": [sr_fixed_order],
  "deleted": true
}

Response

{
  "data": {
    "sr_fixed": [
      {
        "owner": "abc123",
        "aliases": ["xyz789"],
        "userDescription": "xyz789",
        "qualifiedName": "xyz789",
        "displayName": "abc123",
        "description": "xyz789",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "default": "xyz789",
        "size": 123,
        "createTime": DateTime,
        "name": "abc123",
        "context": "xyz789",
        "namespace": "abc123",
        "doc": "abc123",
        "id": 123,
        "tenant": "abc123",
        "schema": sr_schema,
        "field": sr_field,
        "array": sr_array,
        "map_value": sr_map,
        "schemas": [sr_schema],
        "child_types": [sr_type],
        "map_key": sr_map,
        "combined": sr_combined,
        "parent_type": sr_type,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["xyz789"]
      }
    ]
  }
}

`sr_map`

Type representing a map datatype

Returns [sr_map]

Name	Description
`where` - `sr_map_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_map_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_map($where: sr_map_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_map_order], $deleted: Boolean) {
  sr_map(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    default
    createTime
    name
    context
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    value_type {
      ...sr_typeFragment
    }
    key_type {
      ...sr_typeFragment
    }
    child_types {
      ...sr_typeFragment
    }
    parent_type {
      ...sr_typeFragment
    }
    field {
      ...sr_fieldFragment
    }
    array {
      ...sr_arrayFragment
    }
    map_value {
      ...sr_mapFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    map_key {
      ...sr_mapFragment
    }
    combined {
      ...sr_combinedFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_map_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 123,
  "offset": 987,
  "order_by": [sr_map_order],
  "deleted": true
}

Response

{
  "data": {
    "sr_map": [
      {
        "owner": "abc123",
        "userDescription": "abc123",
        "qualifiedName": "xyz789",
        "displayName": "abc123",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "default": "xyz789",
        "createTime": DateTime,
        "name": "abc123",
        "context": "xyz789",
        "doc": "abc123",
        "id": 987,
        "tenant": "xyz789",
        "schema": sr_schema,
        "value_type": sr_type,
        "key_type": sr_type,
        "child_types": [sr_type],
        "parent_type": sr_type,
        "field": sr_field,
        "array": sr_array,
        "map_value": sr_map,
        "schemas": [sr_schema],
        "map_key": sr_map,
        "combined": sr_combined,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["xyz789"]
      }
    ]
  }
}

`sr_primitive`

Type representing a primitive datatype

Returns [sr_primitive]

Name	Description
`where` - `sr_primitive_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_primitive_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_primitive($where: sr_primitive_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_primitive_order], $deleted: Boolean) {
  sr_primitive(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    type
    default
    createTime
    name
    context
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    field {
      ...sr_fieldFragment
    }
    array {
      ...sr_arrayFragment
    }
    map_value {
      ...sr_mapFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    child_types {
      ...sr_typeFragment
    }
    map_key {
      ...sr_mapFragment
    }
    combined {
      ...sr_combinedFragment
    }
    parent_type {
      ...sr_typeFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_primitive_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["xyz789"],
  "limit": 123,
  "offset": 123,
  "order_by": [sr_primitive_order],
  "deleted": true
}

Response

{
  "data": {
    "sr_primitive": [
      {
        "owner": "abc123",
        "userDescription": "xyz789",
        "qualifiedName": "xyz789",
        "displayName": "abc123",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "type": "abc123",
        "default": "xyz789",
        "createTime": DateTime,
        "name": "xyz789",
        "context": "abc123",
        "doc": "xyz789",
        "id": 987,
        "tenant": "xyz789",
        "schema": sr_schema,
        "field": sr_field,
        "array": sr_array,
        "map_value": sr_map,
        "schemas": [sr_schema],
        "child_types": [sr_type],
        "map_key": sr_map,
        "combined": sr_combined,
        "parent_type": sr_type,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["abc123"]
      }
    ]
  }
}

`sr_record`

Type representing a record

Returns [sr_record]

Name	Description
`where` - `sr_record_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_record_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_record($where: sr_record_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_record_order], $deleted: Boolean) {
  sr_record(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    aliases
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    default
    createTime
    name
    context
    namespace
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    child_types {
      ...sr_typeFragment
    }
    parent_type {
      ...sr_typeFragment
    }
    field {
      ...sr_fieldFragment
    }
    array {
      ...sr_arrayFragment
    }
    map_value {
      ...sr_mapFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    map_key {
      ...sr_mapFragment
    }
    combined {
      ...sr_combinedFragment
    }
    fields {
      ...sr_fieldFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_record_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 123,
  "offset": 123,
  "order_by": [sr_record_order],
  "deleted": true
}

Response

{
  "data": {
    "sr_record": [
      {
        "owner": "abc123",
        "aliases": ["xyz789"],
        "userDescription": "abc123",
        "qualifiedName": "xyz789",
        "displayName": "xyz789",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "xyz789",
        "default": "abc123",
        "createTime": DateTime,
        "name": "xyz789",
        "context": "xyz789",
        "namespace": "xyz789",
        "doc": "xyz789",
        "id": 123,
        "tenant": "xyz789",
        "schema": sr_schema,
        "child_types": [sr_type],
        "parent_type": sr_type,
        "field": sr_field,
        "array": sr_array,
        "map_value": sr_map,
        "schemas": [sr_schema],
        "map_key": sr_map,
        "combined": sr_combined,
        "fields": [sr_field],
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["abc123"]
      }
    ]
  }
}

`sr_schema`

Type representing a schema namespace

Returns [sr_schema]

Name	Description
`where` - `sr_schema_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_schema_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_schema($where: sr_schema_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_schema_order], $deleted: Boolean) {
  sr_schema(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    createTime
    name
    context
    schemaType
    namespace
    doc
    id
    tenant
    types {
      ...sr_typeFragment
    }
    subject_versions {
      ...sr_subject_versionFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    schema {
      ...sr_schemaFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_schema_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["xyz789"],
  "limit": 987,
  "offset": 987,
  "order_by": [sr_schema_order],
  "deleted": false
}

Response

{
  "data": {
    "sr_schema": [
      {
        "owner": "abc123",
        "userDescription": "xyz789",
        "qualifiedName": "abc123",
        "displayName": "abc123",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "abc123",
        "createTime": DateTime,
        "name": "abc123",
        "context": "xyz789",
        "schemaType": "abc123",
        "namespace": "abc123",
        "doc": "xyz789",
        "id": 123,
        "tenant": "abc123",
        "types": [sr_type],
        "subject_versions": [sr_subject_version],
        "schemas": [sr_schema],
        "schema": sr_schema,
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["abc123"]
      }
    ]
  }
}

`sr_subject_version`

Type representing a subject-version

Returns [sr_subject_version]

Name	Description
`where` - `sr_subject_version_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_subject_version_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_subject_version($where: sr_subject_version_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_subject_version_order], $deleted: Boolean) {
  sr_subject_version(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    version
    createTime
    name
    context
    schemaType
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_subject_version_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["xyz789"],
  "limit": 987,
  "offset": 123,
  "order_by": [sr_subject_version_order],
  "deleted": true
}

Response

{
  "data": {
    "sr_subject_version": [
      {
        "owner": "xyz789",
        "userDescription": "xyz789",
        "qualifiedName": "abc123",
        "displayName": "xyz789",
        "description": "abc123",
        "updateTime": DateTime,
        "nameLower": "xyz789",
        "version": 123,
        "createTime": DateTime,
        "name": "abc123",
        "context": "abc123",
        "schemaType": "abc123",
        "doc": "xyz789",
        "id": 123,
        "tenant": "xyz789",
        "schema": sr_schema,
        "schemas": [sr_schema],
        "status": status_enum,
        "business_metadata": [
          business_metadata_attribute
        ],
        "tags": ["abc123"]
      }
    ]
  }
}

`sr_type`

Type representing an abstract type

Returns [sr_type]

Name	Description
`where` - `sr_type_criteria`	Where logical specification
`business_metadata` - `[business_metadata_input_attribute]`	Limit the result set to entities with the given business metadata attributes
`tags` - `[String]`	Limit the result set to entities with the given tag
`limit` - `Int`	Limit the result set to the given number
`offset` - `Int`	Start offset for the result set
`order_by` - `[sr_type_order]`	Order by specification
`deleted` - `Boolean`	Whether to include deleted entities

Example

Query

query sr_type($where: sr_type_criteria, $business_metadata: [business_metadata_input_attribute], $tags: [String], $limit: Int, $offset: Int, $order_by: [sr_type_order], $deleted: Boolean) {
  sr_type(where: $where, business_metadata: $business_metadata, tags: $tags, limit: $limit, offset: $offset, order_by: $order_by, deleted: $deleted) {
    owner
    userDescription
    qualifiedName
    displayName
    description
    updateTime
    nameLower
    default
    createTime
    name
    context
    doc
    id
    tenant
    schema {
      ...sr_schemaFragment
    }
    field {
      ...sr_fieldFragment
    }
    array {
      ...sr_arrayFragment
    }
    map_value {
      ...sr_mapFragment
    }
    schemas {
      ...sr_schemaFragment
    }
    child_types {
      ...sr_typeFragment
    }
    map_key {
      ...sr_mapFragment
    }
    combined {
      ...sr_combinedFragment
    }
    parent_type {
      ...sr_typeFragment
    }
    status
    business_metadata {
      ...business_metadata_attributeFragment
    }
    tags
  }
}

Variables

{
  "where": sr_type_criteria,
  "business_metadata": [
    business_metadata_input_attribute
  ],
  "tags": ["abc123"],
  "limit": 987,
  "offset": 987,
  "order_by": [sr_type_order],
  "deleted": false
}

Response

{"data": {"sr_type": [sr_type]}}

Types

`Boolean`

Built-in Boolean

Example

true

Types

`DateTime`

An RFC-3339 compliant DateTime Scalar

Example

object

Types

`Int`

Built-in Int

Example

Types

`JsonPrimitive`

A JSON Primitive Scalar

Example

object

Types

`Long`

A 64-bit signed integer

Example

object

Types

`String`

Built-in String

Types

`between_start_end`

Specifies the start and end for a range query

Input Field	Description
`start` - `DateTime`	The range start
`end` - `DateTime`	The range end

Example

{"start": DateTime, "end": DateTime}

Types

`business_metadata_attribute`

Specifies a business metadata attribute

Field Name	Description
`name` - `String`	The business metadata attribute name
`value` - `JsonPrimitive`	The business metadata attribute value

Example

{"name": "abc123", "value": JsonPrimitive}

Types

`business_metadata_input_attribute`

Specifies a business metadata input attribute

Input Field	Description
`name` - `String`	The business metadata input attribute name
`value` - `JsonPrimitive`	The business metadata input attribute value
`valuePrefix` - `String`	The business metadata input attribute value prefix

Example

{
  "name": "abc123",
  "value": JsonPrimitive,
  "valuePrefix": "abc123"
}

Types

`cf_entity`

Type representing a Confluent entity

Field Name	Description
`owner` - `String`
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`createTime` - `DateTime`	The create time
`name` - `String`
`doc` - `String`	Documentation
`tenant` - `String`	The tenant
`schemas` - `[sr_schema]`	The schemas
`status` - `status_enum`	Status of the entity
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "xyz789",
  "userDescription": "abc123",
  "qualifiedName": "abc123",
  "displayName": "abc123",
  "description": "abc123",
  "updateTime": DateTime,
  "nameLower": "abc123",
  "createTime": DateTime,
  "name": "abc123",
  "doc": "xyz789",
  "tenant": "xyz789",
  "schemas": [sr_schema],
  "status": status_enum,
  "business_metadata": [business_metadata_attribute],
  "tags": ["xyz789"]
}

Types

`cf_entity_createTime_criteria`

Criteria expression specification of createTime attribute in entity cf_entity

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`cf_entity_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[cf_entity_criteria]`	Logical operation for expressions
`_and` - `[cf_entity_criteria]`	Logical operation for expressions
`owner` - `cf_entity_owner_criteria`
`userDescription` - `cf_entity_userDescription_criteria`
`qualifiedName` - `cf_entity_qualifiedName_criteria`
`displayName` - `cf_entity_displayName_criteria`
`description` - `cf_entity_description_criteria`
`updateTime` - `cf_entity_updateTime_criteria`	The update time
`nameLower` - `cf_entity_nameLower_criteria`	Lowercase representation of the name
`createTime` - `cf_entity_createTime_criteria`	The create time
`name` - `cf_entity_name_criteria`
`doc` - `cf_entity_doc_criteria`	Documentation
`tenant` - `cf_entity_tenant_criteria`	The tenant

Example

{
  "_or": [cf_entity_criteria],
  "_and": [cf_entity_criteria],
  "owner": cf_entity_owner_criteria,
  "userDescription": cf_entity_userDescription_criteria,
  "qualifiedName": cf_entity_qualifiedName_criteria,
  "displayName": cf_entity_displayName_criteria,
  "description": cf_entity_description_criteria,
  "updateTime": cf_entity_updateTime_criteria,
  "nameLower": cf_entity_nameLower_criteria,
  "createTime": cf_entity_createTime_criteria,
  "name": cf_entity_name_criteria,
  "doc": cf_entity_doc_criteria,
  "tenant": cf_entity_tenant_criteria
}

Types

`cf_entity_description_criteria`

Criteria expression specification of description attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`cf_entity_displayName_criteria`

Criteria expression specification of displayName attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`cf_entity_doc_criteria`

Criteria expression specification of doc attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`cf_entity_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`cf_entity_name_criteria`

Criteria expression specification of name attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`cf_entity_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`createTime` - `order_by_enum`	The create time
`name` - `order_by_enum`
`doc` - `order_by_enum`	Documentation
`tenant` - `order_by_enum`	The tenant

Example

{
  "owner": order_by_enum,
  "replicatedTo": order_by_enum,
  "userDescription": order_by_enum,
  "replicatedFrom": order_by_enum,
  "qualifiedName": order_by_enum,
  "displayName": order_by_enum,
  "description": order_by_enum,
  "updateTime": order_by_enum,
  "nameLower": order_by_enum,
  "createTime": order_by_enum,
  "name": order_by_enum,
  "doc": order_by_enum,
  "tenant": order_by_enum
}

Types

`cf_entity_owner_criteria`

Criteria expression specification of owner attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`cf_entity_qualifiedName_criteria`

Criteria expression specification of qualifiedName attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`cf_entity_tenant_criteria`

Criteria expression specification of tenant attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`cf_entity_updateTime_criteria`

Criteria expression specification of updateTime attribute in entity cf_entity

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`cf_entity_userDescription_criteria`

Criteria expression specification of userDescription attribute in entity cf_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`cf_tenant`

Type representing a Confluent tenant

Field Name	Description
`owner` - `String`
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`createTime` - `DateTime`	The create time
`name` - `String`
`doc` - `String`	Documentation
`tenant` - `String`	The tenant
`schemas` - `[sr_schema]`	The schemas
`status` - `status_enum`	Status of the entity
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "abc123",
  "userDescription": "xyz789",
  "qualifiedName": "abc123",
  "displayName": "xyz789",
  "description": "abc123",
  "updateTime": DateTime,
  "nameLower": "xyz789",
  "createTime": DateTime,
  "name": "xyz789",
  "doc": "xyz789",
  "tenant": "abc123",
  "schemas": [sr_schema],
  "status": status_enum,
  "business_metadata": [business_metadata_attribute],
  "tags": ["xyz789"]
}

Types

`cf_tenant_createTime_criteria`

Criteria expression specification of createTime attribute in entity cf_tenant

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`cf_tenant_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[cf_tenant_criteria]`	Logical operation for expressions
`_and` - `[cf_tenant_criteria]`	Logical operation for expressions
`owner` - `cf_tenant_owner_criteria`
`userDescription` - `cf_tenant_userDescription_criteria`
`qualifiedName` - `cf_tenant_qualifiedName_criteria`
`displayName` - `cf_tenant_displayName_criteria`
`description` - `cf_tenant_description_criteria`
`updateTime` - `cf_tenant_updateTime_criteria`	The update time
`nameLower` - `cf_tenant_nameLower_criteria`	Lowercase representation of the name
`createTime` - `cf_tenant_createTime_criteria`	The create time
`name` - `cf_tenant_name_criteria`
`doc` - `cf_tenant_doc_criteria`	Documentation
`tenant` - `cf_tenant_tenant_criteria`	The tenant

Example

{
  "_or": [cf_tenant_criteria],
  "_and": [cf_tenant_criteria],
  "owner": cf_tenant_owner_criteria,
  "userDescription": cf_tenant_userDescription_criteria,
  "qualifiedName": cf_tenant_qualifiedName_criteria,
  "displayName": cf_tenant_displayName_criteria,
  "description": cf_tenant_description_criteria,
  "updateTime": cf_tenant_updateTime_criteria,
  "nameLower": cf_tenant_nameLower_criteria,
  "createTime": cf_tenant_createTime_criteria,
  "name": cf_tenant_name_criteria,
  "doc": cf_tenant_doc_criteria,
  "tenant": cf_tenant_tenant_criteria
}

Types

`cf_tenant_description_criteria`

Criteria expression specification of description attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`cf_tenant_displayName_criteria`

Criteria expression specification of displayName attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`cf_tenant_doc_criteria`

Criteria expression specification of doc attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`cf_tenant_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`cf_tenant_name_criteria`

Criteria expression specification of name attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`cf_tenant_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`createTime` - `order_by_enum`	The create time
`name` - `order_by_enum`
`doc` - `order_by_enum`	Documentation
`tenant` - `order_by_enum`	The tenant

Example

{
  "owner": order_by_enum,
  "replicatedTo": order_by_enum,
  "userDescription": order_by_enum,
  "replicatedFrom": order_by_enum,
  "qualifiedName": order_by_enum,
  "displayName": order_by_enum,
  "description": order_by_enum,
  "updateTime": order_by_enum,
  "nameLower": order_by_enum,
  "createTime": order_by_enum,
  "name": order_by_enum,
  "doc": order_by_enum,
  "tenant": order_by_enum
}

Types

`cf_tenant_owner_criteria`

Criteria expression specification of owner attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`cf_tenant_qualifiedName_criteria`

Criteria expression specification of qualifiedName attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`cf_tenant_tenant_criteria`

Criteria expression specification of tenant attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`cf_tenant_updateTime_criteria`

Criteria expression specification of updateTime attribute in entity cf_tenant

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`cf_tenant_userDescription_criteria`

Criteria expression specification of userDescription attribute in entity cf_tenant

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_cleanup_policy`

Enum Value	Description
`NONE`
`DELETE`
`COMPACT`
`COMPACT_DELETE`

Types

`kafka_logical_cluster`

Type representing a logical Kafka cluster

Field Name	Description
`owner` - `String`
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`availability` - `String`	The availability
`type` - `String`	The logical cluster type
`cku` - `Int`	The number of CKUs
`network` - `String`	The network type
`createTime` - `DateTime`	The create time
`provider` - `String`	The cloud provider
`name` - `String`
`doc` - `String`	Documentation
`id` - `String`	The logical cluster id
`region` - `String`	The region
`tenant` - `String`	The tenant
`status` - `status_enum`	Status of the entity
`topics` - `[kafka_topic]`
`schemas` - `[sr_schema]`	The schemas
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "abc123",
  "userDescription": "xyz789",
  "qualifiedName": "abc123",
  "displayName": "xyz789",
  "description": "xyz789",
  "updateTime": DateTime,
  "nameLower": "xyz789",
  "availability": "xyz789",
  "type": "abc123",
  "cku": 987,
  "network": "xyz789",
  "createTime": DateTime,
  "provider": "abc123",
  "name": "xyz789",
  "doc": "abc123",
  "id": "abc123",
  "region": "abc123",
  "tenant": "xyz789",
  "status": status_enum,
  "topics": [kafka_topic],
  "schemas": [sr_schema],
  "business_metadata": [business_metadata_attribute],
  "tags": ["xyz789"]
}

Types

`kafka_logical_cluster_availability_criteria`

Criteria expression specification of availability attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_cku_criteria`

Criteria expression specification of cku attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `Int`	Equals criteria
`_lte` - `Int`	Less than or equals criteria
`_gte` - `Int`	Greater or equals criteria
`_gt` - `Int`	Greater than criteria
`_lt` - `Int`	Less than criteria

Example

{"_eq": 123, "_lte": 987, "_gte": 987, "_gt": 123, "_lt": 123}

Types

`kafka_logical_cluster_createTime_criteria`

Criteria expression specification of createTime attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`kafka_logical_cluster_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[kafka_logical_cluster_criteria]`	Logical operation for expressions
`_and` - `[kafka_logical_cluster_criteria]`	Logical operation for expressions
`owner` - `kafka_logical_cluster_owner_criteria`
`userDescription` - `kafka_logical_cluster_userDescription_criteria`
`qualifiedName` - `kafka_logical_cluster_qualifiedName_criteria`
`displayName` - `kafka_logical_cluster_displayName_criteria`
`description` - `kafka_logical_cluster_description_criteria`
`updateTime` - `kafka_logical_cluster_updateTime_criteria`	The update time
`nameLower` - `kafka_logical_cluster_nameLower_criteria`	Lowercase representation of the name
`availability` - `kafka_logical_cluster_availability_criteria`	The availability
`type` - `kafka_logical_cluster_type_criteria`	The logical cluster type
`cku` - `kafka_logical_cluster_cku_criteria`	The number of CKUs
`network` - `kafka_logical_cluster_network_criteria`	The network type
`createTime` - `kafka_logical_cluster_createTime_criteria`	The create time
`provider` - `kafka_logical_cluster_provider_criteria`	The cloud provider
`name` - `kafka_logical_cluster_name_criteria`
`doc` - `kafka_logical_cluster_doc_criteria`	Documentation
`id` - `kafka_logical_cluster_id_criteria`	The logical cluster id
`region` - `kafka_logical_cluster_region_criteria`	The region
`tenant` - `kafka_logical_cluster_tenant_criteria`	The tenant
`status` - `kafka_logical_cluster_status_criteria`	The logical cluster status

Example

{
  "_or": [kafka_logical_cluster_criteria],
  "_and": [kafka_logical_cluster_criteria],
  "owner": kafka_logical_cluster_owner_criteria,
  "userDescription": kafka_logical_cluster_userDescription_criteria,
  "qualifiedName": kafka_logical_cluster_qualifiedName_criteria,
  "displayName": kafka_logical_cluster_displayName_criteria,
  "description": kafka_logical_cluster_description_criteria,
  "updateTime": kafka_logical_cluster_updateTime_criteria,
  "nameLower": kafka_logical_cluster_nameLower_criteria,
  "availability": kafka_logical_cluster_availability_criteria,
  "type": kafka_logical_cluster_type_criteria,
  "cku": kafka_logical_cluster_cku_criteria,
  "network": kafka_logical_cluster_network_criteria,
  "createTime": kafka_logical_cluster_createTime_criteria,
  "provider": kafka_logical_cluster_provider_criteria,
  "name": kafka_logical_cluster_name_criteria,
  "doc": kafka_logical_cluster_doc_criteria,
  "id": kafka_logical_cluster_id_criteria,
  "region": kafka_logical_cluster_region_criteria,
  "tenant": kafka_logical_cluster_tenant_criteria,
  "status": kafka_logical_cluster_status_criteria
}

Types

`kafka_logical_cluster_description_criteria`

Criteria expression specification of description attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_displayName_criteria`

Criteria expression specification of displayName attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_doc_criteria`

Criteria expression specification of doc attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`kafka_logical_cluster_id_criteria`

Criteria expression specification of id attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`kafka_logical_cluster_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_name_criteria`

Criteria expression specification of name attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`kafka_logical_cluster_network_criteria`

Criteria expression specification of network attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`availability` - `order_by_enum`	The availability
`type` - `order_by_enum`	The logical cluster type
`cku` - `order_by_enum`	The number of CKUs
`network` - `order_by_enum`	The network type
`createTime` - `order_by_enum`	The create time
`provider` - `order_by_enum`	The cloud provider
`name` - `order_by_enum`
`doc` - `order_by_enum`	Documentation
`id` - `order_by_enum`	The logical cluster id
`region` - `order_by_enum`	The region
`tenant` - `order_by_enum`	The tenant
`status` - `order_by_enum`	The logical cluster status

Example

{
  "owner": order_by_enum,
  "replicatedTo": order_by_enum,
  "userDescription": order_by_enum,
  "replicatedFrom": order_by_enum,
  "qualifiedName": order_by_enum,
  "displayName": order_by_enum,
  "description": order_by_enum,
  "updateTime": order_by_enum,
  "nameLower": order_by_enum,
  "availability": order_by_enum,
  "type": order_by_enum,
  "cku": order_by_enum,
  "network": order_by_enum,
  "createTime": order_by_enum,
  "provider": order_by_enum,
  "name": order_by_enum,
  "doc": order_by_enum,
  "id": order_by_enum,
  "region": order_by_enum,
  "tenant": order_by_enum,
  "status": order_by_enum
}

Types

`kafka_logical_cluster_owner_criteria`

Criteria expression specification of owner attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_provider_criteria`

Criteria expression specification of provider attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_qualifiedName_criteria`

Criteria expression specification of qualifiedName attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_region_criteria`

Criteria expression specification of region attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`kafka_logical_cluster_status_criteria`

Criteria expression specification of status attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`kafka_logical_cluster_tenant_criteria`

Criteria expression specification of tenant attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`kafka_logical_cluster_type_criteria`

Criteria expression specification of type attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`kafka_logical_cluster_updateTime_criteria`

Criteria expression specification of updateTime attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`kafka_logical_cluster_userDescription_criteria`

Criteria expression specification of userDescription attribute in entity kafka_logical_cluster

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`kafka_topic`

Type representing a Kafka topic

Field Name	Description
`owner` - `String`
`retentionMs` - `Long`	The retention time in ms
`replicationFactor` - `Int`	The replication factor
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`isInternal` - `Boolean`	Whether the topic is internal
`partitionsCount` - `Int`	The number of partitions
`valueSchemaValidation` - `Boolean`	Whether value schema validation is enabled
`retentionBytes` - `Long`	The retention bytes
`createTime` - `DateTime`	The create time
`name` - `String`
`doc` - `String`	Documentation
`keySchemaValidation` - `Boolean`	Whether key schema validation is enabled
`id` - `String`	The topic id
`tenant` - `String`	The tenant
`cleanupPolicy` - `kafka_cleanup_policy`	The cleanup policy
`schemas` - `[sr_schema]`	The schemas
`logical_cluster` - `kafka_logical_cluster`
`status` - `status_enum`	Status of the entity
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "abc123",
  "retentionMs": Long,
  "replicationFactor": 123,
  "userDescription": "abc123",
  "qualifiedName": "xyz789",
  "displayName": "abc123",
  "description": "xyz789",
  "updateTime": DateTime,
  "nameLower": "xyz789",
  "isInternal": false,
  "partitionsCount": 123,
  "valueSchemaValidation": false,
  "retentionBytes": Long,
  "createTime": DateTime,
  "name": "abc123",
  "doc": "abc123",
  "keySchemaValidation": false,
  "id": "abc123",
  "tenant": "xyz789",
  "cleanupPolicy": kafka_cleanup_policy,
  "schemas": [sr_schema],
  "logical_cluster": kafka_logical_cluster,
  "status": status_enum,
  "business_metadata": [business_metadata_attribute],
  "tags": ["abc123"]
}

Types

`kafka_topic_cleanupPolicy_criteria`

Criteria expression specification of cleanupPolicy attribute in entity kafka_topic

Input Field	Description
`_eq` - `kafka_cleanup_policy`	Equals criteria
`_lte` - `kafka_cleanup_policy`	Less than or equals criteria
`_gte` - `kafka_cleanup_policy`	Greater or equals criteria
`_gt` - `kafka_cleanup_policy`	Greater than criteria
`_lt` - `kafka_cleanup_policy`	Less than criteria
`_starts_with` - `kafka_cleanup_policy`	Starts with criteria

Example

{
  "_eq": kafka_cleanup_policy,
  "_lte": kafka_cleanup_policy,
  "_gte": kafka_cleanup_policy,
  "_gt": kafka_cleanup_policy,
  "_lt": kafka_cleanup_policy,
  "_starts_with": kafka_cleanup_policy
}

Types

`kafka_topic_createTime_criteria`

Criteria expression specification of createTime attribute in entity kafka_topic

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`kafka_topic_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[kafka_topic_criteria]`	Logical operation for expressions
`_and` - `[kafka_topic_criteria]`	Logical operation for expressions
`owner` - `kafka_topic_owner_criteria`
`retentionMs` - `kafka_topic_retentionMs_criteria`	The retention time in ms
`replicationFactor` - `kafka_topic_replicationFactor_criteria`	The replication factor
`userDescription` - `kafka_topic_userDescription_criteria`
`qualifiedName` - `kafka_topic_qualifiedName_criteria`
`displayName` - `kafka_topic_displayName_criteria`
`description` - `kafka_topic_description_criteria`
`updateTime` - `kafka_topic_updateTime_criteria`	The update time
`nameLower` - `kafka_topic_nameLower_criteria`	Lowercase representation of the name
`isInternal` - `kafka_topic_isInternal_criteria`	Whether the topic is internal
`partitionsCount` - `kafka_topic_partitionsCount_criteria`	The number of partitions
`valueSchemaValidation` - `kafka_topic_valueSchemaValidation_criteria`	Whether value schema validation is enabled
`retentionBytes` - `kafka_topic_retentionBytes_criteria`	The retention bytes
`createTime` - `kafka_topic_createTime_criteria`	The create time
`name` - `kafka_topic_name_criteria`
`doc` - `kafka_topic_doc_criteria`	Documentation
`keySchemaValidation` - `kafka_topic_keySchemaValidation_criteria`	Whether key schema validation is enabled
`id` - `kafka_topic_id_criteria`	The topic id
`tenant` - `kafka_topic_tenant_criteria`	The tenant
`cleanupPolicy` - `kafka_topic_cleanupPolicy_criteria`	The cleanup policy

Example

{
  "_or": [kafka_topic_criteria],
  "_and": [kafka_topic_criteria],
  "owner": kafka_topic_owner_criteria,
  "retentionMs": kafka_topic_retentionMs_criteria,
  "replicationFactor": kafka_topic_replicationFactor_criteria,
  "userDescription": kafka_topic_userDescription_criteria,
  "qualifiedName": kafka_topic_qualifiedName_criteria,
  "displayName": kafka_topic_displayName_criteria,
  "description": kafka_topic_description_criteria,
  "updateTime": kafka_topic_updateTime_criteria,
  "nameLower": kafka_topic_nameLower_criteria,
  "isInternal": kafka_topic_isInternal_criteria,
  "partitionsCount": kafka_topic_partitionsCount_criteria,
  "valueSchemaValidation": kafka_topic_valueSchemaValidation_criteria,
  "retentionBytes": kafka_topic_retentionBytes_criteria,
  "createTime": kafka_topic_createTime_criteria,
  "name": kafka_topic_name_criteria,
  "doc": kafka_topic_doc_criteria,
  "keySchemaValidation": kafka_topic_keySchemaValidation_criteria,
  "id": kafka_topic_id_criteria,
  "tenant": kafka_topic_tenant_criteria,
  "cleanupPolicy": kafka_topic_cleanupPolicy_criteria
}

Types

`kafka_topic_description_criteria`

Criteria expression specification of description attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_topic_displayName_criteria`

Criteria expression specification of displayName attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_topic_doc_criteria`

Criteria expression specification of doc attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`kafka_topic_id_criteria`

Criteria expression specification of id attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`kafka_topic_isInternal_criteria`

Criteria expression specification of isInternal attribute in entity kafka_topic

Input Field	Description
`_eq` - `Boolean`	Equals criteria
`_lte` - `Boolean`	Less than or equals criteria
`_gte` - `Boolean`	Greater or equals criteria
`_gt` - `Boolean`	Greater than criteria
`_lt` - `Boolean`	Less than criteria

Example

{"_eq": false, "_lte": true, "_gte": false, "_gt": false, "_lt": true}

Types

`kafka_topic_keySchemaValidation_criteria`

Criteria expression specification of keySchemaValidation attribute in entity kafka_topic

Input Field	Description
`_eq` - `Boolean`	Equals criteria
`_lte` - `Boolean`	Less than or equals criteria
`_gte` - `Boolean`	Greater or equals criteria
`_gt` - `Boolean`	Greater than criteria
`_lt` - `Boolean`	Less than criteria

Example

{"_eq": true, "_lte": true, "_gte": false, "_gt": false, "_lt": true}

Types

`kafka_topic_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`kafka_topic_name_criteria`

Criteria expression specification of name attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_topic_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`retentionMs` - `order_by_enum`	The retention time in ms
`replicationFactor` - `order_by_enum`	The replication factor
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`isInternal` - `order_by_enum`	Whether the topic is internal
`partitionsCount` - `order_by_enum`	The number of partitions
`valueSchemaValidation` - `order_by_enum`	Whether value schema validation is enabled
`retentionBytes` - `order_by_enum`	The retention bytes
`createTime` - `order_by_enum`	The create time
`name` - `order_by_enum`
`doc` - `order_by_enum`	Documentation
`keySchemaValidation` - `order_by_enum`	Whether key schema validation is enabled
`id` - `order_by_enum`	The topic id
`tenant` - `order_by_enum`	The tenant
`cleanupPolicy` - `order_by_enum`	The cleanup policy

Example

{
  "owner": order_by_enum,
  "retentionMs": order_by_enum,
  "replicationFactor": order_by_enum,
  "replicatedTo": order_by_enum,
  "userDescription": order_by_enum,
  "replicatedFrom": order_by_enum,
  "qualifiedName": order_by_enum,
  "displayName": order_by_enum,
  "description": order_by_enum,
  "updateTime": order_by_enum,
  "nameLower": order_by_enum,
  "isInternal": order_by_enum,
  "partitionsCount": order_by_enum,
  "valueSchemaValidation": order_by_enum,
  "retentionBytes": order_by_enum,
  "createTime": order_by_enum,
  "name": order_by_enum,
  "doc": order_by_enum,
  "keySchemaValidation": order_by_enum,
  "id": order_by_enum,
  "tenant": order_by_enum,
  "cleanupPolicy": order_by_enum
}

Types

`kafka_topic_owner_criteria`

Criteria expression specification of owner attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_topic_partitionsCount_criteria`

Criteria expression specification of partitionsCount attribute in entity kafka_topic

Input Field	Description
`_eq` - `Int`	Equals criteria
`_lte` - `Int`	Less than or equals criteria
`_gte` - `Int`	Greater or equals criteria
`_gt` - `Int`	Greater than criteria
`_lt` - `Int`	Less than criteria

Example

{"_eq": 123, "_lte": 123, "_gte": 987, "_gt": 123, "_lt": 123}

Types

`kafka_topic_qualifiedName_criteria`

Criteria expression specification of qualifiedName attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`kafka_topic_replicationFactor_criteria`

Criteria expression specification of replicationFactor attribute in entity kafka_topic

Input Field	Description
`_eq` - `Int`	Equals criteria
`_lte` - `Int`	Less than or equals criteria
`_gte` - `Int`	Greater or equals criteria
`_gt` - `Int`	Greater than criteria
`_lt` - `Int`	Less than criteria

Example

{"_eq": 987, "_lte": 123, "_gte": 987, "_gt": 987, "_lt": 123}

Types

`kafka_topic_retentionBytes_criteria`

Criteria expression specification of retentionBytes attribute in entity kafka_topic

Input Field	Description
`_eq` - `Long`	Equals criteria
`_lte` - `Long`	Less than or equals criteria
`_gte` - `Long`	Greater or equals criteria
`_gt` - `Long`	Greater than criteria
`_lt` - `Long`	Less than criteria

Example

{
  "_eq": Long,
  "_lte": Long,
  "_gte": Long,
  "_gt": Long,
  "_lt": Long
}

Types

`kafka_topic_retentionMs_criteria`

Criteria expression specification of retentionMs attribute in entity kafka_topic

Input Field	Description
`_eq` - `Long`	Equals criteria
`_lte` - `Long`	Less than or equals criteria
`_gte` - `Long`	Greater or equals criteria
`_gt` - `Long`	Greater than criteria
`_lt` - `Long`	Less than criteria

Example

{
  "_eq": Long,
  "_lte": Long,
  "_gte": Long,
  "_gt": Long,
  "_lt": Long
}

Types

`kafka_topic_tenant_criteria`

Criteria expression specification of tenant attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_topic_updateTime_criteria`

Criteria expression specification of updateTime attribute in entity kafka_topic

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`kafka_topic_userDescription_criteria`

Criteria expression specification of userDescription attribute in entity kafka_topic

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`kafka_topic_valueSchemaValidation_criteria`

Criteria expression specification of valueSchemaValidation attribute in entity kafka_topic

Input Field	Description
`_eq` - `Boolean`	Equals criteria
`_lte` - `Boolean`	Less than or equals criteria
`_gte` - `Boolean`	Greater or equals criteria
`_gt` - `Boolean`	Greater than criteria
`_lt` - `Boolean`	Less than criteria

Example

{"_eq": true, "_lte": false, "_gte": true, "_gt": true, "_lt": false}

Types

`order_by_enum`

Specifies the direction (ascending/descending) for sorting a field

Enum Value	Description
`asc`	Ascending
`desc`	Descending

Types

`since_enum`

Specifies the enum for a since query

Enum Value	Description
`last_7_days`	Last 7 days
`last_30_days`	Last 30 days
`last_month`	Last month
`this_month`	This month
`today`	Today
`yesterday`	Yesterday
`this_year`	This year
`last_year`	Last year
`this_quarter`	This quarter
`last_quarter`	Last quarter
`last_3_months`	Last 3 months
`last_6_months`	Last 6 months
`last_12_months`	Last 12 months

Types

`sr_array`

Type representing an array datatype

Field Name	Description
`owner` - `String`
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`default` - `String`	The type default
`createTime` - `DateTime`	The create time
`name` - `String`
`context` - `String`	The schema context
`doc` - `String`	Documentation
`id` - `Int`	The schema id
`tenant` - `String`	The tenant
`schema` - `sr_schema`	The schema
`child_types` - `[sr_type]`	The child types
`type` - `sr_type`	The array type
`parent_type` - `sr_type`	The parent type
`field` - `sr_field`	The field
`array` - `sr_array`	The array
`map_value` - `sr_map`	The map
`schemas` - `[sr_schema]`	The schemas
`map_key` - `sr_map`	The map
`combined` - `sr_combined`	The combined type
`status` - `status_enum`	Status of the entity
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "abc123",
  "userDescription": "abc123",
  "qualifiedName": "abc123",
  "displayName": "abc123",
  "description": "abc123",
  "updateTime": DateTime,
  "nameLower": "xyz789",
  "default": "xyz789",
  "createTime": DateTime,
  "name": "abc123",
  "context": "xyz789",
  "doc": "abc123",
  "id": 987,
  "tenant": "xyz789",
  "schema": sr_schema,
  "child_types": [sr_type],
  "type": sr_type,
  "parent_type": sr_type,
  "field": sr_field,
  "array": sr_array,
  "map_value": sr_map,
  "schemas": [sr_schema],
  "map_key": sr_map,
  "combined": sr_combined,
  "status": status_enum,
  "business_metadata": [business_metadata_attribute],
  "tags": ["abc123"]
}

Types

`sr_array_context_criteria`

Criteria expression specification of context attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`sr_array_createTime_criteria`

Criteria expression specification of createTime attribute in entity sr_array

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_array_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[sr_array_criteria]`	Logical operation for expressions
`_and` - `[sr_array_criteria]`	Logical operation for expressions
`owner` - `sr_array_owner_criteria`
`userDescription` - `sr_array_userDescription_criteria`
`qualifiedName` - `sr_array_qualifiedName_criteria`
`displayName` - `sr_array_displayName_criteria`
`description` - `sr_array_description_criteria`
`updateTime` - `sr_array_updateTime_criteria`	The update time
`nameLower` - `sr_array_nameLower_criteria`	Lowercase representation of the name
`default` - `sr_array_default_criteria`	The type default
`createTime` - `sr_array_createTime_criteria`	The create time
`name` - `sr_array_name_criteria`
`context` - `sr_array_context_criteria`	The schema context
`doc` - `sr_array_doc_criteria`	Documentation
`id` - `sr_array_id_criteria`	The schema id
`tenant` - `sr_array_tenant_criteria`	The tenant

Example

{
  "_or": [sr_array_criteria],
  "_and": [sr_array_criteria],
  "owner": sr_array_owner_criteria,
  "userDescription": sr_array_userDescription_criteria,
  "qualifiedName": sr_array_qualifiedName_criteria,
  "displayName": sr_array_displayName_criteria,
  "description": sr_array_description_criteria,
  "updateTime": sr_array_updateTime_criteria,
  "nameLower": sr_array_nameLower_criteria,
  "default": sr_array_default_criteria,
  "createTime": sr_array_createTime_criteria,
  "name": sr_array_name_criteria,
  "context": sr_array_context_criteria,
  "doc": sr_array_doc_criteria,
  "id": sr_array_id_criteria,
  "tenant": sr_array_tenant_criteria
}

Types

`sr_array_default_criteria`

Criteria expression specification of default attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_array_description_criteria`

Criteria expression specification of description attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_array_displayName_criteria`

Criteria expression specification of displayName attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_array_doc_criteria`

Criteria expression specification of doc attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_array_id_criteria`

Criteria expression specification of id attribute in entity sr_array

Input Field	Description
`_eq` - `Int`	Equals criteria
`_lte` - `Int`	Less than or equals criteria
`_gte` - `Int`	Greater or equals criteria
`_gt` - `Int`	Greater than criteria
`_lt` - `Int`	Less than criteria

Example

{"_eq": 987, "_lte": 987, "_gte": 123, "_gt": 987, "_lt": 123}

Types

`sr_array_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_array_name_criteria`

Criteria expression specification of name attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_array_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`default` - `order_by_enum`	The type default
`createTime` - `order_by_enum`	The create time
`name` - `order_by_enum`
`context` - `order_by_enum`	The schema context
`doc` - `order_by_enum`	Documentation
`id` - `order_by_enum`	The schema id
`tenant` - `order_by_enum`	The tenant

Example

{
  "owner": order_by_enum,
  "replicatedTo": order_by_enum,
  "userDescription": order_by_enum,
  "replicatedFrom": order_by_enum,
  "qualifiedName": order_by_enum,
  "displayName": order_by_enum,
  "description": order_by_enum,
  "updateTime": order_by_enum,
  "nameLower": order_by_enum,
  "default": order_by_enum,
  "createTime": order_by_enum,
  "name": order_by_enum,
  "context": order_by_enum,
  "doc": order_by_enum,
  "id": order_by_enum,
  "tenant": order_by_enum
}

Types

`sr_array_owner_criteria`

Criteria expression specification of owner attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_array_qualifiedName_criteria`

Criteria expression specification of qualifiedName attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_array_tenant_criteria`

Criteria expression specification of tenant attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_array_updateTime_criteria`

Criteria expression specification of updateTime attribute in entity sr_array

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_array_userDescription_criteria`

Criteria expression specification of userDescription attribute in entity sr_array

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_combined`

Type representing a combined datatype

Field Name	Description
`owner` - `String`
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`kind` - `String`	The combined kind
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`default` - `String`	The type default
`createTime` - `DateTime`	The create time
`name` - `String`
`context` - `String`	The schema context
`doc` - `String`	Documentation
`id` - `Int`	The schema id
`tenant` - `String`	The tenant
`schema` - `sr_schema`	The schema
`types` - `[sr_type]`	The types in the combined type
`child_types` - `[sr_type]`	The child types
`parent_type` - `sr_type`	The parent type
`field` - `sr_field`	The field
`array` - `sr_array`	The array
`map_value` - `sr_map`	The map
`schemas` - `[sr_schema]`	The schemas
`map_key` - `sr_map`	The map
`combined` - `sr_combined`	The combined type
`status` - `status_enum`	Status of the entity
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "abc123",
  "userDescription": "abc123",
  "qualifiedName": "xyz789",
  "displayName": "xyz789",
  "kind": "abc123",
  "description": "abc123",
  "updateTime": DateTime,
  "nameLower": "abc123",
  "default": "xyz789",
  "createTime": DateTime,
  "name": "xyz789",
  "context": "abc123",
  "doc": "abc123",
  "id": 123,
  "tenant": "xyz789",
  "schema": sr_schema,
  "types": [sr_type],
  "child_types": [sr_type],
  "parent_type": sr_type,
  "field": sr_field,
  "array": sr_array,
  "map_value": sr_map,
  "schemas": [sr_schema],
  "map_key": sr_map,
  "combined": sr_combined,
  "status": status_enum,
  "business_metadata": [business_metadata_attribute],
  "tags": ["abc123"]
}

Types

`sr_combined_context_criteria`

Criteria expression specification of context attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`sr_combined_createTime_criteria`

Criteria expression specification of createTime attribute in entity sr_combined

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_combined_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[sr_combined_criteria]`	Logical operation for expressions
`_and` - `[sr_combined_criteria]`	Logical operation for expressions
`owner` - `sr_combined_owner_criteria`
`userDescription` - `sr_combined_userDescription_criteria`
`qualifiedName` - `sr_combined_qualifiedName_criteria`
`displayName` - `sr_combined_displayName_criteria`
`kind` - `sr_combined_kind_criteria`	The combined kind
`description` - `sr_combined_description_criteria`
`updateTime` - `sr_combined_updateTime_criteria`	The update time
`nameLower` - `sr_combined_nameLower_criteria`	Lowercase representation of the name
`default` - `sr_combined_default_criteria`	The type default
`createTime` - `sr_combined_createTime_criteria`	The create time
`name` - `sr_combined_name_criteria`
`context` - `sr_combined_context_criteria`	The schema context
`doc` - `sr_combined_doc_criteria`	Documentation
`id` - `sr_combined_id_criteria`	The schema id
`tenant` - `sr_combined_tenant_criteria`	The tenant

Example

{
  "_or": [sr_combined_criteria],
  "_and": [sr_combined_criteria],
  "owner": sr_combined_owner_criteria,
  "userDescription": sr_combined_userDescription_criteria,
  "qualifiedName": sr_combined_qualifiedName_criteria,
  "displayName": sr_combined_displayName_criteria,
  "kind": sr_combined_kind_criteria,
  "description": sr_combined_description_criteria,
  "updateTime": sr_combined_updateTime_criteria,
  "nameLower": sr_combined_nameLower_criteria,
  "default": sr_combined_default_criteria,
  "createTime": sr_combined_createTime_criteria,
  "name": sr_combined_name_criteria,
  "context": sr_combined_context_criteria,
  "doc": sr_combined_doc_criteria,
  "id": sr_combined_id_criteria,
  "tenant": sr_combined_tenant_criteria
}

Types

`sr_combined_default_criteria`

Criteria expression specification of default attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_combined_description_criteria`

Criteria expression specification of description attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`sr_combined_displayName_criteria`

Criteria expression specification of displayName attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_combined_doc_criteria`

Criteria expression specification of doc attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`sr_combined_id_criteria`

Criteria expression specification of id attribute in entity sr_combined

Input Field	Description
`_eq` - `Int`	Equals criteria
`_lte` - `Int`	Less than or equals criteria
`_gte` - `Int`	Greater or equals criteria
`_gt` - `Int`	Greater than criteria
`_lt` - `Int`	Less than criteria

Example

{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 987, "_lt": 987}

Types

`sr_combined_kind_criteria`

Criteria expression specification of kind attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_combined_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_combined_name_criteria`

Criteria expression specification of name attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_combined_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`kind` - `order_by_enum`	The combined kind
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`default` - `order_by_enum`	The type default
`createTime` - `order_by_enum`	The create time
`name` - `order_by_enum`
`context` - `order_by_enum`	The schema context
`doc` - `order_by_enum`	Documentation
`id` - `order_by_enum`	The schema id
`tenant` - `order_by_enum`	The tenant

Example

{
  "owner": order_by_enum,
  "replicatedTo": order_by_enum,
  "userDescription": order_by_enum,
  "replicatedFrom": order_by_enum,
  "qualifiedName": order_by_enum,
  "displayName": order_by_enum,
  "kind": order_by_enum,
  "description": order_by_enum,
  "updateTime": order_by_enum,
  "nameLower": order_by_enum,
  "default": order_by_enum,
  "createTime": order_by_enum,
  "name": order_by_enum,
  "context": order_by_enum,
  "doc": order_by_enum,
  "id": order_by_enum,
  "tenant": order_by_enum
}

Types

`sr_combined_owner_criteria`

Criteria expression specification of owner attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_combined_qualifiedName_criteria`

Criteria expression specification of qualifiedName attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_combined_tenant_criteria`

Criteria expression specification of tenant attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_combined_updateTime_criteria`

Criteria expression specification of updateTime attribute in entity sr_combined

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_combined_userDescription_criteria`

Criteria expression specification of userDescription attribute in entity sr_combined

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_entity`

Type representing a Schema Registry entity

Field Name	Description
`owner` - `String`
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`createTime` - `DateTime`	The create time
`name` - `String`
`context` - `String`	The schema context
`doc` - `String`	Documentation
`id` - `Int`	The schema id
`tenant` - `String`	The tenant
`schemas` - `[sr_schema]`	The schemas
`schema` - `sr_schema`	Schema for the entity
`status` - `status_enum`	Status of the entity
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "abc123",
  "userDescription": "abc123",
  "qualifiedName": "abc123",
  "displayName": "abc123",
  "description": "abc123",
  "updateTime": DateTime,
  "nameLower": "xyz789",
  "createTime": DateTime,
  "name": "abc123",
  "context": "xyz789",
  "doc": "abc123",
  "id": 987,
  "tenant": "abc123",
  "schemas": [sr_schema],
  "schema": sr_schema,
  "status": status_enum,
  "business_metadata": [business_metadata_attribute],
  "tags": ["abc123"]
}

Types

`sr_entity_context_criteria`

Criteria expression specification of context attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_entity_createTime_criteria`

Criteria expression specification of createTime attribute in entity sr_entity

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_entity_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[sr_entity_criteria]`	Logical operation for expressions
`_and` - `[sr_entity_criteria]`	Logical operation for expressions
`owner` - `sr_entity_owner_criteria`
`userDescription` - `sr_entity_userDescription_criteria`
`qualifiedName` - `sr_entity_qualifiedName_criteria`
`displayName` - `sr_entity_displayName_criteria`
`description` - `sr_entity_description_criteria`
`updateTime` - `sr_entity_updateTime_criteria`	The update time
`nameLower` - `sr_entity_nameLower_criteria`	Lowercase representation of the name
`createTime` - `sr_entity_createTime_criteria`	The create time
`name` - `sr_entity_name_criteria`
`context` - `sr_entity_context_criteria`	The schema context
`doc` - `sr_entity_doc_criteria`	Documentation
`id` - `sr_entity_id_criteria`	The schema id
`tenant` - `sr_entity_tenant_criteria`	The tenant

Example

{
  "_or": [sr_entity_criteria],
  "_and": [sr_entity_criteria],
  "owner": sr_entity_owner_criteria,
  "userDescription": sr_entity_userDescription_criteria,
  "qualifiedName": sr_entity_qualifiedName_criteria,
  "displayName": sr_entity_displayName_criteria,
  "description": sr_entity_description_criteria,
  "updateTime": sr_entity_updateTime_criteria,
  "nameLower": sr_entity_nameLower_criteria,
  "createTime": sr_entity_createTime_criteria,
  "name": sr_entity_name_criteria,
  "context": sr_entity_context_criteria,
  "doc": sr_entity_doc_criteria,
  "id": sr_entity_id_criteria,
  "tenant": sr_entity_tenant_criteria
}

Types

`sr_entity_description_criteria`

Criteria expression specification of description attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_entity_displayName_criteria`

Criteria expression specification of displayName attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_entity_doc_criteria`

Criteria expression specification of doc attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_entity_id_criteria`

Criteria expression specification of id attribute in entity sr_entity

Input Field	Description
`_eq` - `Int`	Equals criteria
`_lte` - `Int`	Less than or equals criteria
`_gte` - `Int`	Greater or equals criteria
`_gt` - `Int`	Greater than criteria
`_lt` - `Int`	Less than criteria

Example

{"_eq": 123, "_lte": 987, "_gte": 987, "_gt": 987, "_lt": 123}

Types

`sr_entity_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_entity_name_criteria`

Criteria expression specification of name attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`sr_entity_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`createTime` - `order_by_enum`	The create time
`name` - `order_by_enum`
`context` - `order_by_enum`	The schema context
`doc` - `order_by_enum`	Documentation
`id` - `order_by_enum`	The schema id
`tenant` - `order_by_enum`	The tenant

Example

{
  "owner": order_by_enum,
  "replicatedTo": order_by_enum,
  "userDescription": order_by_enum,
  "replicatedFrom": order_by_enum,
  "qualifiedName": order_by_enum,
  "displayName": order_by_enum,
  "description": order_by_enum,
  "updateTime": order_by_enum,
  "nameLower": order_by_enum,
  "createTime": order_by_enum,
  "name": order_by_enum,
  "context": order_by_enum,
  "doc": order_by_enum,
  "id": order_by_enum,
  "tenant": order_by_enum
}

Types

`sr_entity_owner_criteria`

Criteria expression specification of owner attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_entity_qualifiedName_criteria`

Criteria expression specification of qualifiedName attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_entity_tenant_criteria`

Criteria expression specification of tenant attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_entity_updateTime_criteria`

Criteria expression specification of updateTime attribute in entity sr_entity

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_entity_userDescription_criteria`

Criteria expression specification of userDescription attribute in entity sr_entity

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_enum`

Type representing an enum datatype

Field Name	Description
`owner` - `String`
`aliases` - `[String]`	The enum aliases
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`symbols` - `[String]`	The enum symbols
`default` - `String`	The type default
`createTime` - `DateTime`	The create time
`name` - `String`
`context` - `String`	The schema context
`namespace` - `String`	The enum namespace
`doc` - `String`	Documentation
`id` - `Int`	The schema id
`tenant` - `String`	The tenant
`schema` - `sr_schema`	The schema
`field` - `sr_field`	The field
`array` - `sr_array`	The array
`map_value` - `sr_map`	The map
`schemas` - `[sr_schema]`	The schemas
`child_types` - `[sr_type]`	The child types
`map_key` - `sr_map`	The map
`combined` - `sr_combined`	The combined type
`parent_type` - `sr_type`	The parent type
`status` - `status_enum`	Status of the entity
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "xyz789",
  "aliases": ["abc123"],
  "userDescription": "abc123",
  "qualifiedName": "xyz789",
  "displayName": "xyz789",
  "description": "abc123",
  "updateTime": DateTime,
  "nameLower": "abc123",
  "symbols": ["xyz789"],
  "default": "xyz789",
  "createTime": DateTime,
  "name": "xyz789",
  "context": "xyz789",
  "namespace": "xyz789",
  "doc": "abc123",
  "id": 123,
  "tenant": "abc123",
  "schema": sr_schema,
  "field": sr_field,
  "array": sr_array,
  "map_value": sr_map,
  "schemas": [sr_schema],
  "child_types": [sr_type],
  "map_key": sr_map,
  "combined": sr_combined,
  "parent_type": sr_type,
  "status": status_enum,
  "business_metadata": [business_metadata_attribute],
  "tags": ["abc123"]
}

Types

`sr_enum_context_criteria`

Criteria expression specification of context attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_enum_createTime_criteria`

Criteria expression specification of createTime attribute in entity sr_enum

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_enum_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[sr_enum_criteria]`	Logical operation for expressions
`_and` - `[sr_enum_criteria]`	Logical operation for expressions
`owner` - `sr_enum_owner_criteria`
`userDescription` - `sr_enum_userDescription_criteria`
`qualifiedName` - `sr_enum_qualifiedName_criteria`
`displayName` - `sr_enum_displayName_criteria`
`description` - `sr_enum_description_criteria`
`updateTime` - `sr_enum_updateTime_criteria`	The update time
`nameLower` - `sr_enum_nameLower_criteria`	Lowercase representation of the name
`default` - `sr_enum_default_criteria`	The type default
`createTime` - `sr_enum_createTime_criteria`	The create time
`name` - `sr_enum_name_criteria`
`context` - `sr_enum_context_criteria`	The schema context
`namespace` - `sr_enum_namespace_criteria`	The enum namespace
`doc` - `sr_enum_doc_criteria`	Documentation
`id` - `sr_enum_id_criteria`	The schema id
`tenant` - `sr_enum_tenant_criteria`	The tenant

Example

{
  "_or": [sr_enum_criteria],
  "_and": [sr_enum_criteria],
  "owner": sr_enum_owner_criteria,
  "userDescription": sr_enum_userDescription_criteria,
  "qualifiedName": sr_enum_qualifiedName_criteria,
  "displayName": sr_enum_displayName_criteria,
  "description": sr_enum_description_criteria,
  "updateTime": sr_enum_updateTime_criteria,
  "nameLower": sr_enum_nameLower_criteria,
  "default": sr_enum_default_criteria,
  "createTime": sr_enum_createTime_criteria,
  "name": sr_enum_name_criteria,
  "context": sr_enum_context_criteria,
  "namespace": sr_enum_namespace_criteria,
  "doc": sr_enum_doc_criteria,
  "id": sr_enum_id_criteria,
  "tenant": sr_enum_tenant_criteria
}

Types

`sr_enum_default_criteria`

Criteria expression specification of default attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_enum_description_criteria`

Criteria expression specification of description attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_enum_displayName_criteria`

Criteria expression specification of displayName attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_enum_doc_criteria`

Criteria expression specification of doc attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_enum_id_criteria`

Criteria expression specification of id attribute in entity sr_enum

Input Field	Description
`_eq` - `Int`	Equals criteria
`_lte` - `Int`	Less than or equals criteria
`_gte` - `Int`	Greater or equals criteria
`_gt` - `Int`	Greater than criteria
`_lt` - `Int`	Less than criteria

Example

{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 987}

Types

`sr_enum_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_enum_name_criteria`

Criteria expression specification of name attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`sr_enum_namespace_criteria`

Criteria expression specification of namespace attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`sr_enum_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`aliases` - `order_by_enum`	The enum aliases
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`symbols` - `order_by_enum`	The enum symbols
`default` - `order_by_enum`	The type default
`createTime` - `order_by_enum`	The create time
`name` - `order_by_enum`
`context` - `order_by_enum`	The schema context
`namespace` - `order_by_enum`	The enum namespace
`doc` - `order_by_enum`	Documentation
`id` - `order_by_enum`	The schema id
`tenant` - `order_by_enum`	The tenant

Example

{
  "owner": order_by_enum,
  "aliases": order_by_enum,
  "replicatedTo": order_by_enum,
  "userDescription": order_by_enum,
  "replicatedFrom": order_by_enum,
  "qualifiedName": order_by_enum,
  "displayName": order_by_enum,
  "description": order_by_enum,
  "updateTime": order_by_enum,
  "nameLower": order_by_enum,
  "symbols": order_by_enum,
  "default": order_by_enum,
  "createTime": order_by_enum,
  "name": order_by_enum,
  "context": order_by_enum,
  "namespace": order_by_enum,
  "doc": order_by_enum,
  "id": order_by_enum,
  "tenant": order_by_enum
}

Types

`sr_enum_owner_criteria`

Criteria expression specification of owner attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_enum_qualifiedName_criteria`

Criteria expression specification of qualifiedName attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_enum_tenant_criteria`

Criteria expression specification of tenant attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_enum_updateTime_criteria`

Criteria expression specification of updateTime attribute in entity sr_enum

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_enum_userDescription_criteria`

Criteria expression specification of userDescription attribute in entity sr_enum

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_field`

Type representing a field

Field Name	Description
`owner` - `String`
`aliases` - `[String]`	The field aliases
`userDescription` - `String`
`qualifiedName` - `String`
`displayName` - `String`
`description` - `String`
`updateTime` - `DateTime`	The update time
`nameLower` - `String`	Lowercase representation of the name
`label` - `String`	The field label
`default` - `String`	The field default
`createTime` - `DateTime`	The create time
`name` - `String`
`context` - `String`	The schema context
`doc` - `String`	Documentation
`id` - `Int`	The schema id
`tag` - `Int`	The field tag
`tenant` - `String`	The tenant
`record` - `sr_record`	The record
`schemas` - `[sr_schema]`	The schemas
`type` - `sr_type`	The field type
`schema` - `sr_schema`	Schema for the entity
`status` - `status_enum`	Status of the entity
`business_metadata` - `[business_metadata_attribute]`	Business metadata for the entity
`tags` - `[String]`	Tags for the entity

Example

{
  "owner": "abc123",
  "aliases": ["abc123"],
  "userDescription": "xyz789",
  "qualifiedName": "abc123",
  "displayName": "abc123",
  "description": "xyz789",
  "updateTime": DateTime,
  "nameLower": "xyz789",
  "label": "abc123",
  "default": "abc123",
  "createTime": DateTime,
  "name": "xyz789",
  "context": "abc123",
  "doc": "abc123",
  "id": 987,
  "tag": 987,
  "tenant": "xyz789",
  "record": sr_record,
  "schemas": [sr_schema],
  "type": sr_type,
  "schema": sr_schema,
  "status": status_enum,
  "business_metadata": [business_metadata_attribute],
  "tags": ["xyz789"]
}

Types

`sr_field_context_criteria`

Criteria expression specification of context attribute in entity sr_field

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_field_createTime_criteria`

Criteria expression specification of createTime attribute in entity sr_field

Input Field	Description
`_eq` - `DateTime`	Equals criteria
`_lte` - `DateTime`	Less than or equals criteria
`_gte` - `DateTime`	Greater or equals criteria
`_gt` - `DateTime`	Greater than criteria
`_lt` - `DateTime`	Less than criteria
`_between` - `between_start_end`	Between criteria
`_since` - `since_enum`	Since criteria

Example

{
  "_eq": DateTime,
  "_lte": DateTime,
  "_gte": DateTime,
  "_gt": DateTime,
  "_lt": DateTime,
  "_between": between_start_end,
  "_since": since_enum
}

Types

`sr_field_criteria`

Where logical specification of the provided list of criteria expressions

Field Name	Description
`_or` - `[sr_field_criteria]`	Logical operation for expressions
`_and` - `[sr_field_criteria]`	Logical operation for expressions
`owner` - `sr_field_owner_criteria`
`userDescription` - `sr_field_userDescription_criteria`
`qualifiedName` - `sr_field_qualifiedName_criteria`
`displayName` - `sr_field_displayName_criteria`
`description` - `sr_field_description_criteria`
`updateTime` - `sr_field_updateTime_criteria`	The update time
`nameLower` - `sr_field_nameLower_criteria`	Lowercase representation of the name
`label` - `sr_field_label_criteria`	The field label
`default` - `sr_field_default_criteria`	The field default
`createTime` - `sr_field_createTime_criteria`	The create time
`name` - `sr_field_name_criteria`
`context` - `sr_field_context_criteria`	The schema context
`doc` - `sr_field_doc_criteria`	Documentation
`id` - `sr_field_id_criteria`	The schema id
`tag` - `sr_field_tag_criteria`	The field tag
`tenant` - `sr_field_tenant_criteria`	The tenant

Example

{
  "_or": [sr_field_criteria],
  "_and": [sr_field_criteria],
  "owner": sr_field_owner_criteria,
  "userDescription": sr_field_userDescription_criteria,
  "qualifiedName": sr_field_qualifiedName_criteria,
  "displayName": sr_field_displayName_criteria,
  "description": sr_field_description_criteria,
  "updateTime": sr_field_updateTime_criteria,
  "nameLower": sr_field_nameLower_criteria,
  "label": sr_field_label_criteria,
  "default": sr_field_default_criteria,
  "createTime": sr_field_createTime_criteria,
  "name": sr_field_name_criteria,
  "context": sr_field_context_criteria,
  "doc": sr_field_doc_criteria,
  "id": sr_field_id_criteria,
  "tag": sr_field_tag_criteria,
  "tenant": sr_field_tenant_criteria
}

Types

`sr_field_default_criteria`

Criteria expression specification of default attribute in entity sr_field

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "xyz789",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_field_description_criteria`

Criteria expression specification of description attribute in entity sr_field

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_field_displayName_criteria`

Criteria expression specification of displayName attribute in entity sr_field

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "abc123",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "abc123"
}

Types

`sr_field_doc_criteria`

Criteria expression specification of doc attribute in entity sr_field

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_field_id_criteria`

Criteria expression specification of id attribute in entity sr_field

Input Field	Description
`_eq` - `Int`	Equals criteria
`_lte` - `Int`	Less than or equals criteria
`_gte` - `Int`	Greater or equals criteria
`_gt` - `Int`	Greater than criteria
`_lt` - `Int`	Less than criteria

Example

{"_eq": 987, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 987}

Types

`sr_field_label_criteria`

Criteria expression specification of label attribute in entity sr_field

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "xyz789"
}

Types

`sr_field_nameLower_criteria`

Criteria expression specification of nameLower attribute in entity sr_field

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "abc123",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "xyz789",
  "_lt": "abc123",
  "_starts_with": "abc123"
}

Types

`sr_field_name_criteria`

Criteria expression specification of name attribute in entity sr_field

Input Field	Description
`_eq` - `String`	Equals criteria
`_lte` - `String`	Less than or equals criteria
`_gte` - `String`	Greater or equals criteria
`_gt` - `String`	Greater than criteria
`_lt` - `String`	Less than criteria
`_starts_with` - `String`	Starts with criteria

Example

{
  "_eq": "xyz789",
  "_lte": "xyz789",
  "_gte": "abc123",
  "_gt": "abc123",
  "_lt": "xyz789",
  "_starts_with": "xyz789"
}

Types

`sr_field_order`

Order by attribute

Input Field	Description
`owner` - `order_by_enum`
`aliases` - `order_by_enum`	The field aliases
`replicatedTo` - `order_by_enum`
`userDescription` - `order_by_enum`
`replicatedFrom` - `order_by_enum`
`qualifiedName` - `order_by_enum`
`displayName` - `order_by_enum`
`description` - `order_by_enum`
`updateTime` - `order_by_enum`	The update time
`nameLower` - `order_by_enum`	Lowercase representation of the name
`label` - `order_by_enum`	The field label
`default` - `order_by_enum`	The field default