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
https://psrc-xxxxx.region.provider.confluent.cloud/catalog/graphqlQueries
cf_entity
Description
Type representing a Confluent entity
Response
Returns [cf_entity]
Arguments
| 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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": cf_entity_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 987,
"order_by": [cf_entity_order],
"deleted": false
}
Response
{
"data": {
"cf_entity": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
cf_entity_count
Description
Type representing a Confluent entity
Response
Returns [cf_entity_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": cf_entity_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 123,
"order_by": [cf_entity_order],
"deleted": true
}
Response
{
"data": {
"cf_entity_count": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
cf_environment
Description
Type representing an environment
Response
Returns [cf_environment]
Arguments
| Name | Description |
|---|---|
where - cf_environment_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_environment_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query cf_environment(
$where: cf_environment_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [cf_environment_order],
$deleted: Boolean
) {
cf_environment(
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
ownerEmail
createTime
name
doc
id
deprecatedTime
tenant
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": cf_environment_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [cf_environment_order],
"deleted": true
}
Response
{
"data": {
"cf_environment": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"id": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
cf_environment_count
Description
Type representing an environment
Response
Returns [cf_environment_count]
Arguments
| Name | Description |
|---|---|
where - cf_environment_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_environment_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query cf_environment_count(
$where: cf_environment_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [cf_environment_order],
$deleted: Boolean
) {
cf_environment_count(
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
ownerEmail
createTime
name
doc
id
deprecatedTime
tenant
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": cf_environment_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 987,
"order_by": [cf_environment_order],
"deleted": true
}
Response
{
"data": {
"cf_environment_count": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "xyz789",
"id": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
cf_tenant
Description
Type representing a Confluent tenant
Response
Returns [cf_tenant]
Arguments
| 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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": cf_tenant_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 987,
"order_by": [cf_tenant_order],
"deleted": false
}
Response
{
"data": {
"cf_tenant": [
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
cf_tenant_count
Description
Type representing a Confluent tenant
Response
Returns [cf_tenant_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": cf_tenant_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 987,
"order_by": [cf_tenant_order],
"deleted": true
}
Response
{
"data": {
"cf_tenant_count": [
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
cn_connector
Description
Type representing a connector
Response
Returns [cn_connector]
Arguments
| Name | Description |
|---|---|
where - cn_connector_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 - [cn_connector_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query cn_connector(
$where: cn_connector_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [cn_connector_order],
$deleted: Boolean
) {
cn_connector(
where: $where,
business_metadata: $business_metadata,
tags: $tags,
limit: $limit,
offset: $offset,
order_by: $order_by,
deleted: $deleted
) {
displayName
description
nameLower
clusterId
type
sourceEndpoint
deprecatedTime
class
outputFormat
tenant
owner
userDescription
kafkaApiKey
qualifiedName
updateTime
kafkaServiceAccountId
inputFormat
sourceSchema
tasksMax
ownerEmail
createTime
name
dlqTopic
doc
kafkaAuthMode
status
topics {
...kafka_topicFragment
}
activated_for_pipelines {
...pl_pipelineFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": cn_connector_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 987,
"order_by": [cn_connector_order],
"deleted": true
}
Response
{
"data": {
"cn_connector": [
{
"displayName": "abc123",
"description": "abc123",
"nameLower": "abc123",
"clusterId": "abc123",
"type": "SOURCE",
"sourceEndpoint": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"class": "xyz789",
"outputFormat": "xyz789",
"tenant": "xyz789",
"owner": "abc123",
"userDescription": "abc123",
"kafkaApiKey": "xyz789",
"qualifiedName": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"kafkaServiceAccountId": "xyz789",
"inputFormat": "abc123",
"sourceSchema": "abc123",
"tasksMax": 123,
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"dlqTopic": "xyz789",
"doc": "abc123",
"kafkaAuthMode": "KAFKA_API_KEY",
"status": "NONE",
"topics": [kafka_topic],
"activated_for_pipelines": [pl_pipeline],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
cn_connector_count
Description
Type representing a connector
Response
Returns [cn_connector_count]
Arguments
| Name | Description |
|---|---|
where - cn_connector_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 - [cn_connector_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query cn_connector_count(
$where: cn_connector_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [cn_connector_order],
$deleted: Boolean
) {
cn_connector_count(
where: $where,
business_metadata: $business_metadata,
tags: $tags,
limit: $limit,
offset: $offset,
order_by: $order_by,
deleted: $deleted
) {
displayName
description
nameLower
clusterId
type
sourceEndpoint
deprecatedTime
class
outputFormat
tenant
owner
userDescription
kafkaApiKey
qualifiedName
updateTime
kafkaServiceAccountId
inputFormat
sourceSchema
tasksMax
ownerEmail
createTime
name
dlqTopic
doc
kafkaAuthMode
status
topics {
...kafka_topicFragment
}
activated_for_pipelines {
...pl_pipelineFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": cn_connector_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 123,
"order_by": [cn_connector_order],
"deleted": false
}
Response
{
"data": {
"cn_connector_count": [
{
"displayName": "abc123",
"description": "xyz789",
"nameLower": "abc123",
"clusterId": "xyz789",
"type": "SOURCE",
"sourceEndpoint": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"class": "xyz789",
"outputFormat": "abc123",
"tenant": "abc123",
"owner": "abc123",
"userDescription": "xyz789",
"kafkaApiKey": "abc123",
"qualifiedName": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"kafkaServiceAccountId": "abc123",
"inputFormat": "xyz789",
"sourceSchema": "xyz789",
"tasksMax": 123,
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"dlqTopic": "abc123",
"doc": "xyz789",
"kafkaAuthMode": "KAFKA_API_KEY",
"status": "NONE",
"topics": [kafka_topic],
"activated_for_pipelines": [pl_pipeline],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
kafka_cluster_link
Description
Type representing a cluster link
Response
Returns [kafka_cluster_link]
Arguments
| Name | Description |
|---|---|
where - kafka_cluster_link_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_cluster_link_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query kafka_cluster_link(
$where: kafka_cluster_link_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [kafka_cluster_link_order],
$deleted: Boolean
) {
kafka_cluster_link(
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
ownerEmail
externalSourceCluster
connectionMode
createTime
linkMode
name
doc
id
deprecatedTime
tenant
destination_cluster {
...kafka_logical_clusterFragment
}
mirror_topics {
...kafka_topicFragment
}
source_cluster {
...kafka_logical_clusterFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": kafka_cluster_link_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 987,
"order_by": [kafka_cluster_link_order],
"deleted": true
}
Response
{
"data": {
"kafka_cluster_link": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"externalSourceCluster": "xyz789",
"connectionMode": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"linkMode": "xyz789",
"name": "xyz789",
"doc": "xyz789",
"id": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"destination_cluster": kafka_logical_cluster,
"mirror_topics": [kafka_topic],
"source_cluster": kafka_logical_cluster,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
kafka_cluster_link_count
Description
Type representing a cluster link
Response
Returns [kafka_cluster_link_count]
Arguments
| Name | Description |
|---|---|
where - kafka_cluster_link_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_cluster_link_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query kafka_cluster_link_count(
$where: kafka_cluster_link_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [kafka_cluster_link_order],
$deleted: Boolean
) {
kafka_cluster_link_count(
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
ownerEmail
externalSourceCluster
connectionMode
createTime
linkMode
name
doc
id
deprecatedTime
tenant
destination_cluster {
...kafka_logical_clusterFragment
}
mirror_topics {
...kafka_topicFragment
}
source_cluster {
...kafka_logical_clusterFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": kafka_cluster_link_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 987,
"order_by": [kafka_cluster_link_order],
"deleted": false
}
Response
{
"data": {
"kafka_cluster_link_count": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"externalSourceCluster": "abc123",
"connectionMode": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"linkMode": "xyz789",
"name": "abc123",
"doc": "xyz789",
"id": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"destination_cluster": kafka_logical_cluster,
"mirror_topics": [kafka_topic],
"source_cluster": kafka_logical_cluster,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 987
}
]
}
}
kafka_logical_cluster
Description
Type representing a logical Kafka cluster
Response
Returns [kafka_logical_cluster]
Arguments
| 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
) {
displayName
description
nameLower
availability
type
cku
network
provider
id
deprecatedTime
sku
tenant
owner
userDescription
qualifiedName
updateTime
ownerEmail
createTime
name
doc
region
status
deactivateTime
destination_links {
...kafka_cluster_linkFragment
}
pipelines {
...pl_pipelineFragment
}
topics {
...kafka_topicFragment
}
source_links {
...kafka_cluster_linkFragment
}
tag_defs {
...tag_defFragment
}
entity_status
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": [
{
"displayName": "xyz789",
"description": "xyz789",
"nameLower": "abc123",
"availability": "abc123",
"type": "xyz789",
"cku": 123,
"network": "xyz789",
"provider": "xyz789",
"id": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"sku": "UNDEFINED",
"tenant": "abc123",
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "abc123",
"region": "abc123",
"status": "xyz789",
"deactivateTime": "2007-12-03T10:15:30Z",
"destination_links": [kafka_cluster_link],
"pipelines": [pl_pipeline],
"topics": [kafka_topic],
"source_links": [kafka_cluster_link],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
kafka_logical_cluster_count
Description
Type representing a logical Kafka cluster
Response
Returns [kafka_logical_cluster_count]
Arguments
| 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_count(
$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_count(
where: $where,
business_metadata: $business_metadata,
tags: $tags,
limit: $limit,
offset: $offset,
order_by: $order_by,
deleted: $deleted
) {
displayName
description
nameLower
availability
type
cku
network
provider
id
deprecatedTime
sku
tenant
owner
userDescription
qualifiedName
updateTime
ownerEmail
createTime
name
doc
region
status
deactivateTime
destination_links {
...kafka_cluster_linkFragment
}
pipelines {
...pl_pipelineFragment
}
topics {
...kafka_topicFragment
}
source_links {
...kafka_cluster_linkFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": kafka_logical_cluster_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 123,
"order_by": [kafka_logical_cluster_order],
"deleted": true
}
Response
{
"data": {
"kafka_logical_cluster_count": [
{
"displayName": "xyz789",
"description": "xyz789",
"nameLower": "xyz789",
"availability": "abc123",
"type": "abc123",
"cku": 123,
"network": "abc123",
"provider": "xyz789",
"id": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"sku": "UNDEFINED",
"tenant": "xyz789",
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "xyz789",
"region": "xyz789",
"status": "xyz789",
"deactivateTime": "2007-12-03T10:15:30Z",
"destination_links": [kafka_cluster_link],
"pipelines": [pl_pipeline],
"topics": [kafka_topic],
"source_links": [kafka_cluster_link],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
kafka_topic
Description
Type representing a Kafka topic
Response
Returns [kafka_topic]
Arguments
| 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
) {
replicationFactor
maxCompactionLagMs
compressionType
messageDownconversionEnable
minCleanableDirtyRatio
uncleanLeaderElectionEnable
minInsyncReplicas
retentionBytes
followerReplicationThrottledReplicas
id
tenant
externalSourceTopicName
fileDeleteDelayMs
qualifiedName
leaderReplicationThrottledReplicas
messageTimestampType
preallocate
isInternal
segmentBytes
segmentIndexBytes
flushMessages
name
doc
messageFormatVersion
indexIntervalBytes
minCompactionLagMs
segmentMs
mirrorTopicState
segmentJitterMs
maxMessageBytes
displayName
description
nameLower
valueSchemaValidation
deprecatedTime
externalSourceTopicId
owner
retentionMs
userDescription
deleteRetentionMs
flushMs
updateTime
mirrorTopicUpdateTime
ownerEmail
partitionsCount
messageTimestampDifferenceMaxMs
createTime
keySchemaValidation
cleanupPolicy
connectors {
...cn_connectorFragment
}
mirror_topics {
...kafka_topicFragment
}
source_topic {
...kafka_topicFragment
}
logical_cluster {
...kafka_logical_clusterFragment
}
input_for_pipelines {
...pl_pipelineFragment
}
output_for_pipelines {
...pl_pipelineFragment
}
activated_for_pipelines {
...pl_pipelineFragment
}
cluster_link {
...kafka_cluster_linkFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": kafka_topic_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 987,
"order_by": [kafka_topic_order],
"deleted": false
}
Response
{
"data": {
"kafka_topic": [
{
"replicationFactor": 987,
"maxCompactionLagMs": {},
"compressionType": "UNSPECIFIED",
"messageDownconversionEnable": false,
"minCleanableDirtyRatio": 123.45,
"uncleanLeaderElectionEnable": true,
"minInsyncReplicas": 123,
"retentionBytes": {},
"followerReplicationThrottledReplicas": [
"abc123"
],
"id": "abc123",
"tenant": "abc123",
"externalSourceTopicName": "xyz789",
"fileDeleteDelayMs": {},
"qualifiedName": "xyz789",
"leaderReplicationThrottledReplicas": [
"abc123"
],
"messageTimestampType": "abc123",
"preallocate": false,
"isInternal": false,
"segmentBytes": 987,
"segmentIndexBytes": 123,
"flushMessages": {},
"name": "xyz789",
"doc": "abc123",
"messageFormatVersion": "abc123",
"indexIntervalBytes": 123,
"minCompactionLagMs": {},
"segmentMs": {},
"mirrorTopicState": "xyz789",
"segmentJitterMs": {},
"maxMessageBytes": 123,
"displayName": "xyz789",
"description": "abc123",
"nameLower": "xyz789",
"valueSchemaValidation": false,
"deprecatedTime": "2007-12-03T10:15:30Z",
"externalSourceTopicId": "abc123",
"owner": "abc123",
"retentionMs": {},
"userDescription": "abc123",
"deleteRetentionMs": {},
"flushMs": {},
"updateTime": "2007-12-03T10:15:30Z",
"mirrorTopicUpdateTime": "xyz789",
"ownerEmail": "abc123",
"partitionsCount": 987,
"messageTimestampDifferenceMaxMs": {},
"createTime": "2007-12-03T10:15:30Z",
"keySchemaValidation": true,
"cleanupPolicy": "NONE",
"connectors": [cn_connector],
"mirror_topics": [kafka_topic],
"source_topic": kafka_topic,
"logical_cluster": kafka_logical_cluster,
"input_for_pipelines": [pl_pipeline],
"output_for_pipelines": [pl_pipeline],
"activated_for_pipelines": [pl_pipeline],
"cluster_link": kafka_cluster_link,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
kafka_topic_count
Description
Type representing a Kafka topic
Response
Returns [kafka_topic_count]
Arguments
| 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_count(
$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_count(
where: $where,
business_metadata: $business_metadata,
tags: $tags,
limit: $limit,
offset: $offset,
order_by: $order_by,
deleted: $deleted
) {
replicationFactor
maxCompactionLagMs
compressionType
messageDownconversionEnable
minCleanableDirtyRatio
uncleanLeaderElectionEnable
minInsyncReplicas
retentionBytes
followerReplicationThrottledReplicas
id
tenant
externalSourceTopicName
fileDeleteDelayMs
qualifiedName
leaderReplicationThrottledReplicas
messageTimestampType
preallocate
isInternal
segmentBytes
segmentIndexBytes
flushMessages
name
doc
messageFormatVersion
indexIntervalBytes
minCompactionLagMs
segmentMs
mirrorTopicState
segmentJitterMs
maxMessageBytes
displayName
description
nameLower
valueSchemaValidation
deprecatedTime
externalSourceTopicId
owner
retentionMs
userDescription
deleteRetentionMs
flushMs
updateTime
mirrorTopicUpdateTime
ownerEmail
partitionsCount
messageTimestampDifferenceMaxMs
createTime
keySchemaValidation
cleanupPolicy
connectors {
...cn_connectorFragment
}
mirror_topics {
...kafka_topicFragment
}
source_topic {
...kafka_topicFragment
}
logical_cluster {
...kafka_logical_clusterFragment
}
input_for_pipelines {
...pl_pipelineFragment
}
output_for_pipelines {
...pl_pipelineFragment
}
activated_for_pipelines {
...pl_pipelineFragment
}
cluster_link {
...kafka_cluster_linkFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": kafka_topic_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 987,
"order_by": [kafka_topic_order],
"deleted": true
}
Response
{
"data": {
"kafka_topic_count": [
{
"replicationFactor": 123,
"maxCompactionLagMs": {},
"compressionType": "UNSPECIFIED",
"messageDownconversionEnable": true,
"minCleanableDirtyRatio": 987.65,
"uncleanLeaderElectionEnable": false,
"minInsyncReplicas": 987,
"retentionBytes": {},
"followerReplicationThrottledReplicas": [
"xyz789"
],
"id": "xyz789",
"tenant": "xyz789",
"externalSourceTopicName": "abc123",
"fileDeleteDelayMs": {},
"qualifiedName": "xyz789",
"leaderReplicationThrottledReplicas": [
"abc123"
],
"messageTimestampType": "xyz789",
"preallocate": true,
"isInternal": false,
"segmentBytes": 987,
"segmentIndexBytes": 987,
"flushMessages": {},
"name": "xyz789",
"doc": "xyz789",
"messageFormatVersion": "abc123",
"indexIntervalBytes": 987,
"minCompactionLagMs": {},
"segmentMs": {},
"mirrorTopicState": "xyz789",
"segmentJitterMs": {},
"maxMessageBytes": 987,
"displayName": "abc123",
"description": "xyz789",
"nameLower": "abc123",
"valueSchemaValidation": true,
"deprecatedTime": "2007-12-03T10:15:30Z",
"externalSourceTopicId": "abc123",
"owner": "xyz789",
"retentionMs": {},
"userDescription": "abc123",
"deleteRetentionMs": {},
"flushMs": {},
"updateTime": "2007-12-03T10:15:30Z",
"mirrorTopicUpdateTime": "xyz789",
"ownerEmail": "abc123",
"partitionsCount": 987,
"messageTimestampDifferenceMaxMs": {},
"createTime": "2007-12-03T10:15:30Z",
"keySchemaValidation": true,
"cleanupPolicy": "NONE",
"connectors": [cn_connector],
"mirror_topics": [kafka_topic],
"source_topic": kafka_topic,
"logical_cluster": kafka_logical_cluster,
"input_for_pipelines": [pl_pipeline],
"output_for_pipelines": [pl_pipeline],
"activated_for_pipelines": [pl_pipeline],
"cluster_link": kafka_cluster_link,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
ksql_logical_cluster
Description
Type representing a logical ksql cluster
Response
Returns [ksql_logical_cluster]
Arguments
| Name | Description |
|---|---|
where - ksql_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 - [ksql_logical_cluster_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query ksql_logical_cluster(
$where: ksql_logical_cluster_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [ksql_logical_cluster_order],
$deleted: Boolean
) {
ksql_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
ownerEmail
createTime
name
doc
id
deprecatedTime
tenant
tables {
...ksql_tableFragment
}
pipelines {
...pl_pipelineFragment
}
streams {
...ksql_streamFragment
}
queries {
...ksql_queryFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": ksql_logical_cluster_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 123,
"order_by": [ksql_logical_cluster_order],
"deleted": false
}
Response
{
"data": {
"ksql_logical_cluster": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "abc123",
"id": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"tables": [ksql_table],
"pipelines": [pl_pipeline],
"streams": [ksql_stream],
"queries": [ksql_query],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
ksql_logical_cluster_count
Description
Type representing a logical ksql cluster
Response
Returns [ksql_logical_cluster_count]
Arguments
| Name | Description |
|---|---|
where - ksql_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 - [ksql_logical_cluster_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query ksql_logical_cluster_count(
$where: ksql_logical_cluster_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [ksql_logical_cluster_order],
$deleted: Boolean
) {
ksql_logical_cluster_count(
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
ownerEmail
createTime
name
doc
id
deprecatedTime
tenant
tables {
...ksql_tableFragment
}
pipelines {
...pl_pipelineFragment
}
streams {
...ksql_streamFragment
}
queries {
...ksql_queryFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": ksql_logical_cluster_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [ksql_logical_cluster_order],
"deleted": false
}
Response
{
"data": {
"ksql_logical_cluster_count": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "xyz789",
"id": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"tables": [ksql_table],
"pipelines": [pl_pipeline],
"streams": [ksql_stream],
"queries": [ksql_query],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 987
}
]
}
}
ksql_query
Description
Type representing a ksql query
Response
Returns [ksql_query]
Arguments
| Name | Description |
|---|---|
where - ksql_query_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 - [ksql_query_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query ksql_query(
$where: ksql_query_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [ksql_query_order],
$deleted: Boolean
) {
ksql_query(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
logical_cluster {
...ksql_logical_clusterFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": ksql_query_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 123,
"order_by": [ksql_query_order],
"deleted": false
}
Response
{
"data": {
"ksql_query": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"logical_cluster": ksql_logical_cluster,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
ksql_query_count
Description
Type representing a ksql query
Response
Returns [ksql_query_count]
Arguments
| Name | Description |
|---|---|
where - ksql_query_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 - [ksql_query_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query ksql_query_count(
$where: ksql_query_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [ksql_query_order],
$deleted: Boolean
) {
ksql_query_count(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
logical_cluster {
...ksql_logical_clusterFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": ksql_query_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [ksql_query_order],
"deleted": true
}
Response
{
"data": {
"ksql_query_count": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"logical_cluster": ksql_logical_cluster,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
ksql_stream
Description
Type representing a ksql stream
Response
Returns [ksql_stream]
Arguments
| Name | Description |
|---|---|
where - ksql_stream_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 - [ksql_stream_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query ksql_stream(
$where: ksql_stream_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [ksql_stream_order],
$deleted: Boolean
) {
ksql_stream(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
logical_cluster {
...ksql_logical_clusterFragment
}
activated_for_pipelines {
...pl_pipelineFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": ksql_stream_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [ksql_stream_order],
"deleted": false
}
Response
{
"data": {
"ksql_stream": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"logical_cluster": ksql_logical_cluster,
"activated_for_pipelines": [pl_pipeline],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
ksql_stream_count
Description
Type representing a ksql stream
Response
Returns [ksql_stream_count]
Arguments
| Name | Description |
|---|---|
where - ksql_stream_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 - [ksql_stream_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query ksql_stream_count(
$where: ksql_stream_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [ksql_stream_order],
$deleted: Boolean
) {
ksql_stream_count(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
logical_cluster {
...ksql_logical_clusterFragment
}
activated_for_pipelines {
...pl_pipelineFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": ksql_stream_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 987,
"order_by": [ksql_stream_order],
"deleted": false
}
Response
{
"data": {
"ksql_stream_count": [
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"logical_cluster": ksql_logical_cluster,
"activated_for_pipelines": [pl_pipeline],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 123
}
]
}
}
ksql_table
Description
Type representing a ksql table
Response
Returns [ksql_table]
Arguments
| Name | Description |
|---|---|
where - ksql_table_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 - [ksql_table_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query ksql_table(
$where: ksql_table_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [ksql_table_order],
$deleted: Boolean
) {
ksql_table(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
logical_cluster {
...ksql_logical_clusterFragment
}
activated_for_pipelines {
...pl_pipelineFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": ksql_table_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 123,
"order_by": [ksql_table_order],
"deleted": false
}
Response
{
"data": {
"ksql_table": [
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"logical_cluster": ksql_logical_cluster,
"activated_for_pipelines": [pl_pipeline],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
ksql_table_count
Description
Type representing a ksql table
Response
Returns [ksql_table_count]
Arguments
| Name | Description |
|---|---|
where - ksql_table_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 - [ksql_table_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query ksql_table_count(
$where: ksql_table_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [ksql_table_order],
$deleted: Boolean
) {
ksql_table_count(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
logical_cluster {
...ksql_logical_clusterFragment
}
activated_for_pipelines {
...pl_pipelineFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": ksql_table_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [ksql_table_order],
"deleted": false
}
Response
{
"data": {
"ksql_table_count": [
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"logical_cluster": ksql_logical_cluster,
"activated_for_pipelines": [pl_pipeline],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 123
}
]
}
}
pl_pipeline
Description
Type representing a pipeline
Response
Returns [pl_pipeline]
Arguments
| Name | Description |
|---|---|
where - pl_pipeline_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 - [pl_pipeline_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query pl_pipeline(
$where: pl_pipeline_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [pl_pipeline_order],
$deleted: Boolean
) {
pl_pipeline(
where: $where,
business_metadata: $business_metadata,
tags: $tags,
limit: $limit,
offset: $offset,
order_by: $order_by,
deleted: $deleted
) {
displayName
description
queryCount
nameLower
topicCount
id
streamCount
deprecatedTime
tenant
owner
updatedBy
userDescription
method
qualifiedName
tableCount
activateTime
updateTime
connectorCount
activatedBy
ownerEmail
createTime
createdBy
name
doc
status
activated_connectors {
...cn_connectorFragment
}
kafka_logical_cluster {
...kafka_logical_clusterFragment
}
ksql_logical_cluster {
...ksql_logical_clusterFragment
}
output_topics {
...kafka_topicFragment
}
activated_topics {
...kafka_topicFragment
}
activated_tables {
...ksql_tableFragment
}
input_topics {
...kafka_topicFragment
}
activated_streams {
...ksql_streamFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": pl_pipeline_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [pl_pipeline_order],
"deleted": true
}
Response
{
"data": {
"pl_pipeline": [
{
"displayName": "xyz789",
"description": "xyz789",
"queryCount": 123,
"nameLower": "abc123",
"topicCount": 987,
"id": "abc123",
"streamCount": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"owner": "xyz789",
"updatedBy": "abc123",
"userDescription": "xyz789",
"method": "UNSPECIFIED",
"qualifiedName": "abc123",
"tableCount": 123,
"activateTime": "2007-12-03T10:15:30Z",
"updateTime": "2007-12-03T10:15:30Z",
"connectorCount": 123,
"activatedBy": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"createdBy": "abc123",
"name": "xyz789",
"doc": "xyz789",
"status": "UNSPECIFIED",
"activated_connectors": [cn_connector],
"kafka_logical_cluster": kafka_logical_cluster,
"ksql_logical_cluster": ksql_logical_cluster,
"output_topics": [kafka_topic],
"activated_topics": [kafka_topic],
"activated_tables": [ksql_table],
"input_topics": [kafka_topic],
"activated_streams": [ksql_stream],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
pl_pipeline_count
Description
Type representing a pipeline
Response
Returns [pl_pipeline_count]
Arguments
| Name | Description |
|---|---|
where - pl_pipeline_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 - [pl_pipeline_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query pl_pipeline_count(
$where: pl_pipeline_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [pl_pipeline_order],
$deleted: Boolean
) {
pl_pipeline_count(
where: $where,
business_metadata: $business_metadata,
tags: $tags,
limit: $limit,
offset: $offset,
order_by: $order_by,
deleted: $deleted
) {
displayName
description
queryCount
nameLower
topicCount
id
streamCount
deprecatedTime
tenant
owner
updatedBy
userDescription
method
qualifiedName
tableCount
activateTime
updateTime
connectorCount
activatedBy
ownerEmail
createTime
createdBy
name
doc
status
activated_connectors {
...cn_connectorFragment
}
kafka_logical_cluster {
...kafka_logical_clusterFragment
}
ksql_logical_cluster {
...ksql_logical_clusterFragment
}
output_topics {
...kafka_topicFragment
}
activated_topics {
...kafka_topicFragment
}
activated_tables {
...ksql_tableFragment
}
input_topics {
...kafka_topicFragment
}
activated_streams {
...ksql_streamFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": pl_pipeline_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 123,
"order_by": [pl_pipeline_order],
"deleted": true
}
Response
{
"data": {
"pl_pipeline_count": [
{
"displayName": "abc123",
"description": "abc123",
"queryCount": 123,
"nameLower": "abc123",
"topicCount": 987,
"id": "xyz789",
"streamCount": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"owner": "abc123",
"updatedBy": "abc123",
"userDescription": "abc123",
"method": "UNSPECIFIED",
"qualifiedName": "xyz789",
"tableCount": 123,
"activateTime": "2007-12-03T10:15:30Z",
"updateTime": "2007-12-03T10:15:30Z",
"connectorCount": 123,
"activatedBy": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"createdBy": "abc123",
"name": "abc123",
"doc": "xyz789",
"status": "UNSPECIFIED",
"activated_connectors": [cn_connector],
"kafka_logical_cluster": kafka_logical_cluster,
"ksql_logical_cluster": ksql_logical_cluster,
"output_topics": [kafka_topic],
"activated_topics": [kafka_topic],
"activated_tables": [ksql_table],
"input_topics": [kafka_topic],
"activated_streams": [ksql_stream],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 987
}
]
}
}
sr_array
Description
Type representing an array datatype
Response
Returns [sr_array]
Arguments
| 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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
type {
...sr_typeFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_array_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 123,
"order_by": [sr_array_order],
"deleted": true
}
Response
{
"data": {
"sr_array": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "abc123",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"type": sr_type,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_array_count
Description
Type representing an array datatype
Response
Returns [sr_array_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
type {
...sr_typeFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_array_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 987,
"order_by": [sr_array_order],
"deleted": true
}
Response
{
"data": {
"sr_array_count": [
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"doc": "abc123",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"type": sr_type,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
sr_combined
Description
Type representing a combined datatype
Response
Returns [sr_combined]
Arguments
| 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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
types {
...sr_typeFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_combined_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 123,
"order_by": [sr_combined_order],
"deleted": true
}
Response
{
"data": {
"sr_combined": [
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"kind": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"doc": "abc123",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"types": [sr_type],
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
sr_combined_count
Description
Type representing a combined datatype
Response
Returns [sr_combined_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
types {
...sr_typeFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_combined_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [sr_combined_order],
"deleted": false
}
Response
{
"data": {
"sr_combined_count": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"kind": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"types": [sr_type],
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 123
}
]
}
}
sr_entity
Description
Type representing a Schema Registry entity
Response
Returns [sr_entity]
Arguments
| 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
ownerEmail
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_entity_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 987,
"order_by": [sr_entity_order],
"deleted": true
}
Response
{
"data": {
"sr_entity": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "xyz789",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_entity_count
Description
Type representing a Schema Registry entity
Response
Returns [sr_entity_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_entity_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 123,
"order_by": [sr_entity_order],
"deleted": true
}
Response
{
"data": {
"sr_entity_count": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"doc": "abc123",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
sr_enum
Description
Type representing an enum datatype
Response
Returns [sr_enum]
Arguments
| 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
ownerEmail
default
createTime
name
context
namespace
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_enum_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 123,
"order_by": [sr_enum_order],
"deleted": true
}
Response
{
"data": {
"sr_enum": [
{
"owner": "xyz789",
"aliases": ["xyz789"],
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"symbols": ["abc123"],
"ownerEmail": "xyz789",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"namespace": "xyz789",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
sr_enum_count
Description
Type representing an enum datatype
Response
Returns [sr_enum_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
createTime
name
context
namespace
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_enum_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 123,
"order_by": [sr_enum_order],
"deleted": false
}
Response
{
"data": {
"sr_enum_count": [
{
"owner": "xyz789",
"aliases": ["xyz789"],
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"symbols": ["abc123"],
"ownerEmail": "xyz789",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"namespace": "abc123",
"doc": "abc123",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 987
}
]
}
}
sr_field
Description
Type representing a field
Response
Returns [sr_field]
Arguments
| 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
ownerEmail
default
createTime
name
context
doc
id
tag
deprecatedTime
tenant
record {
...sr_recordFragment
}
type {
...sr_typeFragment
}
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_field_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 987,
"order_by": [sr_field_order],
"deleted": false
}
Response
{
"data": {
"sr_field": [
{
"owner": "xyz789",
"aliases": ["xyz789"],
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"label": "xyz789",
"ownerEmail": "abc123",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"doc": "xyz789",
"id": 123,
"tag": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"record": sr_record,
"type": sr_type,
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
sr_field_count
Description
Type representing a field
Response
Returns [sr_field_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
createTime
name
context
doc
id
tag
deprecatedTime
tenant
record {
...sr_recordFragment
}
type {
...sr_typeFragment
}
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_field_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 123,
"order_by": [sr_field_order],
"deleted": true
}
Response
{
"data": {
"sr_field_count": [
{
"owner": "xyz789",
"aliases": ["abc123"],
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"label": "abc123",
"ownerEmail": "xyz789",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"doc": "abc123",
"id": 987,
"tag": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"record": sr_record,
"type": sr_type,
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
sr_fixed
Description
Type representing a fixed datatype
Response
Returns [sr_fixed]
Arguments
| 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
ownerEmail
default
size
createTime
name
context
namespace
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_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": false
}
Response
{
"data": {
"sr_fixed": [
{
"owner": "xyz789",
"aliases": ["abc123"],
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"default": "abc123",
"size": 123,
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"namespace": "xyz789",
"doc": "xyz789",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_fixed_count
Description
Type representing a fixed datatype
Response
Returns [sr_fixed_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
size
createTime
name
context
namespace
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
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_count": [
{
"owner": "abc123",
"aliases": ["abc123"],
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"default": "abc123",
"size": 987,
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"namespace": "xyz789",
"doc": "abc123",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
sr_map
Description
Type representing a map datatype
Response
Returns [sr_map]
Arguments
| 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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
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
}
map_key {
...sr_mapFragment
}
combined {
...sr_combinedFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_map_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [sr_map_order],
"deleted": false
}
Response
{
"data": {
"sr_map": [
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "xyz789",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"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,
"map_key": sr_map,
"combined": sr_combined,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_map_count
Description
Type representing a map datatype
Response
Returns [sr_map_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
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
}
map_key {
...sr_mapFragment
}
combined {
...sr_combinedFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_map_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 987,
"order_by": [sr_map_order],
"deleted": false
}
Response
{
"data": {
"sr_map_count": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"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,
"map_key": sr_map,
"combined": sr_combined,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
sr_path
Description
An object path that can be tagged
Response
Returns [sr_path]
Arguments
| Name | Description |
|---|---|
where - sr_path_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_path_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_path(
$where: sr_path_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_path_order],
$deleted: Boolean
) {
sr_path(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_path_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 987,
"order_by": [sr_path_order],
"deleted": true
}
Response
{
"data": {
"sr_path": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_path_count
Description
An object path that can be tagged
Response
Returns [sr_path_count]
Arguments
| Name | Description |
|---|---|
where - sr_path_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_path_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_path_count(
$where: sr_path_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_path_order],
$deleted: Boolean
) {
sr_path_count(
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
ownerEmail
createTime
name
doc
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_path_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [sr_path_order],
"deleted": false
}
Response
{
"data": {
"sr_path_count": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 123
}
]
}
}
sr_primitive
Description
Type representing a primitive datatype
Response
Returns [sr_primitive]
Arguments
| 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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_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": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"type": "xyz789",
"ownerEmail": "abc123",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"doc": "abc123",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_primitive_count
Description
Type representing a primitive datatype
Response
Returns [sr_primitive_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_primitive_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 987,
"order_by": [sr_primitive_order],
"deleted": false
}
Response
{
"data": {
"sr_primitive_count": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"type": "xyz789",
"ownerEmail": "xyz789",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"doc": "xyz789",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
sr_record
Description
Type representing a record
Response
Returns [sr_record]
Arguments
| 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
ownerEmail
default
createTime
name
context
namespace
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
fields {
...sr_fieldFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_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": false
}
Response
{
"data": {
"sr_record": [
{
"owner": "abc123",
"aliases": ["xyz789"],
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"namespace": "abc123",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"fields": [sr_field],
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
sr_record_count
Description
Type representing a record
Response
Returns [sr_record_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
createTime
name
context
namespace
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
fields {
...sr_fieldFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_record_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 123,
"order_by": [sr_record_order],
"deleted": true
}
Response
{
"data": {
"sr_record_count": [
{
"owner": "abc123",
"aliases": ["abc123"],
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"namespace": "xyz789",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"fields": [sr_field],
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
sr_rule
Description
A schema rule
Response
Returns [sr_rule]
Arguments
| Name | Description |
|---|---|
where - sr_rule_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_rule_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_rule(
$where: sr_rule_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_rule_order],
$deleted: Boolean
) {
sr_rule(
where: $where,
business_metadata: $business_metadata,
tags: $tags,
limit: $limit,
offset: $offset,
order_by: $order_by,
deleted: $deleted
) {
owner
onError
userDescription
qualifiedName
displayName
kind
description
updateTime
nameLower
type
ownerEmail
mode
createTime
name
doc
expr
deprecatedTime
tenant
onSuccess
schema {
...sr_schemaFragment
}
parameters {
...sr_rule_parameterFragment
}
rule_tags {
...sr_rule_tagFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_rule_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 123,
"order_by": [sr_rule_order],
"deleted": true
}
Response
{
"data": {
"sr_rule": [
{
"owner": "xyz789",
"onError": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"kind": "UNSPECIFIED",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"type": "abc123",
"ownerEmail": "xyz789",
"mode": "UNSPECIFIED",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "xyz789",
"expr": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"onSuccess": "xyz789",
"schema": sr_schema,
"parameters": [sr_rule_parameter],
"rule_tags": [sr_rule_tag],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_rule_count
Description
A schema rule
Response
Returns [sr_rule_count]
Arguments
| Name | Description |
|---|---|
where - sr_rule_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_rule_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_rule_count(
$where: sr_rule_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_rule_order],
$deleted: Boolean
) {
sr_rule_count(
where: $where,
business_metadata: $business_metadata,
tags: $tags,
limit: $limit,
offset: $offset,
order_by: $order_by,
deleted: $deleted
) {
owner
onError
userDescription
qualifiedName
displayName
kind
description
updateTime
nameLower
type
ownerEmail
mode
createTime
name
doc
expr
deprecatedTime
tenant
onSuccess
schema {
...sr_schemaFragment
}
parameters {
...sr_rule_parameterFragment
}
rule_tags {
...sr_rule_tagFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_rule_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 123,
"order_by": [sr_rule_order],
"deleted": false
}
Response
{
"data": {
"sr_rule_count": [
{
"owner": "abc123",
"onError": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"kind": "UNSPECIFIED",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"type": "abc123",
"ownerEmail": "abc123",
"mode": "UNSPECIFIED",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "xyz789",
"expr": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"onSuccess": "abc123",
"schema": sr_schema,
"parameters": [sr_rule_parameter],
"rule_tags": [sr_rule_tag],
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
sr_rule_parameter
Description
Type representing a rule parameter
Response
Returns [sr_rule_parameter]
Arguments
| Name | Description |
|---|---|
where - sr_rule_parameter_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_rule_parameter_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_rule_parameter(
$where: sr_rule_parameter_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_rule_parameter_order],
$deleted: Boolean
) {
sr_rule_parameter(
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
ownerEmail
createTime
name
context
doc
id
deprecatedTime
value
tenant
rule {
...sr_ruleFragment
}
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_rule_parameter_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 987,
"order_by": [sr_rule_parameter_order],
"deleted": false
}
Response
{
"data": {
"sr_rule_parameter": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "abc123",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"value": "abc123",
"tenant": "xyz789",
"rule": sr_rule,
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
sr_rule_parameter_count
Description
Type representing a rule parameter
Response
Returns [sr_rule_parameter_count]
Arguments
| Name | Description |
|---|---|
where - sr_rule_parameter_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_rule_parameter_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_rule_parameter_count(
$where: sr_rule_parameter_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_rule_parameter_order],
$deleted: Boolean
) {
sr_rule_parameter_count(
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
ownerEmail
createTime
name
context
doc
id
deprecatedTime
value
tenant
rule {
...sr_ruleFragment
}
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_rule_parameter_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 123,
"order_by": [sr_rule_parameter_order],
"deleted": true
}
Response
{
"data": {
"sr_rule_parameter_count": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"value": "abc123",
"tenant": "xyz789",
"rule": sr_rule,
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
sr_rule_tag
Description
Type representing a rule tag
Response
Returns [sr_rule_tag]
Arguments
| Name | Description |
|---|---|
where - sr_rule_tag_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_rule_tag_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_rule_tag(
$where: sr_rule_tag_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_rule_tag_order],
$deleted: Boolean
) {
sr_rule_tag(
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
ownerEmail
createTime
name
context
doc
id
deprecatedTime
tenant
rule {
...sr_ruleFragment
}
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_rule_tag_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 123,
"offset": 987,
"order_by": [sr_rule_tag_order],
"deleted": true
}
Response
{
"data": {
"sr_rule_tag": [
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "xyz789",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"rule": sr_rule,
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
sr_rule_tag_count
Description
Type representing a rule tag
Response
Returns [sr_rule_tag_count]
Arguments
| Name | Description |
|---|---|
where - sr_rule_tag_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_rule_tag_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_rule_tag_count(
$where: sr_rule_tag_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_rule_tag_order],
$deleted: Boolean
) {
sr_rule_tag_count(
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
ownerEmail
createTime
name
context
doc
id
deprecatedTime
tenant
rule {
...sr_ruleFragment
}
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_rule_tag_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 987,
"order_by": [sr_rule_tag_order],
"deleted": false
}
Response
{
"data": {
"sr_rule_tag_count": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "abc123",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"rule": sr_rule,
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 987
}
]
}
}
sr_schema
Description
Type representing a schema namespace
Response
Returns [sr_schema]
Arguments
| 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
sensitive
ownerEmail
createTime
name
context
schemaType
namespace
doc
embeddedTags
id
deprecatedTime
tenant
types {
...sr_typeFragment
}
paths {
...sr_pathFragment
}
subject_versions {
...sr_subject_versionFragment
}
migration_rules {
...sr_ruleFragment
}
properties {
...sr_schema_propertyFragment
}
domain_rules {
...sr_ruleFragment
}
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_schema_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 123,
"order_by": [sr_schema_order],
"deleted": false
}
Response
{
"data": {
"sr_schema": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"sensitive": ["xyz789"],
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"schemaType": "xyz789",
"namespace": "xyz789",
"doc": "abc123",
"embeddedTags": ["abc123"],
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"types": [sr_type],
"paths": [sr_path],
"subject_versions": [sr_subject_version],
"migration_rules": [sr_rule],
"properties": [sr_schema_property],
"domain_rules": [sr_rule],
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
sr_schema_count
Description
Type representing a schema namespace
Response
Returns [sr_schema_count]
Arguments
| 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_count(
$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_count(
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
sensitive
ownerEmail
createTime
name
context
schemaType
namespace
doc
embeddedTags
id
deprecatedTime
tenant
types {
...sr_typeFragment
}
paths {
...sr_pathFragment
}
subject_versions {
...sr_subject_versionFragment
}
migration_rules {
...sr_ruleFragment
}
properties {
...sr_schema_propertyFragment
}
domain_rules {
...sr_ruleFragment
}
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_schema_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 123,
"order_by": [sr_schema_order],
"deleted": false
}
Response
{
"data": {
"sr_schema_count": [
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"sensitive": ["abc123"],
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"schemaType": "abc123",
"namespace": "abc123",
"doc": "xyz789",
"embeddedTags": ["xyz789"],
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"types": [sr_type],
"paths": [sr_path],
"subject_versions": [sr_subject_version],
"migration_rules": [sr_rule],
"properties": [sr_schema_property],
"domain_rules": [sr_rule],
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
sr_schema_property
Description
Type representing a schema property
Response
Returns [sr_schema_property]
Arguments
| Name | Description |
|---|---|
where - sr_schema_property_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_property_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_schema_property(
$where: sr_schema_property_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_schema_property_order],
$deleted: Boolean
) {
sr_schema_property(
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
ownerEmail
createTime
name
context
doc
id
deprecatedTime
value
tenant
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_schema_property_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 987,
"offset": 987,
"order_by": [sr_schema_property_order],
"deleted": true
}
Response
{
"data": {
"sr_schema_property": [
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"doc": "xyz789",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"value": "xyz789",
"tenant": "abc123",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_schema_property_count
Description
Type representing a schema property
Response
Returns [sr_schema_property_count]
Arguments
| Name | Description |
|---|---|
where - sr_schema_property_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_property_order]
|
Order by specification |
deleted - Boolean
|
Whether to include deleted entities |
Example
Query
query sr_schema_property_count(
$where: sr_schema_property_criteria,
$business_metadata: [business_metadata_input_attribute],
$tags: [String],
$limit: Int,
$offset: Int,
$order_by: [sr_schema_property_order],
$deleted: Boolean
) {
sr_schema_property_count(
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
ownerEmail
createTime
name
context
doc
id
deprecatedTime
value
tenant
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_schema_property_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 123,
"order_by": [sr_schema_property_order],
"deleted": false
}
Response
{
"data": {
"sr_schema_property_count": [
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "abc123",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"value": "xyz789",
"tenant": "xyz789",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"],
"entity_count": 123
}
]
}
}
sr_subject_version
Description
Type representing a subject-version
Response
Returns [sr_subject_version]
Arguments
| 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
ownerEmail
createTime
name
context
schemaType
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_subject_version_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 987,
"order_by": [sr_subject_version_order],
"deleted": true
}
Response
{
"data": {
"sr_subject_version": [
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"version": 987,
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"schemaType": "abc123",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["abc123"]
}
]
}
}
sr_subject_version_count
Description
Type representing a subject-version
Response
Returns [sr_subject_version_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
createTime
name
context
schemaType
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_subject_version_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["xyz789"],
"limit": 987,
"offset": 987,
"order_by": [sr_subject_version_order],
"deleted": false
}
Response
{
"data": {
"sr_subject_version_count": [
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"version": 123,
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"schemaType": "abc123",
"doc": "abc123",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 987
}
]
}
}
sr_type
Description
Type representing an abstract type
Response
Returns [sr_type]
Arguments
| 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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
}
}
Variables
{
"where": sr_type_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 123,
"order_by": [sr_type_order],
"deleted": false
}
Response
{
"data": {
"sr_type": [
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"doc": "abc123",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"]
}
]
}
}
sr_type_count
Description
Type representing an abstract type
Response
Returns [sr_type_count]
Arguments
| 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_count(
$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_count(
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
ownerEmail
default
createTime
name
context
doc
id
deprecatedTime
tenant
schema {
...sr_schemaFragment
}
field {
...sr_fieldFragment
}
array {
...sr_arrayFragment
}
map_value {
...sr_mapFragment
}
map_key {
...sr_mapFragment
}
child_types {
...sr_typeFragment
}
combined {
...sr_combinedFragment
}
parent_type {
...sr_typeFragment
}
tag_defs {
...tag_defFragment
}
entity_status
business_metadata {
...business_metadata_attributeFragment
}
tags
entity_count
}
}
Variables
{
"where": sr_type_criteria,
"business_metadata": [
business_metadata_input_attribute
],
"tags": ["abc123"],
"limit": 123,
"offset": 123,
"order_by": [sr_type_order],
"deleted": true
}
Response
{
"data": {
"sr_type_count": [
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"doc": "abc123",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"schema": sr_schema,
"field": sr_field,
"array": sr_array,
"map_value": sr_map,
"map_key": sr_map,
"child_types": [sr_type],
"combined": sr_combined,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [
business_metadata_attribute
],
"tags": ["xyz789"],
"entity_count": 123
}
]
}
}
Types
Boolean
Description
Built-in Boolean
Example
true
DateTime
Description
An RFC-3339 compliant DateTime Scalar
Example
"2007-12-03T10:15:30Z"
Float
Description
Built-in Float
Example
123.45
Int
Description
Built-in Int
Example
987
JsonPrimitive
Description
A JSON Primitive Scalar
Example
JsonPrimitive
Long
Description
A 64-bit signed integer
Example
{}
String
Description
Built-in String
Example
"abc123"
between_start_end
business_metadata_attribute
Description
Specifies a business metadata attribute
Fields
| Field Name | Description |
|---|---|
name - String
|
The business metadata attribute name |
value - JsonPrimitive
|
The business metadata attribute value |
Example
{
"name": "abc123",
"value": JsonPrimitive
}
business_metadata_input_attribute
Description
Specifies a business metadata input attribute
Fields
| 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": "xyz789"
}
cf_entity
Description
Type representing a Confluent entity
Fields
| 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 |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
doc - String
|
Documentation |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
tag_defs - [tag_def]
|
List of tag defs associated with the entity |
entity_status - entity_status_enum
|
Status of the entity |
business_metadata - [business_metadata_attribute]
|
Business metadata for the entity |
tags - [String]
|
Tags for the entity |
Possible Types
| cf_entity Types |
|---|
Example
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["abc123"]
}
cf_entity_count
Description
Type representing a Confluent entity
Fields
| 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 |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
doc - String
|
Documentation |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
tag_defs - [tag_def]
|
List of tag defs associated with the entity |
entity_status - entity_status_enum
|
Status of the entity |
business_metadata - [business_metadata_attribute]
|
Business metadata for the entity |
tags - [String]
|
Tags for the entity |
entity_count - Int
|
Example
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["abc123"],
"entity_count": 987
}
cf_entity_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity cf_entity
Fields
| 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": "2007-12-03T10:15:30Z",
"_lte": "2007-12-03T10:15:30Z",
"_gte": "2007-12-03T10:15:30Z",
"_gt": "2007-12-03T10:15:30Z",
"_lt": "2007-12-03T10:15:30Z",
"_between": between_start_end,
"_since": "last_7_days"
}
cf_entity_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | 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 |
ownerEmail - cf_entity_ownerEmail_criteria
|
|
createTime - cf_entity_createTime_criteria
|
The create time |
name - cf_entity_name_criteria
|
|
doc - cf_entity_doc_criteria
|
Documentation |
deprecatedTime - cf_entity_deprecatedTime_criteria
|
The time when the entity is deprecated |
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,
"ownerEmail": cf_entity_ownerEmail_criteria,
"createTime": cf_entity_createTime_criteria,
"name": cf_entity_name_criteria,
"doc": cf_entity_doc_criteria,
"deprecatedTime": cf_entity_deprecatedTime_criteria,
"tenant": cf_entity_tenant_criteria
}
cf_entity_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity cf_entity
Fields
| Input Field | Description |
|---|---|
_eq - DateTime
|
Equals criteria |