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 |
_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_description_criteria
Description
Criteria expression specification of description attribute in entity cf_entity
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_entity_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity cf_entity
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_entity_doc_criteria
Description
Criteria expression specification of doc attribute in entity cf_entity
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_entity_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity cf_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_entity_name_criteria
Description
Criteria expression specification of name attribute in entity cf_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_entity_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
cf_entity_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity cf_entity
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_entity_owner_criteria
Description
Criteria expression specification of owner attribute in entity cf_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
cf_entity_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity cf_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
cf_entity_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity cf_entity
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_entity_updateTime_criteria
Description
Criteria expression specification of updateTime 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_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity cf_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cf_environment
Description
Type representing an environment
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 |
id - String
|
The environment id |
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 |
Example
{
"owner": "abc123",
"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",
"id": "abc123",
"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
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 |
id - String
|
The environment id |
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": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"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": ["abc123"],
"entity_count": 123
}
cf_environment_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity cf_environment
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_environment_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [cf_environment_criteria]
|
Logical operation for expressions |
_and - [cf_environment_criteria]
|
Logical operation for expressions |
owner - cf_environment_owner_criteria
|
|
userDescription - cf_environment_userDescription_criteria
|
|
qualifiedName - cf_environment_qualifiedName_criteria
|
|
displayName - cf_environment_displayName_criteria
|
|
description - cf_environment_description_criteria
|
|
updateTime - cf_environment_updateTime_criteria
|
The update time |
nameLower - cf_environment_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - cf_environment_ownerEmail_criteria
|
|
createTime - cf_environment_createTime_criteria
|
The create time |
name - cf_environment_name_criteria
|
|
doc - cf_environment_doc_criteria
|
Documentation |
id - cf_environment_id_criteria
|
The environment id |
deprecatedTime - cf_environment_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - cf_environment_tenant_criteria
|
The tenant |
Example
{
"_or": [cf_environment_criteria],
"_and": [cf_environment_criteria],
"owner": cf_environment_owner_criteria,
"userDescription": cf_environment_userDescription_criteria,
"qualifiedName": cf_environment_qualifiedName_criteria,
"displayName": cf_environment_displayName_criteria,
"description": cf_environment_description_criteria,
"updateTime": cf_environment_updateTime_criteria,
"nameLower": cf_environment_nameLower_criteria,
"ownerEmail": cf_environment_ownerEmail_criteria,
"createTime": cf_environment_createTime_criteria,
"name": cf_environment_name_criteria,
"doc": cf_environment_doc_criteria,
"id": cf_environment_id_criteria,
"deprecatedTime": cf_environment_deprecatedTime_criteria,
"tenant": cf_environment_tenant_criteria
}
cf_environment_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity cf_environment
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_environment_description_criteria
Description
Criteria expression specification of description attribute in entity cf_environment
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
cf_environment_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity cf_environment
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_environment_doc_criteria
Description
Criteria expression specification of doc attribute in entity cf_environment
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cf_environment_id_criteria
Description
Criteria expression specification of id attribute in entity cf_environment
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_environment_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity cf_environment
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
cf_environment_name_criteria
Description
Criteria expression specification of name attribute in entity cf_environment
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cf_environment_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The environment id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
cf_environment_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity cf_environment
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_environment_owner_criteria
Description
Criteria expression specification of owner attribute in entity cf_environment
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_environment_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity cf_environment
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_environment_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity cf_environment
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_environment_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity cf_environment
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_environment_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity cf_environment
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_tenant
Description
Type representing a Confluent tenant
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 |
Example
{
"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": "xyz789",
"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
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": "abc123",
"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": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["abc123"],
"entity_count": 123
}
cf_tenant_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity cf_tenant
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_tenant_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [cf_tenant_criteria]
|
Logical operation for expressions |
_and - [cf_tenant_criteria]
|
Logical operation for expressions |
owner - cf_tenant_owner_criteria
|
|
userDescription - cf_tenant_userDescription_criteria
|
|
qualifiedName - cf_tenant_qualifiedName_criteria
|
|
displayName - cf_tenant_displayName_criteria
|
|
description - cf_tenant_description_criteria
|
|
updateTime - cf_tenant_updateTime_criteria
|
The update time |
nameLower - cf_tenant_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - cf_tenant_ownerEmail_criteria
|
|
createTime - cf_tenant_createTime_criteria
|
The create time |
name - cf_tenant_name_criteria
|
|
doc - cf_tenant_doc_criteria
|
Documentation |
deprecatedTime - cf_tenant_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - cf_tenant_tenant_criteria
|
The tenant |
Example
{
"_or": [cf_tenant_criteria],
"_and": [cf_tenant_criteria],
"owner": cf_tenant_owner_criteria,
"userDescription": cf_tenant_userDescription_criteria,
"qualifiedName": cf_tenant_qualifiedName_criteria,
"displayName": cf_tenant_displayName_criteria,
"description": cf_tenant_description_criteria,
"updateTime": cf_tenant_updateTime_criteria,
"nameLower": cf_tenant_nameLower_criteria,
"ownerEmail": cf_tenant_ownerEmail_criteria,
"createTime": cf_tenant_createTime_criteria,
"name": cf_tenant_name_criteria,
"doc": cf_tenant_doc_criteria,
"deprecatedTime": cf_tenant_deprecatedTime_criteria,
"tenant": cf_tenant_tenant_criteria
}
cf_tenant_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity cf_tenant
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_tenant_description_criteria
Description
Criteria expression specification of description attribute in entity cf_tenant
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_tenant_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity cf_tenant
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cf_tenant_doc_criteria
Description
Criteria expression specification of doc attribute in entity cf_tenant
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_tenant_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity cf_tenant
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cf_tenant_name_criteria
Description
Criteria expression specification of name attribute in entity cf_tenant
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cf_tenant_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
cf_tenant_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity cf_tenant
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cf_tenant_owner_criteria
Description
Criteria expression specification of owner attribute in entity cf_tenant
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cf_tenant_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity cf_tenant
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
cf_tenant_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity cf_tenant
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cf_tenant_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity cf_tenant
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_tenant_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity cf_tenant
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector
Description
Type representing a connector
Fields
| Field Name | Description |
|---|---|
displayName - String
|
|
description - String
|
|
nameLower - String
|
Lowercase representation of the name |
clusterId - String
|
The logical connect cluster id |
type - connector_type
|
The connector type, SOURCE or SINK |
sourceEndpoint - String
|
The endpoint for the source |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
class - String
|
The Java class for the connector |
outputFormat - String
|
The output format for the connector |
tenant - String
|
The tenant |
owner - String
|
|
userDescription - String
|
|
kafkaApiKey - String
|
The API key for Kafka cluster, if using API key auth mode |
qualifiedName - String
|
|
updateTime - DateTime
|
The update time |
kafkaServiceAccountId - String
|
The service account id for Kafka cluster, if using service account auth mode |
inputFormat - String
|
The input format for the connector |
sourceSchema - String
|
The schema for the source |
tasksMax - Int
|
The maximum number of tasks for the connector |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
dlqTopic - String
|
The name for the dead letter queue topic |
doc - String
|
Documentation |
kafkaAuthMode - kafka_auth_mode
|
The authentication mode for Kafka cluster |
status - connector_status
|
The connector status |
topics - [kafka_topic]
|
The topics |
Arguments
|
|
activated_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
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 |
Example
{
"displayName": "abc123",
"description": "xyz789",
"nameLower": "xyz789",
"clusterId": "abc123",
"type": "SOURCE",
"sourceEndpoint": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"class": "xyz789",
"outputFormat": "abc123",
"tenant": "abc123",
"owner": "abc123",
"userDescription": "abc123",
"kafkaApiKey": "xyz789",
"qualifiedName": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"kafkaServiceAccountId": "abc123",
"inputFormat": "abc123",
"sourceSchema": "xyz789",
"tasksMax": 987,
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"dlqTopic": "abc123",
"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_class_criteria
Description
Criteria expression specification of class attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_clusterId_criteria
Description
Criteria expression specification of clusterId attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_count
Description
Type representing a connector
Fields
| Field Name | Description |
|---|---|
displayName - String
|
|
description - String
|
|
nameLower - String
|
Lowercase representation of the name |
clusterId - String
|
The logical connect cluster id |
type - connector_type
|
The connector type, SOURCE or SINK |
sourceEndpoint - String
|
The endpoint for the source |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
class - String
|
The Java class for the connector |
outputFormat - String
|
The output format for the connector |
tenant - String
|
The tenant |
owner - String
|
|
userDescription - String
|
|
kafkaApiKey - String
|
The API key for Kafka cluster, if using API key auth mode |
qualifiedName - String
|
|
updateTime - DateTime
|
The update time |
kafkaServiceAccountId - String
|
The service account id for Kafka cluster, if using service account auth mode |
inputFormat - String
|
The input format for the connector |
sourceSchema - String
|
The schema for the source |
tasksMax - Int
|
The maximum number of tasks for the connector |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
dlqTopic - String
|
The name for the dead letter queue topic |
doc - String
|
Documentation |
kafkaAuthMode - kafka_auth_mode
|
The authentication mode for Kafka cluster |
status - connector_status
|
The connector status |
topics - [kafka_topic]
|
The topics |
Arguments
|
|
activated_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
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
{
"displayName": "xyz789",
"description": "xyz789",
"nameLower": "xyz789",
"clusterId": "xyz789",
"type": "SOURCE",
"sourceEndpoint": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"class": "abc123",
"outputFormat": "abc123",
"tenant": "xyz789",
"owner": "xyz789",
"userDescription": "xyz789",
"kafkaApiKey": "xyz789",
"qualifiedName": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"kafkaServiceAccountId": "abc123",
"inputFormat": "abc123",
"sourceSchema": "abc123",
"tasksMax": 123,
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"dlqTopic": "abc123",
"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": ["xyz789"],
"entity_count": 123
}
cn_connector_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity cn_connector
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"
}
cn_connector_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [cn_connector_criteria]
|
Logical operation for expressions |
_and - [cn_connector_criteria]
|
Logical operation for expressions |
displayName - cn_connector_displayName_criteria
|
|
description - cn_connector_description_criteria
|
|
nameLower - cn_connector_nameLower_criteria
|
Lowercase representation of the name |
clusterId - cn_connector_clusterId_criteria
|
The logical connect cluster id |
type - cn_connector_type_criteria
|
The connector type, SOURCE or SINK |
sourceEndpoint - cn_connector_sourceEndpoint_criteria
|
The endpoint for the source |
deprecatedTime - cn_connector_deprecatedTime_criteria
|
The time when the entity is deprecated |
class - cn_connector_class_criteria
|
The Java class for the connector |
outputFormat - cn_connector_outputFormat_criteria
|
The output format for the connector |
tenant - cn_connector_tenant_criteria
|
The tenant |
owner - cn_connector_owner_criteria
|
|
userDescription - cn_connector_userDescription_criteria
|
|
kafkaApiKey - cn_connector_kafkaApiKey_criteria
|
The API key for Kafka cluster, if using API key auth mode |
qualifiedName - cn_connector_qualifiedName_criteria
|
|
updateTime - cn_connector_updateTime_criteria
|
The update time |
kafkaServiceAccountId - cn_connector_kafkaServiceAccountId_criteria
|
The service account id for Kafka cluster, if using service account auth mode |
inputFormat - cn_connector_inputFormat_criteria
|
The input format for the connector |
sourceSchema - cn_connector_sourceSchema_criteria
|
The schema for the source |
tasksMax - cn_connector_tasksMax_criteria
|
The maximum number of tasks for the connector |
ownerEmail - cn_connector_ownerEmail_criteria
|
|
createTime - cn_connector_createTime_criteria
|
The create time |
name - cn_connector_name_criteria
|
|
dlqTopic - cn_connector_dlqTopic_criteria
|
The name for the dead letter queue topic |
doc - cn_connector_doc_criteria
|
Documentation |
kafkaAuthMode - cn_connector_kafkaAuthMode_criteria
|
The authentication mode for Kafka cluster |
status - cn_connector_status_criteria
|
The connector status |
Example
{
"_or": [cn_connector_criteria],
"_and": [cn_connector_criteria],
"displayName": cn_connector_displayName_criteria,
"description": cn_connector_description_criteria,
"nameLower": cn_connector_nameLower_criteria,
"clusterId": cn_connector_clusterId_criteria,
"type": cn_connector_type_criteria,
"sourceEndpoint": cn_connector_sourceEndpoint_criteria,
"deprecatedTime": cn_connector_deprecatedTime_criteria,
"class": cn_connector_class_criteria,
"outputFormat": cn_connector_outputFormat_criteria,
"tenant": cn_connector_tenant_criteria,
"owner": cn_connector_owner_criteria,
"userDescription": cn_connector_userDescription_criteria,
"kafkaApiKey": cn_connector_kafkaApiKey_criteria,
"qualifiedName": cn_connector_qualifiedName_criteria,
"updateTime": cn_connector_updateTime_criteria,
"kafkaServiceAccountId": cn_connector_kafkaServiceAccountId_criteria,
"inputFormat": cn_connector_inputFormat_criteria,
"sourceSchema": cn_connector_sourceSchema_criteria,
"tasksMax": cn_connector_tasksMax_criteria,
"ownerEmail": cn_connector_ownerEmail_criteria,
"createTime": cn_connector_createTime_criteria,
"name": cn_connector_name_criteria,
"dlqTopic": cn_connector_dlqTopic_criteria,
"doc": cn_connector_doc_criteria,
"kafkaAuthMode": cn_connector_kafkaAuthMode_criteria,
"status": cn_connector_status_criteria
}
cn_connector_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity cn_connector
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"
}
cn_connector_description_criteria
Description
Criteria expression specification of description attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_dlqTopic_criteria
Description
Criteria expression specification of dlqTopic attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cn_connector_doc_criteria
Description
Criteria expression specification of doc attribute in entity cn_connector
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cn_connector_inputFormat_criteria
Description
Criteria expression specification of inputFormat attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_kafkaApiKey_criteria
Description
Criteria expression specification of kafkaApiKey attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_kafkaAuthMode_criteria
Description
Criteria expression specification of kafkaAuthMode attribute in entity cn_connector
Fields
| Input Field | Description |
|---|---|
_eq - kafka_auth_mode
|
Equals criteria |
_lte - kafka_auth_mode
|
Less than or equals criteria |
_gte - kafka_auth_mode
|
Greater or equals criteria |
_gt - kafka_auth_mode
|
Greater than criteria |
_lt - kafka_auth_mode
|
Less than criteria |
_starts_with - kafka_auth_mode
|
Starts with criteria |
Example
{
"_eq": "KAFKA_API_KEY",
"_lte": "KAFKA_API_KEY",
"_gte": "KAFKA_API_KEY",
"_gt": "KAFKA_API_KEY",
"_lt": "KAFKA_API_KEY",
"_starts_with": "KAFKA_API_KEY"
}
cn_connector_kafkaServiceAccountId_criteria
Description
Criteria expression specification of kafkaServiceAccountId attribute in entity cn_connector
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
cn_connector_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_name_criteria
Description
Criteria expression specification of name attribute in entity cn_connector
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
replicatedFrom - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
nameLower - order_by_enum
|
Lowercase representation of the name |
clusterId - order_by_enum
|
The logical connect cluster id |
type - order_by_enum
|
The connector type, SOURCE or SINK |
sourceEndpoint - order_by_enum
|
The endpoint for the source |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
class - order_by_enum
|
The Java class for the connector |
outputFormat - order_by_enum
|
The output format for the connector |
tenant - order_by_enum
|
The tenant |
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
kafkaApiKey - order_by_enum
|
The API key for Kafka cluster, if using API key auth mode |
qualifiedName - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
kafkaServiceAccountId - order_by_enum
|
The service account id for Kafka cluster, if using service account auth mode |
inputFormat - order_by_enum
|
The input format for the connector |
sourceSchema - order_by_enum
|
The schema for the source |
tasksMax - order_by_enum
|
The maximum number of tasks for the connector |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
dlqTopic - order_by_enum
|
The name for the dead letter queue topic |
doc - order_by_enum
|
Documentation |
kafkaAuthMode - order_by_enum
|
The authentication mode for Kafka cluster |
status - order_by_enum
|
The connector status |
Example
{
"replicatedFrom": "asc",
"displayName": "asc",
"description": "asc",
"nameLower": "asc",
"clusterId": "asc",
"type": "asc",
"sourceEndpoint": "asc",
"deprecatedTime": "asc",
"class": "asc",
"outputFormat": "asc",
"tenant": "asc",
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"kafkaApiKey": "asc",
"qualifiedName": "asc",
"updateTime": "asc",
"kafkaServiceAccountId": "asc",
"inputFormat": "asc",
"sourceSchema": "asc",
"tasksMax": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"dlqTopic": "asc",
"doc": "asc",
"kafkaAuthMode": "asc",
"status": "asc"
}
cn_connector_outputFormat_criteria
Description
Criteria expression specification of outputFormat attribute in entity cn_connector
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
cn_connector_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
cn_connector_owner_criteria
Description
Criteria expression specification of owner attribute in entity cn_connector
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
cn_connector_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity cn_connector
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
cn_connector_sourceEndpoint_criteria
Description
Criteria expression specification of sourceEndpoint attribute in entity cn_connector
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
cn_connector_sourceSchema_criteria
Description
Criteria expression specification of sourceSchema attribute in entity cn_connector
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cn_connector_status_criteria
Description
Criteria expression specification of status attribute in entity cn_connector
Fields
| Input Field | Description |
|---|---|
_eq - connector_status
|
Equals criteria |
_lte - connector_status
|
Less than or equals criteria |
_gte - connector_status
|
Greater or equals criteria |
_gt - connector_status
|
Greater than criteria |
_lt - connector_status
|
Less than criteria |
_starts_with - connector_status
|
Starts with criteria |
Example
{
"_eq": "NONE",
"_lte": "NONE",
"_gte": "NONE",
"_gt": "NONE",
"_lt": "NONE",
"_starts_with": "NONE"
}
cn_connector_tasksMax_criteria
Description
Criteria expression specification of tasksMax attribute in entity cn_connector
Example
{"_eq": 987, "_lte": 987, "_gte": 987, "_gt": 987, "_lt": 987}
cn_connector_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
cn_connector_type_criteria
Description
Criteria expression specification of type attribute in entity cn_connector
Fields
| Input Field | Description |
|---|---|
_eq - connector_type
|
Equals criteria |
_lte - connector_type
|
Less than or equals criteria |
_gte - connector_type
|
Greater or equals criteria |
_gt - connector_type
|
Greater than criteria |
_lt - connector_type
|
Less than criteria |
_starts_with - connector_type
|
Starts with criteria |
Example
{
"_eq": "SOURCE",
"_lte": "SOURCE",
"_gte": "SOURCE",
"_gt": "SOURCE",
"_lt": "SOURCE",
"_starts_with": "SOURCE"
}
cn_connector_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity cn_connector
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"
}
cn_connector_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity cn_connector
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
connector_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
connector_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SOURCE"
entity_status_enum
Description
Specifies the status (active/deleted) for an entity
Values
| Enum Value | Description |
|---|---|
|
|
Active |
|
|
Deleted |
Example
"active"
kafka_auth_mode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"KAFKA_API_KEY"
kafka_cleanup_policy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
kafka_cluster_link
Description
Type representing a cluster link
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
|
|
externalSourceCluster - String
|
The id of source kafka cluster, used when source cluster and destination cluster are not in the same environment |
connectionMode - String
|
The cluster link connection mode |
createTime - DateTime
|
The create time |
linkMode - String
|
The cluster link mode |
name - String
|
|
doc - String
|
Documentation |
id - String
|
The cluster link id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
destination_cluster - kafka_logical_cluster
|
|
Arguments
|
|
mirror_topics - [kafka_topic]
|
|
Arguments
|
|
source_cluster - kafka_logical_cluster
|
|
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"externalSourceCluster": "abc123",
"connectionMode": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"linkMode": "abc123",
"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_connectionMode_criteria
Description
Criteria expression specification of connectionMode attribute in entity kafka_cluster_link
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_cluster_link_count
Description
Type representing a cluster link
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
|
|
externalSourceCluster - String
|
The id of source kafka cluster, used when source cluster and destination cluster are not in the same environment |
connectionMode - String
|
The cluster link connection mode |
createTime - DateTime
|
The create time |
linkMode - String
|
The cluster link mode |
name - String
|
|
doc - String
|
Documentation |
id - String
|
The cluster link id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
destination_cluster - kafka_logical_cluster
|
|
Arguments
|
|
mirror_topics - [kafka_topic]
|
|
Arguments
|
|
source_cluster - kafka_logical_cluster
|
|
Arguments
|
|
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": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"externalSourceCluster": "xyz789",
"connectionMode": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"linkMode": "xyz789",
"name": "xyz789",
"doc": "abc123",
"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_cluster_link_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity kafka_cluster_link
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"
}
kafka_cluster_link_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
Example
{
"_or": [kafka_cluster_link_criteria],
"_and": [kafka_cluster_link_criteria],
"owner": kafka_cluster_link_owner_criteria,
"userDescription": kafka_cluster_link_userDescription_criteria,
"qualifiedName": kafka_cluster_link_qualifiedName_criteria,
"displayName": kafka_cluster_link_displayName_criteria,
"description": kafka_cluster_link_description_criteria,
"updateTime": kafka_cluster_link_updateTime_criteria,
"nameLower": kafka_cluster_link_nameLower_criteria,
"ownerEmail": kafka_cluster_link_ownerEmail_criteria,
"externalSourceCluster": kafka_cluster_link_externalSourceCluster_criteria,
"connectionMode": kafka_cluster_link_connectionMode_criteria,
"createTime": kafka_cluster_link_createTime_criteria,
"linkMode": kafka_cluster_link_linkMode_criteria,
"name": kafka_cluster_link_name_criteria,
"doc": kafka_cluster_link_doc_criteria,
"id": kafka_cluster_link_id_criteria,
"deprecatedTime": kafka_cluster_link_deprecatedTime_criteria,
"tenant": kafka_cluster_link_tenant_criteria
}
kafka_cluster_link_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity kafka_cluster_link
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"
}
kafka_cluster_link_description_criteria
Description
Criteria expression specification of description attribute in entity kafka_cluster_link
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_cluster_link_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity kafka_cluster_link
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_cluster_link_doc_criteria
Description
Criteria expression specification of doc attribute in entity kafka_cluster_link
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_cluster_link_externalSourceCluster_criteria
Description
Criteria expression specification of externalSourceCluster attribute in entity kafka_cluster_link
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_cluster_link_id_criteria
Description
Criteria expression specification of id attribute in entity kafka_cluster_link
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_cluster_link_linkMode_criteria
Description
Criteria expression specification of linkMode attribute in entity kafka_cluster_link
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_cluster_link_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity kafka_cluster_link
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_cluster_link_name_criteria
Description
Criteria expression specification of name attribute in entity kafka_cluster_link
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_cluster_link_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
externalSourceCluster - order_by_enum
|
The id of source kafka cluster, used when source cluster and destination cluster are not in the same environment |
connectionMode - order_by_enum
|
The cluster link connection mode |
createTime - order_by_enum
|
The create time |
linkMode - order_by_enum
|
The cluster link mode |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The cluster link id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"externalSourceCluster": "asc",
"connectionMode": "asc",
"createTime": "asc",
"linkMode": "asc",
"name": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
kafka_cluster_link_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity kafka_cluster_link
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_cluster_link_owner_criteria
Description
Criteria expression specification of owner attribute in entity kafka_cluster_link
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_cluster_link_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity kafka_cluster_link
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_cluster_link_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity kafka_cluster_link
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_cluster_link_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity kafka_cluster_link
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"
}
kafka_cluster_link_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity kafka_cluster_link
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_cluster_tier
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNDEFINED"
kafka_compression_type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNSPECIFIED"
kafka_logical_cluster
Description
Type representing a logical Kafka cluster
Fields
| Field Name | Description |
|---|---|
displayName - String
|
|
description - String
|
|
nameLower - String
|
Lowercase representation of the name |
availability - String
|
The availability |
type - String
|
The logical cluster type |
cku - Int
|
The number of CKUs |
network - String
|
The network type |
provider - String
|
The cloud provider |
id - String
|
The logical cluster id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
sku - kafka_cluster_tier
|
The cluster tier |
tenant - String
|
The tenant |
owner - String
|
|
userDescription - String
|
|
qualifiedName - String
|
|
updateTime - DateTime
|
The update time |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
doc - String
|
Documentation |
region - String
|
The region |
status - String
|
The logical cluster status |
deactivateTime - DateTime
|
The deactivated time |
destination_links - [kafka_cluster_link]
|
|
Arguments
|
|
pipelines - [pl_pipeline]
|
|
Arguments
|
|
topics - [kafka_topic]
|
|
Arguments
|
|
source_links - [kafka_cluster_link]
|
|
Arguments
|
|
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 |
Example
{
"displayName": "abc123",
"description": "abc123",
"nameLower": "abc123",
"availability": "xyz789",
"type": "xyz789",
"cku": 123,
"network": "xyz789",
"provider": "xyz789",
"id": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"sku": "UNDEFINED",
"tenant": "xyz789",
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "xyz789",
"region": "xyz789",
"status": "abc123",
"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"]
}
kafka_logical_cluster_availability_criteria
Description
Criteria expression specification of availability attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_logical_cluster_cku_criteria
Description
Criteria expression specification of cku attribute in entity kafka_logical_cluster
Example
{"_eq": 123, "_lte": 123, "_gte": 987, "_gt": 123, "_lt": 123}
kafka_logical_cluster_count
Description
Type representing a logical Kafka cluster
Fields
| Field Name | Description |
|---|---|
displayName - String
|
|
description - String
|
|
nameLower - String
|
Lowercase representation of the name |
availability - String
|
The availability |
type - String
|
The logical cluster type |
cku - Int
|
The number of CKUs |
network - String
|
The network type |
provider - String
|
The cloud provider |
id - String
|
The logical cluster id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
sku - kafka_cluster_tier
|
The cluster tier |
tenant - String
|
The tenant |
owner - String
|
|
userDescription - String
|
|
qualifiedName - String
|
|
updateTime - DateTime
|
The update time |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
doc - String
|
Documentation |
region - String
|
The region |
status - String
|
The logical cluster status |
deactivateTime - DateTime
|
The deactivated time |
destination_links - [kafka_cluster_link]
|
|
Arguments
|
|
pipelines - [pl_pipeline]
|
|
Arguments
|
|
topics - [kafka_topic]
|
|
Arguments
|
|
source_links - [kafka_cluster_link]
|
|
Arguments
|
|
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
{
"displayName": "xyz789",
"description": "xyz789",
"nameLower": "abc123",
"availability": "xyz789",
"type": "xyz789",
"cku": 123,
"network": "xyz789",
"provider": "abc123",
"id": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"sku": "UNDEFINED",
"tenant": "xyz789",
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "xyz789",
"region": "xyz789",
"status": "abc123",
"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"],
"entity_count": 987
}
kafka_logical_cluster_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity kafka_logical_cluster
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"
}
kafka_logical_cluster_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
Example
{
"_or": [kafka_logical_cluster_criteria],
"_and": [kafka_logical_cluster_criteria],
"displayName": kafka_logical_cluster_displayName_criteria,
"description": kafka_logical_cluster_description_criteria,
"nameLower": kafka_logical_cluster_nameLower_criteria,
"availability": kafka_logical_cluster_availability_criteria,
"type": kafka_logical_cluster_type_criteria,
"cku": kafka_logical_cluster_cku_criteria,
"network": kafka_logical_cluster_network_criteria,
"provider": kafka_logical_cluster_provider_criteria,
"id": kafka_logical_cluster_id_criteria,
"deprecatedTime": kafka_logical_cluster_deprecatedTime_criteria,
"sku": kafka_logical_cluster_sku_criteria,
"tenant": kafka_logical_cluster_tenant_criteria,
"owner": kafka_logical_cluster_owner_criteria,
"userDescription": kafka_logical_cluster_userDescription_criteria,
"qualifiedName": kafka_logical_cluster_qualifiedName_criteria,
"updateTime": kafka_logical_cluster_updateTime_criteria,
"ownerEmail": kafka_logical_cluster_ownerEmail_criteria,
"createTime": kafka_logical_cluster_createTime_criteria,
"name": kafka_logical_cluster_name_criteria,
"doc": kafka_logical_cluster_doc_criteria,
"region": kafka_logical_cluster_region_criteria,
"status": kafka_logical_cluster_status_criteria,
"deactivateTime": kafka_logical_cluster_deactivateTime_criteria
}
kafka_logical_cluster_deactivateTime_criteria
Description
Criteria expression specification of deactivateTime attribute in entity kafka_logical_cluster
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"
}
kafka_logical_cluster_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity kafka_logical_cluster
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"
}
kafka_logical_cluster_description_criteria
Description
Criteria expression specification of description attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_logical_cluster_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_logical_cluster_doc_criteria
Description
Criteria expression specification of doc attribute in entity kafka_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_logical_cluster_id_criteria
Description
Criteria expression specification of id attribute in entity kafka_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_logical_cluster_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_logical_cluster_name_criteria
Description
Criteria expression specification of name attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_logical_cluster_network_criteria
Description
Criteria expression specification of network attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_logical_cluster_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
replicatedFrom - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
nameLower - order_by_enum
|
Lowercase representation of the name |
availability - order_by_enum
|
The availability |
type - order_by_enum
|
The logical cluster type |
cku - order_by_enum
|
The number of CKUs |
network - order_by_enum
|
The network type |
provider - order_by_enum
|
The cloud provider |
id - order_by_enum
|
The logical cluster id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
sku - order_by_enum
|
The cluster tier |
tenant - order_by_enum
|
The tenant |
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
region - order_by_enum
|
The region |
status - order_by_enum
|
The logical cluster status |
deactivateTime - order_by_enum
|
The deactivated time |
Example
{
"replicatedFrom": "asc",
"displayName": "asc",
"description": "asc",
"nameLower": "asc",
"availability": "asc",
"type": "asc",
"cku": "asc",
"network": "asc",
"provider": "asc",
"id": "asc",
"deprecatedTime": "asc",
"sku": "asc",
"tenant": "asc",
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"qualifiedName": "asc",
"updateTime": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"region": "asc",
"status": "asc",
"deactivateTime": "asc"
}
kafka_logical_cluster_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity kafka_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_logical_cluster_owner_criteria
Description
Criteria expression specification of owner attribute in entity kafka_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_logical_cluster_provider_criteria
Description
Criteria expression specification of provider attribute in entity kafka_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_logical_cluster_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity kafka_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_logical_cluster_region_criteria
Description
Criteria expression specification of region attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_logical_cluster_sku_criteria
Description
Criteria expression specification of sku attribute in entity kafka_logical_cluster
Fields
| Input Field | Description |
|---|---|
_eq - kafka_cluster_tier
|
Equals criteria |
_lte - kafka_cluster_tier
|
Less than or equals criteria |
_gte - kafka_cluster_tier
|
Greater or equals criteria |
_gt - kafka_cluster_tier
|
Greater than criteria |
_lt - kafka_cluster_tier
|
Less than criteria |
_starts_with - kafka_cluster_tier
|
Starts with criteria |
Example
{
"_eq": "UNDEFINED",
"_lte": "UNDEFINED",
"_gte": "UNDEFINED",
"_gt": "UNDEFINED",
"_lt": "UNDEFINED",
"_starts_with": "UNDEFINED"
}
kafka_logical_cluster_status_criteria
Description
Criteria expression specification of status attribute in entity kafka_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_logical_cluster_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_logical_cluster_type_criteria
Description
Criteria expression specification of type attribute in entity kafka_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_logical_cluster_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity kafka_logical_cluster
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"
}
kafka_logical_cluster_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity kafka_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_topic
Description
Type representing a Kafka topic
Fields
| Field Name | Description |
|---|---|
replicationFactor - Int
|
The replication factor |
maxCompactionLagMs - Long
|
The maximum time in ms a message will remain ineligible for compaction in the log |
compressionType - kafka_compression_type
|
The compression type |
messageDownconversionEnable - Boolean
|
Whether down-conversion of message formats is enabled |
minCleanableDirtyRatio - Float
|
The ratio of the log compactor will attempt to clean the log |
uncleanLeaderElectionEnable - Boolean
|
Whether to enable replicas not in the ISR set to be elected as leader |
minInsyncReplicas - Int
|
The minimum number of replicas that must acknowledge a write for the write to be considered successful |
retentionBytes - Long
|
The retention bytes |
followerReplicationThrottledReplicas - [String]
|
A list of replicas for which log replication should be throttled on the follower side |
id - String
|
The topic id |
tenant - String
|
The tenant |
externalSourceTopicName - String
|
Used for cluster links when source cluster and destination cluster are not in the same environment |
fileDeleteDelayMs - Long
|
The time in ms to wait before deleting a file from the filesystem |
qualifiedName - String
|
|
leaderReplicationThrottledReplicas - [String]
|
A list of replicas for which log replication should be throttled on the leader side |
messageTimestampType - String
|
The message timestamp type |
preallocate - Boolean
|
Whether to preallocate the file on disk when creating a new log segment |
isInternal - Boolean
|
Whether the topic is internal |
segmentBytes - Int
|
The segment file size for the log |
segmentIndexBytes - Int
|
The size of the index that maps offsets to file positions |
flushMessages - Long
|
The interval at which Kafka force an fsync of data written to the log |
name - String
|
|
doc - String
|
Documentation |
messageFormatVersion - String
|
The message format version the broker will use to append messages to the logs |
indexIntervalBytes - Int
|
The bytes interval for Kafka adds an index entry to its offset index |
minCompactionLagMs - Long
|
The minimum time in ms a message will remain uncompacted in the log |
segmentMs - Long
|
The period of time in ms after which Kafka will force the log to roll |
mirrorTopicState - String
|
Not null when current entity is a mirror topic. This Attribute represents the mirror topic state |
segmentJitterMs - Long
|
The maximum random jitter subtracted from the scheduled segment roll time |
maxMessageBytes - Int
|
The largest record batch size allowed by Kafka |
displayName - String
|
|
description - String
|
|
nameLower - String
|
Lowercase representation of the name |
valueSchemaValidation - Boolean
|
Whether value schema validation is enabled |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
externalSourceTopicId - String
|
Used for cluster links when source cluster and destination cluster are not in the same environment |
owner - String
|
|
retentionMs - Long
|
The retention time in ms |
userDescription - String
|
|
deleteRetentionMs - Long
|
The amount of time in ms to retain delete tombstone markers for log compacted topics |
flushMs - Long
|
The time interval in ms at which Kafka force an fsync of data written to the log |
updateTime - DateTime
|
The update time |
mirrorTopicUpdateTime - String
|
Not null when current entity is a mirror topic. This Attribute represents the mirror topic state update time |
ownerEmail - String
|
|
partitionsCount - Int
|
The number of partitions |
messageTimestampDifferenceMaxMs - Long
|
The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message |
createTime - DateTime
|
The create time |
keySchemaValidation - Boolean
|
Whether key schema validation is enabled |
cleanupPolicy - kafka_cleanup_policy
|
The cleanup policy |
connectors - [cn_connector]
|
The connectors |
Arguments
|
|
mirror_topics - [kafka_topic]
|
|
Arguments
|
|
source_topic - kafka_topic
|
|
Arguments
|
|
logical_cluster - kafka_logical_cluster
|
|
Arguments
|
|
input_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
output_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
activated_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
cluster_link - kafka_cluster_link
|
|
Arguments
|
|
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 |
Example
{
"replicationFactor": 123,
"maxCompactionLagMs": {},
"compressionType": "UNSPECIFIED",
"messageDownconversionEnable": true,
"minCleanableDirtyRatio": 123.45,
"uncleanLeaderElectionEnable": true,
"minInsyncReplicas": 987,
"retentionBytes": {},
"followerReplicationThrottledReplicas": [
"abc123"
],
"id": "abc123",
"tenant": "abc123",
"externalSourceTopicName": "xyz789",
"fileDeleteDelayMs": {},
"qualifiedName": "abc123",
"leaderReplicationThrottledReplicas": [
"xyz789"
],
"messageTimestampType": "abc123",
"preallocate": true,
"isInternal": true,
"segmentBytes": 987,
"segmentIndexBytes": 123,
"flushMessages": {},
"name": "abc123",
"doc": "abc123",
"messageFormatVersion": "xyz789",
"indexIntervalBytes": 987,
"minCompactionLagMs": {},
"segmentMs": {},
"mirrorTopicState": "xyz789",
"segmentJitterMs": {},
"maxMessageBytes": 987,
"displayName": "abc123",
"description": "xyz789",
"nameLower": "xyz789",
"valueSchemaValidation": true,
"deprecatedTime": "2007-12-03T10:15:30Z",
"externalSourceTopicId": "xyz789",
"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": false,
"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_cleanupPolicy_criteria
Description
Criteria expression specification of cleanupPolicy attribute in entity kafka_topic
Fields
| Input Field | Description |
|---|---|
_eq - kafka_cleanup_policy
|
Equals criteria |
_lte - kafka_cleanup_policy
|
Less than or equals criteria |
_gte - kafka_cleanup_policy
|
Greater or equals criteria |
_gt - kafka_cleanup_policy
|
Greater than criteria |
_lt - kafka_cleanup_policy
|
Less than criteria |
_starts_with - kafka_cleanup_policy
|
Starts with criteria |
Example
{
"_eq": "NONE",
"_lte": "NONE",
"_gte": "NONE",
"_gt": "NONE",
"_lt": "NONE",
"_starts_with": "NONE"
}
kafka_topic_compressionType_criteria
Description
Criteria expression specification of compressionType attribute in entity kafka_topic
Fields
| Input Field | Description |
|---|---|
_eq - kafka_compression_type
|
Equals criteria |
_lte - kafka_compression_type
|
Less than or equals criteria |
_gte - kafka_compression_type
|
Greater or equals criteria |
_gt - kafka_compression_type
|
Greater than criteria |
_lt - kafka_compression_type
|
Less than criteria |
_starts_with - kafka_compression_type
|
Starts with criteria |
Example
{
"_eq": "UNSPECIFIED",
"_lte": "UNSPECIFIED",
"_gte": "UNSPECIFIED",
"_gt": "UNSPECIFIED",
"_lt": "UNSPECIFIED",
"_starts_with": "UNSPECIFIED"
}
kafka_topic_count
Description
Type representing a Kafka topic
Fields
| Field Name | Description |
|---|---|
replicationFactor - Int
|
The replication factor |
maxCompactionLagMs - Long
|
The maximum time in ms a message will remain ineligible for compaction in the log |
compressionType - kafka_compression_type
|
The compression type |
messageDownconversionEnable - Boolean
|
Whether down-conversion of message formats is enabled |
minCleanableDirtyRatio - Float
|
The ratio of the log compactor will attempt to clean the log |
uncleanLeaderElectionEnable - Boolean
|
Whether to enable replicas not in the ISR set to be elected as leader |
minInsyncReplicas - Int
|
The minimum number of replicas that must acknowledge a write for the write to be considered successful |
retentionBytes - Long
|
The retention bytes |
followerReplicationThrottledReplicas - [String]
|
A list of replicas for which log replication should be throttled on the follower side |
id - String
|
The topic id |
tenant - String
|
The tenant |
externalSourceTopicName - String
|
Used for cluster links when source cluster and destination cluster are not in the same environment |
fileDeleteDelayMs - Long
|
The time in ms to wait before deleting a file from the filesystem |
qualifiedName - String
|
|
leaderReplicationThrottledReplicas - [String]
|
A list of replicas for which log replication should be throttled on the leader side |
messageTimestampType - String
|
The message timestamp type |
preallocate - Boolean
|
Whether to preallocate the file on disk when creating a new log segment |
isInternal - Boolean
|
Whether the topic is internal |
segmentBytes - Int
|
The segment file size for the log |
segmentIndexBytes - Int
|
The size of the index that maps offsets to file positions |
flushMessages - Long
|
The interval at which Kafka force an fsync of data written to the log |
name - String
|
|
doc - String
|
Documentation |
messageFormatVersion - String
|
The message format version the broker will use to append messages to the logs |
indexIntervalBytes - Int
|
The bytes interval for Kafka adds an index entry to its offset index |
minCompactionLagMs - Long
|
The minimum time in ms a message will remain uncompacted in the log |
segmentMs - Long
|
The period of time in ms after which Kafka will force the log to roll |
mirrorTopicState - String
|
Not null when current entity is a mirror topic. This Attribute represents the mirror topic state |
segmentJitterMs - Long
|
The maximum random jitter subtracted from the scheduled segment roll time |
maxMessageBytes - Int
|
The largest record batch size allowed by Kafka |
displayName - String
|
|
description - String
|
|
nameLower - String
|
Lowercase representation of the name |
valueSchemaValidation - Boolean
|
Whether value schema validation is enabled |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
externalSourceTopicId - String
|
Used for cluster links when source cluster and destination cluster are not in the same environment |
owner - String
|
|
retentionMs - Long
|
The retention time in ms |
userDescription - String
|
|
deleteRetentionMs - Long
|
The amount of time in ms to retain delete tombstone markers for log compacted topics |
flushMs - Long
|
The time interval in ms at which Kafka force an fsync of data written to the log |
updateTime - DateTime
|
The update time |
mirrorTopicUpdateTime - String
|
Not null when current entity is a mirror topic. This Attribute represents the mirror topic state update time |
ownerEmail - String
|
|
partitionsCount - Int
|
The number of partitions |
messageTimestampDifferenceMaxMs - Long
|
The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message |
createTime - DateTime
|
The create time |
keySchemaValidation - Boolean
|
Whether key schema validation is enabled |
cleanupPolicy - kafka_cleanup_policy
|
The cleanup policy |
connectors - [cn_connector]
|
The connectors |
Arguments
|
|
mirror_topics - [kafka_topic]
|
|
Arguments
|
|
source_topic - kafka_topic
|
|
Arguments
|
|
logical_cluster - kafka_logical_cluster
|
|
Arguments
|
|
input_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
output_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
activated_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
cluster_link - kafka_cluster_link
|
|
Arguments
|
|
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
{
"replicationFactor": 123,
"maxCompactionLagMs": {},
"compressionType": "UNSPECIFIED",
"messageDownconversionEnable": false,
"minCleanableDirtyRatio": 123.45,
"uncleanLeaderElectionEnable": false,
"minInsyncReplicas": 987,
"retentionBytes": {},
"followerReplicationThrottledReplicas": [
"abc123"
],
"id": "abc123",
"tenant": "abc123",
"externalSourceTopicName": "abc123",
"fileDeleteDelayMs": {},
"qualifiedName": "abc123",
"leaderReplicationThrottledReplicas": [
"xyz789"
],
"messageTimestampType": "xyz789",
"preallocate": true,
"isInternal": false,
"segmentBytes": 123,
"segmentIndexBytes": 123,
"flushMessages": {},
"name": "xyz789",
"doc": "xyz789",
"messageFormatVersion": "abc123",
"indexIntervalBytes": 123,
"minCompactionLagMs": {},
"segmentMs": {},
"mirrorTopicState": "abc123",
"segmentJitterMs": {},
"maxMessageBytes": 123,
"displayName": "abc123",
"description": "abc123",
"nameLower": "xyz789",
"valueSchemaValidation": true,
"deprecatedTime": "2007-12-03T10:15:30Z",
"externalSourceTopicId": "xyz789",
"owner": "abc123",
"retentionMs": {},
"userDescription": "abc123",
"deleteRetentionMs": {},
"flushMs": {},
"updateTime": "2007-12-03T10:15:30Z",
"mirrorTopicUpdateTime": "abc123",
"ownerEmail": "abc123",
"partitionsCount": 987,
"messageTimestampDifferenceMaxMs": {},
"createTime": "2007-12-03T10:15:30Z",
"keySchemaValidation": false,
"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": ["abc123"],
"entity_count": 987
}
kafka_topic_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity kafka_topic
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"
}
kafka_topic_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [kafka_topic_criteria]
|
Logical operation for expressions |
_and - [kafka_topic_criteria]
|
Logical operation for expressions |
replicationFactor - kafka_topic_replicationFactor_criteria
|
The replication factor |
maxCompactionLagMs - kafka_topic_maxCompactionLagMs_criteria
|
The maximum time in ms a message will remain ineligible for compaction in the log |
compressionType - kafka_topic_compressionType_criteria
|
The compression type |
messageDownconversionEnable - kafka_topic_messageDownconversionEnable_criteria
|
Whether down-conversion of message formats is enabled |
minCleanableDirtyRatio - kafka_topic_minCleanableDirtyRatio_criteria
|
The ratio of the log compactor will attempt to clean the log |
uncleanLeaderElectionEnable - kafka_topic_uncleanLeaderElectionEnable_criteria
|
Whether to enable replicas not in the ISR set to be elected as leader |
minInsyncReplicas - kafka_topic_minInsyncReplicas_criteria
|
The minimum number of replicas that must acknowledge a write for the write to be considered successful |
retentionBytes - kafka_topic_retentionBytes_criteria
|
The retention bytes |
id - kafka_topic_id_criteria
|
The topic id |
tenant - kafka_topic_tenant_criteria
|
The tenant |
externalSourceTopicName - kafka_topic_externalSourceTopicName_criteria
|
Used for cluster links when source cluster and destination cluster are not in the same environment |
fileDeleteDelayMs - kafka_topic_fileDeleteDelayMs_criteria
|
The time in ms to wait before deleting a file from the filesystem |
qualifiedName - kafka_topic_qualifiedName_criteria
|
|
messageTimestampType - kafka_topic_messageTimestampType_criteria
|
The message timestamp type |
preallocate - kafka_topic_preallocate_criteria
|
Whether to preallocate the file on disk when creating a new log segment |
isInternal - kafka_topic_isInternal_criteria
|
Whether the topic is internal |
segmentBytes - kafka_topic_segmentBytes_criteria
|
The segment file size for the log |
segmentIndexBytes - kafka_topic_segmentIndexBytes_criteria
|
The size of the index that maps offsets to file positions |
flushMessages - kafka_topic_flushMessages_criteria
|
The interval at which Kafka force an fsync of data written to the log |
name - kafka_topic_name_criteria
|
|
doc - kafka_topic_doc_criteria
|
Documentation |
messageFormatVersion - kafka_topic_messageFormatVersion_criteria
|
The message format version the broker will use to append messages to the logs |
indexIntervalBytes - kafka_topic_indexIntervalBytes_criteria
|
The bytes interval for Kafka adds an index entry to its offset index |
minCompactionLagMs - kafka_topic_minCompactionLagMs_criteria
|
The minimum time in ms a message will remain uncompacted in the log |
segmentMs - kafka_topic_segmentMs_criteria
|
The period of time in ms after which Kafka will force the log to roll |
mirrorTopicState - kafka_topic_mirrorTopicState_criteria
|
Not null when current entity is a mirror topic. This Attribute represents the mirror topic state |
segmentJitterMs - kafka_topic_segmentJitterMs_criteria
|
The maximum random jitter subtracted from the scheduled segment roll time |
maxMessageBytes - kafka_topic_maxMessageBytes_criteria
|
The largest record batch size allowed by Kafka |
displayName - kafka_topic_displayName_criteria
|
|
description - kafka_topic_description_criteria
|
|
nameLower - kafka_topic_nameLower_criteria
|
Lowercase representation of the name |
valueSchemaValidation - kafka_topic_valueSchemaValidation_criteria
|
Whether value schema validation is enabled |
deprecatedTime - kafka_topic_deprecatedTime_criteria
|
The time when the entity is deprecated |
externalSourceTopicId - kafka_topic_externalSourceTopicId_criteria
|
Used for cluster links when source cluster and destination cluster are not in the same environment |
owner - kafka_topic_owner_criteria
|
|
retentionMs - kafka_topic_retentionMs_criteria
|
The retention time in ms |
userDescription - kafka_topic_userDescription_criteria
|
|
deleteRetentionMs - kafka_topic_deleteRetentionMs_criteria
|
The amount of time in ms to retain delete tombstone markers for log compacted topics |
flushMs - kafka_topic_flushMs_criteria
|
The time interval in ms at which Kafka force an fsync of data written to the log |
updateTime - kafka_topic_updateTime_criteria
|
The update time |
mirrorTopicUpdateTime - kafka_topic_mirrorTopicUpdateTime_criteria
|
Not null when current entity is a mirror topic. This Attribute represents the mirror topic state update time |
ownerEmail - kafka_topic_ownerEmail_criteria
|
|
partitionsCount - kafka_topic_partitionsCount_criteria
|
The number of partitions |
messageTimestampDifferenceMaxMs - kafka_topic_messageTimestampDifferenceMaxMs_criteria
|
The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message |
createTime - kafka_topic_createTime_criteria
|
The create time |
keySchemaValidation - kafka_topic_keySchemaValidation_criteria
|
Whether key schema validation is enabled |
cleanupPolicy - kafka_topic_cleanupPolicy_criteria
|
The cleanup policy |
Example
{
"_or": [kafka_topic_criteria],
"_and": [kafka_topic_criteria],
"replicationFactor": kafka_topic_replicationFactor_criteria,
"maxCompactionLagMs": kafka_topic_maxCompactionLagMs_criteria,
"compressionType": kafka_topic_compressionType_criteria,
"messageDownconversionEnable": kafka_topic_messageDownconversionEnable_criteria,
"minCleanableDirtyRatio": kafka_topic_minCleanableDirtyRatio_criteria,
"uncleanLeaderElectionEnable": kafka_topic_uncleanLeaderElectionEnable_criteria,
"minInsyncReplicas": kafka_topic_minInsyncReplicas_criteria,
"retentionBytes": kafka_topic_retentionBytes_criteria,
"id": kafka_topic_id_criteria,
"tenant": kafka_topic_tenant_criteria,
"externalSourceTopicName": kafka_topic_externalSourceTopicName_criteria,
"fileDeleteDelayMs": kafka_topic_fileDeleteDelayMs_criteria,
"qualifiedName": kafka_topic_qualifiedName_criteria,
"messageTimestampType": kafka_topic_messageTimestampType_criteria,
"preallocate": kafka_topic_preallocate_criteria,
"isInternal": kafka_topic_isInternal_criteria,
"segmentBytes": kafka_topic_segmentBytes_criteria,
"segmentIndexBytes": kafka_topic_segmentIndexBytes_criteria,
"flushMessages": kafka_topic_flushMessages_criteria,
"name": kafka_topic_name_criteria,
"doc": kafka_topic_doc_criteria,
"messageFormatVersion": kafka_topic_messageFormatVersion_criteria,
"indexIntervalBytes": kafka_topic_indexIntervalBytes_criteria,
"minCompactionLagMs": kafka_topic_minCompactionLagMs_criteria,
"segmentMs": kafka_topic_segmentMs_criteria,
"mirrorTopicState": kafka_topic_mirrorTopicState_criteria,
"segmentJitterMs": kafka_topic_segmentJitterMs_criteria,
"maxMessageBytes": kafka_topic_maxMessageBytes_criteria,
"displayName": kafka_topic_displayName_criteria,
"description": kafka_topic_description_criteria,
"nameLower": kafka_topic_nameLower_criteria,
"valueSchemaValidation": kafka_topic_valueSchemaValidation_criteria,
"deprecatedTime": kafka_topic_deprecatedTime_criteria,
"externalSourceTopicId": kafka_topic_externalSourceTopicId_criteria,
"owner": kafka_topic_owner_criteria,
"retentionMs": kafka_topic_retentionMs_criteria,
"userDescription": kafka_topic_userDescription_criteria,
"deleteRetentionMs": kafka_topic_deleteRetentionMs_criteria,
"flushMs": kafka_topic_flushMs_criteria,
"updateTime": kafka_topic_updateTime_criteria,
"mirrorTopicUpdateTime": kafka_topic_mirrorTopicUpdateTime_criteria,
"ownerEmail": kafka_topic_ownerEmail_criteria,
"partitionsCount": kafka_topic_partitionsCount_criteria,
"messageTimestampDifferenceMaxMs": kafka_topic_messageTimestampDifferenceMaxMs_criteria,
"createTime": kafka_topic_createTime_criteria,
"keySchemaValidation": kafka_topic_keySchemaValidation_criteria,
"cleanupPolicy": kafka_topic_cleanupPolicy_criteria
}
kafka_topic_deleteRetentionMs_criteria
Description
Criteria expression specification of deleteRetentionMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity kafka_topic
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"
}
kafka_topic_description_criteria
Description
Criteria expression specification of description attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_topic_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_topic_doc_criteria
Description
Criteria expression specification of doc attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_topic_externalSourceTopicId_criteria
Description
Criteria expression specification of externalSourceTopicId attribute in entity kafka_topic
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_topic_externalSourceTopicName_criteria
Description
Criteria expression specification of externalSourceTopicName attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_topic_fileDeleteDelayMs_criteria
Description
Criteria expression specification of fileDeleteDelayMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_flushMessages_criteria
Description
Criteria expression specification of flushMessages attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_flushMs_criteria
Description
Criteria expression specification of flushMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_id_criteria
Description
Criteria expression specification of id attribute in entity kafka_topic
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_topic_indexIntervalBytes_criteria
Description
Criteria expression specification of indexIntervalBytes attribute in entity kafka_topic
Example
{"_eq": 987, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 987}
kafka_topic_isInternal_criteria
Description
Criteria expression specification of isInternal attribute in entity kafka_topic
Example
{"_eq": true, "_lte": false, "_gte": false, "_gt": false, "_lt": false}
kafka_topic_keySchemaValidation_criteria
Description
Criteria expression specification of keySchemaValidation attribute in entity kafka_topic
Example
{"_eq": true, "_lte": false, "_gte": false, "_gt": true, "_lt": false}
kafka_topic_maxCompactionLagMs_criteria
Description
Criteria expression specification of maxCompactionLagMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_maxMessageBytes_criteria
Description
Criteria expression specification of maxMessageBytes attribute in entity kafka_topic
Example
{"_eq": 987, "_lte": 123, "_gte": 123, "_gt": 987, "_lt": 123}
kafka_topic_messageDownconversionEnable_criteria
Description
Criteria expression specification of messageDownconversionEnable attribute in entity kafka_topic
Example
{"_eq": false, "_lte": true, "_gte": false, "_gt": false, "_lt": false}
kafka_topic_messageFormatVersion_criteria
Description
Criteria expression specification of messageFormatVersion attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_topic_messageTimestampDifferenceMaxMs_criteria
Description
Criteria expression specification of messageTimestampDifferenceMaxMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_messageTimestampType_criteria
Description
Criteria expression specification of messageTimestampType attribute in entity kafka_topic
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
kafka_topic_minCleanableDirtyRatio_criteria
Description
Criteria expression specification of minCleanableDirtyRatio attribute in entity kafka_topic
Example
{"_eq": 987.65, "_lte": 987.65, "_gte": 123.45, "_gt": 123.45, "_lt": 987.65}
kafka_topic_minCompactionLagMs_criteria
Description
Criteria expression specification of minCompactionLagMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_minInsyncReplicas_criteria
Description
Criteria expression specification of minInsyncReplicas attribute in entity kafka_topic
Example
{"_eq": 987, "_lte": 987, "_gte": 987, "_gt": 123, "_lt": 987}
kafka_topic_mirrorTopicState_criteria
Description
Criteria expression specification of mirrorTopicState attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_topic_mirrorTopicUpdateTime_criteria
Description
Criteria expression specification of mirrorTopicUpdateTime attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_topic_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_topic_name_criteria
Description
Criteria expression specification of name attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_topic_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
replicationFactor - order_by_enum
|
The replication factor |
maxCompactionLagMs - order_by_enum
|
The maximum time in ms a message will remain ineligible for compaction in the log |
compressionType - order_by_enum
|
The compression type |
messageDownconversionEnable - order_by_enum
|
Whether down-conversion of message formats is enabled |
minCleanableDirtyRatio - order_by_enum
|
The ratio of the log compactor will attempt to clean the log |
uncleanLeaderElectionEnable - order_by_enum
|
Whether to enable replicas not in the ISR set to be elected as leader |
minInsyncReplicas - order_by_enum
|
The minimum number of replicas that must acknowledge a write for the write to be considered successful |
retentionBytes - order_by_enum
|
The retention bytes |
followerReplicationThrottledReplicas - order_by_enum
|
A list of replicas for which log replication should be throttled on the follower side |
id - order_by_enum
|
The topic id |
tenant - order_by_enum
|
The tenant |
externalSourceTopicName - order_by_enum
|
Used for cluster links when source cluster and destination cluster are not in the same environment |
fileDeleteDelayMs - order_by_enum
|
The time in ms to wait before deleting a file from the filesystem |
qualifiedName - order_by_enum
|
|
leaderReplicationThrottledReplicas - order_by_enum
|
A list of replicas for which log replication should be throttled on the leader side |
messageTimestampType - order_by_enum
|
The message timestamp type |
preallocate - order_by_enum
|
Whether to preallocate the file on disk when creating a new log segment |
isInternal - order_by_enum
|
Whether the topic is internal |
segmentBytes - order_by_enum
|
The segment file size for the log |
segmentIndexBytes - order_by_enum
|
The size of the index that maps offsets to file positions |
flushMessages - order_by_enum
|
The interval at which Kafka force an fsync of data written to the log |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
messageFormatVersion - order_by_enum
|
The message format version the broker will use to append messages to the logs |
indexIntervalBytes - order_by_enum
|
The bytes interval for Kafka adds an index entry to its offset index |
minCompactionLagMs - order_by_enum
|
The minimum time in ms a message will remain uncompacted in the log |
segmentMs - order_by_enum
|
The period of time in ms after which Kafka will force the log to roll |
mirrorTopicState - order_by_enum
|
Not null when current entity is a mirror topic. This Attribute represents the mirror topic state |
segmentJitterMs - order_by_enum
|
The maximum random jitter subtracted from the scheduled segment roll time |
replicatedFrom - order_by_enum
|
|
maxMessageBytes - order_by_enum
|
The largest record batch size allowed by Kafka |
displayName - order_by_enum
|
|
description - order_by_enum
|
|
nameLower - order_by_enum
|
Lowercase representation of the name |
valueSchemaValidation - order_by_enum
|
Whether value schema validation is enabled |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
externalSourceTopicId - order_by_enum
|
Used for cluster links when source cluster and destination cluster are not in the same environment |
owner - order_by_enum
|
|
retentionMs - order_by_enum
|
The retention time in ms |
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
deleteRetentionMs - order_by_enum
|
The amount of time in ms to retain delete tombstone markers for log compacted topics |
flushMs - order_by_enum
|
The time interval in ms at which Kafka force an fsync of data written to the log |
updateTime - order_by_enum
|
The update time |
mirrorTopicUpdateTime - order_by_enum
|
Not null when current entity is a mirror topic. This Attribute represents the mirror topic state update time |
ownerEmail - order_by_enum
|
|
partitionsCount - order_by_enum
|
The number of partitions |
messageTimestampDifferenceMaxMs - order_by_enum
|
The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message |
createTime - order_by_enum
|
The create time |
keySchemaValidation - order_by_enum
|
Whether key schema validation is enabled |
cleanupPolicy - order_by_enum
|
The cleanup policy |
Example
{
"replicationFactor": "asc",
"maxCompactionLagMs": "asc",
"compressionType": "asc",
"messageDownconversionEnable": "asc",
"minCleanableDirtyRatio": "asc",
"uncleanLeaderElectionEnable": "asc",
"minInsyncReplicas": "asc",
"retentionBytes": "asc",
"followerReplicationThrottledReplicas": "asc",
"id": "asc",
"tenant": "asc",
"externalSourceTopicName": "asc",
"fileDeleteDelayMs": "asc",
"qualifiedName": "asc",
"leaderReplicationThrottledReplicas": "asc",
"messageTimestampType": "asc",
"preallocate": "asc",
"isInternal": "asc",
"segmentBytes": "asc",
"segmentIndexBytes": "asc",
"flushMessages": "asc",
"name": "asc",
"doc": "asc",
"messageFormatVersion": "asc",
"indexIntervalBytes": "asc",
"minCompactionLagMs": "asc",
"segmentMs": "asc",
"mirrorTopicState": "asc",
"segmentJitterMs": "asc",
"replicatedFrom": "asc",
"maxMessageBytes": "asc",
"displayName": "asc",
"description": "asc",
"nameLower": "asc",
"valueSchemaValidation": "asc",
"deprecatedTime": "asc",
"externalSourceTopicId": "asc",
"owner": "asc",
"retentionMs": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"deleteRetentionMs": "asc",
"flushMs": "asc",
"updateTime": "asc",
"mirrorTopicUpdateTime": "asc",
"ownerEmail": "asc",
"partitionsCount": "asc",
"messageTimestampDifferenceMaxMs": "asc",
"createTime": "asc",
"keySchemaValidation": "asc",
"cleanupPolicy": "asc"
}
kafka_topic_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
kafka_topic_owner_criteria
Description
Criteria expression specification of owner attribute in entity kafka_topic
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_topic_partitionsCount_criteria
Description
Criteria expression specification of partitionsCount attribute in entity kafka_topic
Example
{"_eq": 123, "_lte": 987, "_gte": 987, "_gt": 123, "_lt": 123}
kafka_topic_preallocate_criteria
Description
Criteria expression specification of preallocate attribute in entity kafka_topic
Example
{"_eq": false, "_lte": false, "_gte": false, "_gt": false, "_lt": true}
kafka_topic_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity kafka_topic
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
kafka_topic_replicationFactor_criteria
Description
Criteria expression specification of replicationFactor attribute in entity kafka_topic
Example
{"_eq": 123, "_lte": 123, "_gte": 123, "_gt": 987, "_lt": 123}
kafka_topic_retentionBytes_criteria
Description
Criteria expression specification of retentionBytes attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_retentionMs_criteria
Description
Criteria expression specification of retentionMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_segmentBytes_criteria
Description
Criteria expression specification of segmentBytes attribute in entity kafka_topic
Example
{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 987}
kafka_topic_segmentIndexBytes_criteria
Description
Criteria expression specification of segmentIndexBytes attribute in entity kafka_topic
Example
{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 987}
kafka_topic_segmentJitterMs_criteria
Description
Criteria expression specification of segmentJitterMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_segmentMs_criteria
Description
Criteria expression specification of segmentMs attribute in entity kafka_topic
Example
{"_eq": {}, "_lte": {}, "_gte": {}, "_gt": {}, "_lt": {}}
kafka_topic_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity kafka_topic
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_topic_uncleanLeaderElectionEnable_criteria
Description
Criteria expression specification of uncleanLeaderElectionEnable attribute in entity kafka_topic
Example
{"_eq": false, "_lte": false, "_gte": false, "_gt": true, "_lt": false}
kafka_topic_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity kafka_topic
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"
}
kafka_topic_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity kafka_topic
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
kafka_topic_valueSchemaValidation_criteria
Description
Criteria expression specification of valueSchemaValidation attribute in entity kafka_topic
Example
{"_eq": false, "_lte": false, "_gte": true, "_gt": false, "_lt": false}
ksql_logical_cluster
Description
Type representing a logical ksql cluster
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 |
id - String
|
The logical cluster id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
tables - [ksql_table]
|
|
Arguments
|
|
pipelines - [pl_pipeline]
|
|
Arguments
|
|
streams - [ksql_stream]
|
|
Arguments
|
|
queries - [ksql_query]
|
|
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"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": ["abc123"]
}
ksql_logical_cluster_count
Description
Type representing a logical ksql cluster
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 |
id - String
|
The logical cluster id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
tables - [ksql_table]
|
|
Arguments
|
|
pipelines - [pl_pipeline]
|
|
Arguments
|
|
streams - [ksql_stream]
|
|
Arguments
|
|
queries - [ksql_query]
|
|
Arguments
|
|
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": "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": "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"],
"entity_count": 123
}
ksql_logical_cluster_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity ksql_logical_cluster
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"
}
ksql_logical_cluster_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
Example
{
"_or": [ksql_logical_cluster_criteria],
"_and": [ksql_logical_cluster_criteria],
"owner": ksql_logical_cluster_owner_criteria,
"userDescription": ksql_logical_cluster_userDescription_criteria,
"qualifiedName": ksql_logical_cluster_qualifiedName_criteria,
"displayName": ksql_logical_cluster_displayName_criteria,
"description": ksql_logical_cluster_description_criteria,
"updateTime": ksql_logical_cluster_updateTime_criteria,
"nameLower": ksql_logical_cluster_nameLower_criteria,
"ownerEmail": ksql_logical_cluster_ownerEmail_criteria,
"createTime": ksql_logical_cluster_createTime_criteria,
"name": ksql_logical_cluster_name_criteria,
"doc": ksql_logical_cluster_doc_criteria,
"id": ksql_logical_cluster_id_criteria,
"deprecatedTime": ksql_logical_cluster_deprecatedTime_criteria,
"tenant": ksql_logical_cluster_tenant_criteria
}
ksql_logical_cluster_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity ksql_logical_cluster
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"
}
ksql_logical_cluster_description_criteria
Description
Criteria expression specification of description attribute in entity ksql_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_logical_cluster_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity ksql_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_logical_cluster_doc_criteria
Description
Criteria expression specification of doc attribute in entity ksql_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_logical_cluster_id_criteria
Description
Criteria expression specification of id attribute in entity ksql_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
ksql_logical_cluster_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity ksql_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
ksql_logical_cluster_name_criteria
Description
Criteria expression specification of name attribute in entity ksql_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_logical_cluster_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The logical cluster id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
ksql_logical_cluster_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity ksql_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_logical_cluster_owner_criteria
Description
Criteria expression specification of owner attribute in entity ksql_logical_cluster
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_logical_cluster_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity ksql_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
ksql_logical_cluster_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity ksql_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
ksql_logical_cluster_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity ksql_logical_cluster
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"
}
ksql_logical_cluster_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity ksql_logical_cluster
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_query
Description
Type representing a ksql query
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 |
logical_cluster - ksql_logical_cluster
|
|
Arguments
|
|
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 |
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": "abc123",
"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
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 |
logical_cluster - ksql_logical_cluster
|
|
Arguments
|
|
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": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"doc": "abc123",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"logical_cluster": ksql_logical_cluster,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["xyz789"],
"entity_count": 987
}
ksql_query_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity ksql_query
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"
}
ksql_query_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [ksql_query_criteria]
|
Logical operation for expressions |
_and - [ksql_query_criteria]
|
Logical operation for expressions |
owner - ksql_query_owner_criteria
|
|
userDescription - ksql_query_userDescription_criteria
|
|
qualifiedName - ksql_query_qualifiedName_criteria
|
|
displayName - ksql_query_displayName_criteria
|
|
description - ksql_query_description_criteria
|
|
updateTime - ksql_query_updateTime_criteria
|
The update time |
nameLower - ksql_query_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - ksql_query_ownerEmail_criteria
|
|
createTime - ksql_query_createTime_criteria
|
The create time |
name - ksql_query_name_criteria
|
|
doc - ksql_query_doc_criteria
|
Documentation |
deprecatedTime - ksql_query_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - ksql_query_tenant_criteria
|
The tenant |
Example
{
"_or": [ksql_query_criteria],
"_and": [ksql_query_criteria],
"owner": ksql_query_owner_criteria,
"userDescription": ksql_query_userDescription_criteria,
"qualifiedName": ksql_query_qualifiedName_criteria,
"displayName": ksql_query_displayName_criteria,
"description": ksql_query_description_criteria,
"updateTime": ksql_query_updateTime_criteria,
"nameLower": ksql_query_nameLower_criteria,
"ownerEmail": ksql_query_ownerEmail_criteria,
"createTime": ksql_query_createTime_criteria,
"name": ksql_query_name_criteria,
"doc": ksql_query_doc_criteria,
"deprecatedTime": ksql_query_deprecatedTime_criteria,
"tenant": ksql_query_tenant_criteria
}
ksql_query_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity ksql_query
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"
}
ksql_query_description_criteria
Description
Criteria expression specification of description attribute in entity ksql_query
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_query_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity ksql_query
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
ksql_query_doc_criteria
Description
Criteria expression specification of doc attribute in entity ksql_query
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
ksql_query_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity ksql_query
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_query_name_criteria
Description
Criteria expression specification of name attribute in entity ksql_query
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_query_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
ksql_query_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity ksql_query
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
ksql_query_owner_criteria
Description
Criteria expression specification of owner attribute in entity ksql_query
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_query_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity ksql_query
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_query_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity ksql_query
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
ksql_query_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity ksql_query
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"
}
ksql_query_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity ksql_query
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_stream
Description
Type representing a ksql stream
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 |
logical_cluster - ksql_logical_cluster
|
|
Arguments
|
|
activated_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"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": "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": ["xyz789"]
}
ksql_stream_count
Description
Type representing a ksql stream
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 |
logical_cluster - ksql_logical_cluster
|
|
Arguments
|
|
activated_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
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": "abc123",
"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": "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"],
"entity_count": 987
}
ksql_stream_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity ksql_stream
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"
}
ksql_stream_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [ksql_stream_criteria]
|
Logical operation for expressions |
_and - [ksql_stream_criteria]
|
Logical operation for expressions |
owner - ksql_stream_owner_criteria
|
|
userDescription - ksql_stream_userDescription_criteria
|
|
qualifiedName - ksql_stream_qualifiedName_criteria
|
|
displayName - ksql_stream_displayName_criteria
|
|
description - ksql_stream_description_criteria
|
|
updateTime - ksql_stream_updateTime_criteria
|
The update time |
nameLower - ksql_stream_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - ksql_stream_ownerEmail_criteria
|
|
createTime - ksql_stream_createTime_criteria
|
The create time |
name - ksql_stream_name_criteria
|
|
doc - ksql_stream_doc_criteria
|
Documentation |
deprecatedTime - ksql_stream_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - ksql_stream_tenant_criteria
|
The tenant |
Example
{
"_or": [ksql_stream_criteria],
"_and": [ksql_stream_criteria],
"owner": ksql_stream_owner_criteria,
"userDescription": ksql_stream_userDescription_criteria,
"qualifiedName": ksql_stream_qualifiedName_criteria,
"displayName": ksql_stream_displayName_criteria,
"description": ksql_stream_description_criteria,
"updateTime": ksql_stream_updateTime_criteria,
"nameLower": ksql_stream_nameLower_criteria,
"ownerEmail": ksql_stream_ownerEmail_criteria,
"createTime": ksql_stream_createTime_criteria,
"name": ksql_stream_name_criteria,
"doc": ksql_stream_doc_criteria,
"deprecatedTime": ksql_stream_deprecatedTime_criteria,
"tenant": ksql_stream_tenant_criteria
}
ksql_stream_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity ksql_stream
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"
}
ksql_stream_description_criteria
Description
Criteria expression specification of description attribute in entity ksql_stream
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_stream_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity ksql_stream
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
ksql_stream_doc_criteria
Description
Criteria expression specification of doc attribute in entity ksql_stream
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_stream_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity ksql_stream
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_stream_name_criteria
Description
Criteria expression specification of name attribute in entity ksql_stream
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_stream_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
ksql_stream_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity ksql_stream
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_stream_owner_criteria
Description
Criteria expression specification of owner attribute in entity ksql_stream
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
ksql_stream_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity ksql_stream
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_stream_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity ksql_stream
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_stream_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity ksql_stream
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"
}
ksql_stream_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity ksql_stream
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_table
Description
Type representing a ksql table
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 |
logical_cluster - ksql_logical_cluster
|
|
Arguments
|
|
activated_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"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": ["abc123"]
}
ksql_table_count
Description
Type representing a ksql table
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 |
logical_cluster - ksql_logical_cluster
|
|
Arguments
|
|
activated_for_pipelines - [pl_pipeline]
|
|
Arguments
|
|
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": "abc123",
"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": "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": 987
}
ksql_table_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity ksql_table
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"
}
ksql_table_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [ksql_table_criteria]
|
Logical operation for expressions |
_and - [ksql_table_criteria]
|
Logical operation for expressions |
owner - ksql_table_owner_criteria
|
|
userDescription - ksql_table_userDescription_criteria
|
|
qualifiedName - ksql_table_qualifiedName_criteria
|
|
displayName - ksql_table_displayName_criteria
|
|
description - ksql_table_description_criteria
|
|
updateTime - ksql_table_updateTime_criteria
|
The update time |
nameLower - ksql_table_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - ksql_table_ownerEmail_criteria
|
|
createTime - ksql_table_createTime_criteria
|
The create time |
name - ksql_table_name_criteria
|
|
doc - ksql_table_doc_criteria
|
Documentation |
deprecatedTime - ksql_table_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - ksql_table_tenant_criteria
|
The tenant |
Example
{
"_or": [ksql_table_criteria],
"_and": [ksql_table_criteria],
"owner": ksql_table_owner_criteria,
"userDescription": ksql_table_userDescription_criteria,
"qualifiedName": ksql_table_qualifiedName_criteria,
"displayName": ksql_table_displayName_criteria,
"description": ksql_table_description_criteria,
"updateTime": ksql_table_updateTime_criteria,
"nameLower": ksql_table_nameLower_criteria,
"ownerEmail": ksql_table_ownerEmail_criteria,
"createTime": ksql_table_createTime_criteria,
"name": ksql_table_name_criteria,
"doc": ksql_table_doc_criteria,
"deprecatedTime": ksql_table_deprecatedTime_criteria,
"tenant": ksql_table_tenant_criteria
}
ksql_table_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity ksql_table
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"
}
ksql_table_description_criteria
Description
Criteria expression specification of description attribute in entity ksql_table
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
ksql_table_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity ksql_table
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
ksql_table_doc_criteria
Description
Criteria expression specification of doc attribute in entity ksql_table
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_table_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity ksql_table
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
ksql_table_name_criteria
Description
Criteria expression specification of name attribute in entity ksql_table
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_table_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
ksql_table_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity ksql_table
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_table_owner_criteria
Description
Criteria expression specification of owner attribute in entity ksql_table
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
ksql_table_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity ksql_table
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
ksql_table_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity ksql_table
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
ksql_table_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity ksql_table
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"
}
ksql_table_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity ksql_table
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
order_by_enum
Description
Specifies the direction (ascending/descending) for sorting a field
Values
| Enum Value | Description |
|---|---|
|
|
Ascending |
|
|
Descending |
Example
"asc"
pipeline_method
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNSPECIFIED"
pipeline_status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNSPECIFIED"
pl_pipeline
Description
Type representing a pipeline
Fields
| Field Name | Description |
|---|---|
displayName - String
|
|
description - String
|
|
queryCount - Int
|
The pipeline query count |
nameLower - String
|
Lowercase representation of the name |
topicCount - Int
|
The pipeline topic count |
id - String
|
The pipeline id |
streamCount - Int
|
The pipeline stream count |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
owner - String
|
|
updatedBy - String
|
The pipeline updater |
userDescription - String
|
|
method - pipeline_method
|
The method_name |
qualifiedName - String
|
|
tableCount - Int
|
The pipeline table count |
activateTime - DateTime
|
The activate time |
updateTime - DateTime
|
The update time |
connectorCount - Int
|
The pipeline connector count |
activatedBy - String
|
The pipeline activator |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
createdBy - String
|
The pipeline creator |
name - String
|
|
doc - String
|
Documentation |
status - pipeline_status
|
The pipeline state |
activated_connectors - [cn_connector]
|
|
Arguments
|
|
kafka_logical_cluster - kafka_logical_cluster
|
|
Arguments
|
|
ksql_logical_cluster - ksql_logical_cluster
|
|
Arguments
|
|
output_topics - [kafka_topic]
|
|
Arguments
|
|
activated_topics - [kafka_topic]
|
|
Arguments
|
|
activated_tables - [ksql_table]
|
|
Arguments
|
|
input_topics - [kafka_topic]
|
|
Arguments
|
|
activated_streams - [ksql_stream]
|
|
Arguments
|
|
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 |
Example
{
"displayName": "abc123",
"description": "abc123",
"queryCount": 123,
"nameLower": "xyz789",
"topicCount": 987,
"id": "xyz789",
"streamCount": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"owner": "xyz789",
"updatedBy": "xyz789",
"userDescription": "abc123",
"method": "UNSPECIFIED",
"qualifiedName": "abc123",
"tableCount": 123,
"activateTime": "2007-12-03T10:15:30Z",
"updateTime": "2007-12-03T10:15:30Z",
"connectorCount": 987,
"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": ["abc123"]
}
pl_pipeline_activateTime_criteria
Description
Criteria expression specification of activateTime attribute in entity pl_pipeline
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"
}
pl_pipeline_activatedBy_criteria
Description
Criteria expression specification of activatedBy attribute in entity pl_pipeline
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
pl_pipeline_connectorCount_criteria
Description
Criteria expression specification of connectorCount attribute in entity pl_pipeline
Example
{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 987, "_lt": 123}
pl_pipeline_count
Description
Type representing a pipeline
Fields
| Field Name | Description |
|---|---|
displayName - String
|
|
description - String
|
|
queryCount - Int
|
The pipeline query count |
nameLower - String
|
Lowercase representation of the name |
topicCount - Int
|
The pipeline topic count |
id - String
|
The pipeline id |
streamCount - Int
|
The pipeline stream count |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
owner - String
|
|
updatedBy - String
|
The pipeline updater |
userDescription - String
|
|
method - pipeline_method
|
The method_name |
qualifiedName - String
|
|
tableCount - Int
|
The pipeline table count |
activateTime - DateTime
|
The activate time |
updateTime - DateTime
|
The update time |
connectorCount - Int
|
The pipeline connector count |
activatedBy - String
|
The pipeline activator |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
createdBy - String
|
The pipeline creator |
name - String
|
|
doc - String
|
Documentation |
status - pipeline_status
|
The pipeline state |
activated_connectors - [cn_connector]
|
|
Arguments
|
|
kafka_logical_cluster - kafka_logical_cluster
|
|
Arguments
|
|
ksql_logical_cluster - ksql_logical_cluster
|
|
Arguments
|
|
output_topics - [kafka_topic]
|
|
Arguments
|
|
activated_topics - [kafka_topic]
|
|
Arguments
|
|
activated_tables - [ksql_table]
|
|
Arguments
|
|
input_topics - [kafka_topic]
|
|
Arguments
|
|
activated_streams - [ksql_stream]
|
|
Arguments
|
|
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
{
"displayName": "xyz789",
"description": "abc123",
"queryCount": 987,
"nameLower": "xyz789",
"topicCount": 987,
"id": "xyz789",
"streamCount": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"owner": "abc123",
"updatedBy": "xyz789",
"userDescription": "xyz789",
"method": "UNSPECIFIED",
"qualifiedName": "xyz789",
"tableCount": 987,
"activateTime": "2007-12-03T10:15:30Z",
"updateTime": "2007-12-03T10:15:30Z",
"connectorCount": 123,
"activatedBy": "xyz789",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"createdBy": "xyz789",
"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
}
pl_pipeline_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity pl_pipeline
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"
}
pl_pipeline_createdBy_criteria
Description
Criteria expression specification of createdBy attribute in entity pl_pipeline
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
pl_pipeline_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [pl_pipeline_criteria]
|
Logical operation for expressions |
_and - [pl_pipeline_criteria]
|
Logical operation for expressions |
displayName - pl_pipeline_displayName_criteria
|
|
description - pl_pipeline_description_criteria
|
|
queryCount - pl_pipeline_queryCount_criteria
|
The pipeline query count |
nameLower - pl_pipeline_nameLower_criteria
|
Lowercase representation of the name |
topicCount - pl_pipeline_topicCount_criteria
|
The pipeline topic count |
id - pl_pipeline_id_criteria
|
The pipeline id |
streamCount - pl_pipeline_streamCount_criteria
|
The pipeline stream count |
deprecatedTime - pl_pipeline_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - pl_pipeline_tenant_criteria
|
The tenant |
owner - pl_pipeline_owner_criteria
|
|
updatedBy - pl_pipeline_updatedBy_criteria
|
The pipeline updater |
userDescription - pl_pipeline_userDescription_criteria
|
|
method - pl_pipeline_method_criteria
|
The method_name |
qualifiedName - pl_pipeline_qualifiedName_criteria
|
|
tableCount - pl_pipeline_tableCount_criteria
|
The pipeline table count |
activateTime - pl_pipeline_activateTime_criteria
|
The activate time |
updateTime - pl_pipeline_updateTime_criteria
|
The update time |
connectorCount - pl_pipeline_connectorCount_criteria
|
The pipeline connector count |
activatedBy - pl_pipeline_activatedBy_criteria
|
The pipeline activator |
ownerEmail - pl_pipeline_ownerEmail_criteria
|
|
createTime - pl_pipeline_createTime_criteria
|
The create time |
createdBy - pl_pipeline_createdBy_criteria
|
The pipeline creator |
name - pl_pipeline_name_criteria
|
|
doc - pl_pipeline_doc_criteria
|
Documentation |
status - pl_pipeline_status_criteria
|
The pipeline state |
Example
{
"_or": [pl_pipeline_criteria],
"_and": [pl_pipeline_criteria],
"displayName": pl_pipeline_displayName_criteria,
"description": pl_pipeline_description_criteria,
"queryCount": pl_pipeline_queryCount_criteria,
"nameLower": pl_pipeline_nameLower_criteria,
"topicCount": pl_pipeline_topicCount_criteria,
"id": pl_pipeline_id_criteria,
"streamCount": pl_pipeline_streamCount_criteria,
"deprecatedTime": pl_pipeline_deprecatedTime_criteria,
"tenant": pl_pipeline_tenant_criteria,
"owner": pl_pipeline_owner_criteria,
"updatedBy": pl_pipeline_updatedBy_criteria,
"userDescription": pl_pipeline_userDescription_criteria,
"method": pl_pipeline_method_criteria,
"qualifiedName": pl_pipeline_qualifiedName_criteria,
"tableCount": pl_pipeline_tableCount_criteria,
"activateTime": pl_pipeline_activateTime_criteria,
"updateTime": pl_pipeline_updateTime_criteria,
"connectorCount": pl_pipeline_connectorCount_criteria,
"activatedBy": pl_pipeline_activatedBy_criteria,
"ownerEmail": pl_pipeline_ownerEmail_criteria,
"createTime": pl_pipeline_createTime_criteria,
"createdBy": pl_pipeline_createdBy_criteria,
"name": pl_pipeline_name_criteria,
"doc": pl_pipeline_doc_criteria,
"status": pl_pipeline_status_criteria
}
pl_pipeline_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity pl_pipeline
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"
}
pl_pipeline_description_criteria
Description
Criteria expression specification of description attribute in entity pl_pipeline
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
pl_pipeline_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity pl_pipeline
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
pl_pipeline_doc_criteria
Description
Criteria expression specification of doc attribute in entity pl_pipeline
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
pl_pipeline_id_criteria
Description
Criteria expression specification of id attribute in entity pl_pipeline
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
pl_pipeline_method_criteria
Description
Criteria expression specification of method attribute in entity pl_pipeline
Fields
| Input Field | Description |
|---|---|
_eq - pipeline_method
|
Equals criteria |
_lte - pipeline_method
|
Less than or equals criteria |
_gte - pipeline_method
|
Greater or equals criteria |
_gt - pipeline_method
|
Greater than criteria |
_lt - pipeline_method
|
Less than criteria |
_starts_with - pipeline_method
|
Starts with criteria |
Example
{
"_eq": "UNSPECIFIED",
"_lte": "UNSPECIFIED",
"_gte": "UNSPECIFIED",
"_gt": "UNSPECIFIED",
"_lt": "UNSPECIFIED",
"_starts_with": "UNSPECIFIED"
}
pl_pipeline_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity pl_pipeline
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
pl_pipeline_name_criteria
Description
Criteria expression specification of name attribute in entity pl_pipeline
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
pl_pipeline_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
replicatedFrom - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
queryCount - order_by_enum
|
The pipeline query count |
nameLower - order_by_enum
|
Lowercase representation of the name |
topicCount - order_by_enum
|
The pipeline topic count |
id - order_by_enum
|
The pipeline id |
streamCount - order_by_enum
|
The pipeline stream count |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
owner - order_by_enum
|
|
updatedBy - order_by_enum
|
The pipeline updater |
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
method - order_by_enum
|
The method_name |
qualifiedName - order_by_enum
|
|
tableCount - order_by_enum
|
The pipeline table count |
activateTime - order_by_enum
|
The activate time |
updateTime - order_by_enum
|
The update time |
connectorCount - order_by_enum
|
The pipeline connector count |
activatedBy - order_by_enum
|
The pipeline activator |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
createdBy - order_by_enum
|
The pipeline creator |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
status - order_by_enum
|
The pipeline state |
Example
{
"replicatedFrom": "asc",
"displayName": "asc",
"description": "asc",
"queryCount": "asc",
"nameLower": "asc",
"topicCount": "asc",
"id": "asc",
"streamCount": "asc",
"deprecatedTime": "asc",
"tenant": "asc",
"owner": "asc",
"updatedBy": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"method": "asc",
"qualifiedName": "asc",
"tableCount": "asc",
"activateTime": "asc",
"updateTime": "asc",
"connectorCount": "asc",
"activatedBy": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"createdBy": "asc",
"name": "asc",
"doc": "asc",
"status": "asc"
}
pl_pipeline_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity pl_pipeline
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
pl_pipeline_owner_criteria
Description
Criteria expression specification of owner attribute in entity pl_pipeline
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
pl_pipeline_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity pl_pipeline
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
pl_pipeline_queryCount_criteria
Description
Criteria expression specification of queryCount attribute in entity pl_pipeline
Example
{"_eq": 123, "_lte": 987, "_gte": 987, "_gt": 123, "_lt": 987}
pl_pipeline_status_criteria
Description
Criteria expression specification of status attribute in entity pl_pipeline
Fields
| Input Field | Description |
|---|---|
_eq - pipeline_status
|
Equals criteria |
_lte - pipeline_status
|
Less than or equals criteria |
_gte - pipeline_status
|
Greater or equals criteria |
_gt - pipeline_status
|
Greater than criteria |
_lt - pipeline_status
|
Less than criteria |
_starts_with - pipeline_status
|
Starts with criteria |
Example
{
"_eq": "UNSPECIFIED",
"_lte": "UNSPECIFIED",
"_gte": "UNSPECIFIED",
"_gt": "UNSPECIFIED",
"_lt": "UNSPECIFIED",
"_starts_with": "UNSPECIFIED"
}
pl_pipeline_streamCount_criteria
Description
Criteria expression specification of streamCount attribute in entity pl_pipeline
Example
{"_eq": 123, "_lte": 987, "_gte": 987, "_gt": 987, "_lt": 123}
pl_pipeline_tableCount_criteria
Description
Criteria expression specification of tableCount attribute in entity pl_pipeline
Example
{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 987}
pl_pipeline_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity pl_pipeline
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
pl_pipeline_topicCount_criteria
Description
Criteria expression specification of topicCount attribute in entity pl_pipeline
Example
{"_eq": 123, "_lte": 987, "_gte": 987, "_gt": 123, "_lt": 123}
pl_pipeline_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity pl_pipeline
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"
}
pl_pipeline_updatedBy_criteria
Description
Criteria expression specification of updatedBy attribute in entity pl_pipeline
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
pl_pipeline_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity pl_pipeline
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
schema_rule_kind
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"UNSPECIFIED"
schema_rule_mode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNSPECIFIED"
since_enum
Description
Specifies the enum for a since query
Values
| Enum Value | Description |
|---|---|
|
|
Last 7 days |
|
|
Last 30 days |
|
|
Last month |
|
|
This month |
|
|
Today |
|
|
Yesterday |
|
|
This year |
|
|
Last year |
|
|
This quarter |
|
|
Last quarter |
|
|
Last 3 months |
|
|
Last 6 months |
|
|
Last 12 months |
Example
"last_7_days"
sr_array
Description
Type representing an array datatype
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
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
type - sr_type
|
The array type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"doc": "xyz789",
"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,
"type": sr_type,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["xyz789"]
}
sr_array_context_criteria
Description
Criteria expression specification of context attribute in entity sr_array
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_array_count
Description
Type representing an array datatype
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
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
type - sr_type
|
The array type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"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": ["abc123"],
"entity_count": 987
}
sr_array_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_array
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"
}
sr_array_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_array_criteria]
|
Logical operation for expressions |
_and - [sr_array_criteria]
|
Logical operation for expressions |
owner - sr_array_owner_criteria
|
|
userDescription - sr_array_userDescription_criteria
|
|
qualifiedName - sr_array_qualifiedName_criteria
|
|
displayName - sr_array_displayName_criteria
|
|
description - sr_array_description_criteria
|
|
updateTime - sr_array_updateTime_criteria
|
The update time |
nameLower - sr_array_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_array_ownerEmail_criteria
|
|
default - sr_array_default_criteria
|
The type default |
createTime - sr_array_createTime_criteria
|
The create time |
name - sr_array_name_criteria
|
|
context - sr_array_context_criteria
|
The schema context |
doc - sr_array_doc_criteria
|
Documentation |
id - sr_array_id_criteria
|
The schema id |
deprecatedTime - sr_array_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_array_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_array_criteria],
"_and": [sr_array_criteria],
"owner": sr_array_owner_criteria,
"userDescription": sr_array_userDescription_criteria,
"qualifiedName": sr_array_qualifiedName_criteria,
"displayName": sr_array_displayName_criteria,
"description": sr_array_description_criteria,
"updateTime": sr_array_updateTime_criteria,
"nameLower": sr_array_nameLower_criteria,
"ownerEmail": sr_array_ownerEmail_criteria,
"default": sr_array_default_criteria,
"createTime": sr_array_createTime_criteria,
"name": sr_array_name_criteria,
"context": sr_array_context_criteria,
"doc": sr_array_doc_criteria,
"id": sr_array_id_criteria,
"deprecatedTime": sr_array_deprecatedTime_criteria,
"tenant": sr_array_tenant_criteria
}
sr_array_default_criteria
Description
Criteria expression specification of default attribute in entity sr_array
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_array_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_array
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"
}
sr_array_description_criteria
Description
Criteria expression specification of description attribute in entity sr_array
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_array_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_array
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_array_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_array
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_array_id_criteria
Description
Criteria expression specification of id attribute in entity sr_array
Example
{"_eq": 987, "_lte": 123, "_gte": 123, "_gt": 123, "_lt": 123}
sr_array_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_array
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_array_name_criteria
Description
Criteria expression specification of name attribute in entity sr_array
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_array_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The type default |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"default": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_array_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_array
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_array_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_array
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_array_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_array
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_array_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_array
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_array_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_array
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"
}
sr_array_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_array
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_combined
Description
Type representing a combined datatype
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
kind - String
|
The combined kind |
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
ownerEmail - String
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
types - [sr_type]
|
The types in the combined type |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"kind": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"default": "xyz789",
"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,
"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": ["xyz789"]
}
sr_combined_context_criteria
Description
Criteria expression specification of context attribute in entity sr_combined
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_combined_count
Description
Type representing a combined datatype
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
kind - String
|
The combined kind |
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
ownerEmail - String
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
types - [sr_type]
|
The types in the combined type |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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": "abc123",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"kind": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"doc": "xyz789",
"id": 987,
"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": ["xyz789"],
"entity_count": 987
}
sr_combined_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_combined
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"
}
sr_combined_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
Example
{
"_or": [sr_combined_criteria],
"_and": [sr_combined_criteria],
"owner": sr_combined_owner_criteria,
"userDescription": sr_combined_userDescription_criteria,
"qualifiedName": sr_combined_qualifiedName_criteria,
"displayName": sr_combined_displayName_criteria,
"kind": sr_combined_kind_criteria,
"description": sr_combined_description_criteria,
"updateTime": sr_combined_updateTime_criteria,
"nameLower": sr_combined_nameLower_criteria,
"ownerEmail": sr_combined_ownerEmail_criteria,
"default": sr_combined_default_criteria,
"createTime": sr_combined_createTime_criteria,
"name": sr_combined_name_criteria,
"context": sr_combined_context_criteria,
"doc": sr_combined_doc_criteria,
"id": sr_combined_id_criteria,
"deprecatedTime": sr_combined_deprecatedTime_criteria,
"tenant": sr_combined_tenant_criteria
}
sr_combined_default_criteria
Description
Criteria expression specification of default attribute in entity sr_combined
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_combined_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_combined
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"
}
sr_combined_description_criteria
Description
Criteria expression specification of description attribute in entity sr_combined
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_combined_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_combined
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_combined_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_combined
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_combined_id_criteria
Description
Criteria expression specification of id attribute in entity sr_combined
Example
{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 987}
sr_combined_kind_criteria
Description
Criteria expression specification of kind attribute in entity sr_combined
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_combined_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_combined
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_combined_name_criteria
Description
Criteria expression specification of name attribute in entity sr_combined
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_combined_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
kind - order_by_enum
|
The combined kind |
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The type default |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"kind": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"default": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_combined_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_combined
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_combined_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_combined
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_combined_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_combined
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_combined_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_combined
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_combined_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_combined
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"
}
sr_combined_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_combined
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_entity
Description
Type representing a Schema Registry 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
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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
| sr_entity Types |
|---|
Example
{
"owner": "abc123",
"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",
"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"]
}
sr_entity_context_criteria
Description
Criteria expression specification of context attribute in entity sr_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_entity_count
Description
Type representing a Schema Registry 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
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"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"],
"entity_count": 123
}
sr_entity_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_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"
}
sr_entity_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_entity_criteria]
|
Logical operation for expressions |
_and - [sr_entity_criteria]
|
Logical operation for expressions |
owner - sr_entity_owner_criteria
|
|
userDescription - sr_entity_userDescription_criteria
|
|
qualifiedName - sr_entity_qualifiedName_criteria
|
|
displayName - sr_entity_displayName_criteria
|
|
description - sr_entity_description_criteria
|
|
updateTime - sr_entity_updateTime_criteria
|
The update time |
nameLower - sr_entity_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_entity_ownerEmail_criteria
|
|
createTime - sr_entity_createTime_criteria
|
The create time |
name - sr_entity_name_criteria
|
|
context - sr_entity_context_criteria
|
The schema context |
doc - sr_entity_doc_criteria
|
Documentation |
id - sr_entity_id_criteria
|
The schema id |
deprecatedTime - sr_entity_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_entity_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_entity_criteria],
"_and": [sr_entity_criteria],
"owner": sr_entity_owner_criteria,
"userDescription": sr_entity_userDescription_criteria,
"qualifiedName": sr_entity_qualifiedName_criteria,
"displayName": sr_entity_displayName_criteria,
"description": sr_entity_description_criteria,
"updateTime": sr_entity_updateTime_criteria,
"nameLower": sr_entity_nameLower_criteria,
"ownerEmail": sr_entity_ownerEmail_criteria,
"createTime": sr_entity_createTime_criteria,
"name": sr_entity_name_criteria,
"context": sr_entity_context_criteria,
"doc": sr_entity_doc_criteria,
"id": sr_entity_id_criteria,
"deprecatedTime": sr_entity_deprecatedTime_criteria,
"tenant": sr_entity_tenant_criteria
}
sr_entity_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_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"
}
sr_entity_description_criteria
Description
Criteria expression specification of description attribute in entity sr_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_entity_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_entity
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_entity_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_entity
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_entity_id_criteria
Description
Criteria expression specification of id attribute in entity sr_entity
Example
{"_eq": 987, "_lte": 987, "_gte": 987, "_gt": 123, "_lt": 987}
sr_entity_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_entity
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_entity_name_criteria
Description
Criteria expression specification of name attribute in entity sr_entity
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_entity_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_entity_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_entity_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_entity_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_entity
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_entity_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_entity
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_entity_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_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"
}
sr_entity_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_entity
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_enum
Description
Type representing an enum datatype
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
aliases - [String]
|
The enum aliases |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
symbols - [String]
|
The enum symbols |
ownerEmail - String
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
namespace - String
|
The enum namespace |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"aliases": ["abc123"],
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"symbols": ["abc123"],
"ownerEmail": "abc123",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"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": ["xyz789"]
}
sr_enum_context_criteria
Description
Criteria expression specification of context attribute in entity sr_enum
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_enum_count
Description
Type representing an enum datatype
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
aliases - [String]
|
The enum aliases |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
symbols - [String]
|
The enum symbols |
ownerEmail - String
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
namespace - String
|
The enum namespace |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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": "abc123",
"aliases": ["xyz789"],
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"symbols": ["xyz789"],
"ownerEmail": "xyz789",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"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,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["xyz789"],
"entity_count": 987
}
sr_enum_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_enum
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"
}
sr_enum_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_enum_criteria]
|
Logical operation for expressions |
_and - [sr_enum_criteria]
|
Logical operation for expressions |
owner - sr_enum_owner_criteria
|
|
userDescription - sr_enum_userDescription_criteria
|
|
qualifiedName - sr_enum_qualifiedName_criteria
|
|
displayName - sr_enum_displayName_criteria
|
|
description - sr_enum_description_criteria
|
|
updateTime - sr_enum_updateTime_criteria
|
The update time |
nameLower - sr_enum_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_enum_ownerEmail_criteria
|
|
default - sr_enum_default_criteria
|
The type default |
createTime - sr_enum_createTime_criteria
|
The create time |
name - sr_enum_name_criteria
|
|
context - sr_enum_context_criteria
|
The schema context |
namespace - sr_enum_namespace_criteria
|
The enum namespace |
doc - sr_enum_doc_criteria
|
Documentation |
id - sr_enum_id_criteria
|
The schema id |
deprecatedTime - sr_enum_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_enum_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_enum_criteria],
"_and": [sr_enum_criteria],
"owner": sr_enum_owner_criteria,
"userDescription": sr_enum_userDescription_criteria,
"qualifiedName": sr_enum_qualifiedName_criteria,
"displayName": sr_enum_displayName_criteria,
"description": sr_enum_description_criteria,
"updateTime": sr_enum_updateTime_criteria,
"nameLower": sr_enum_nameLower_criteria,
"ownerEmail": sr_enum_ownerEmail_criteria,
"default": sr_enum_default_criteria,
"createTime": sr_enum_createTime_criteria,
"name": sr_enum_name_criteria,
"context": sr_enum_context_criteria,
"namespace": sr_enum_namespace_criteria,
"doc": sr_enum_doc_criteria,
"id": sr_enum_id_criteria,
"deprecatedTime": sr_enum_deprecatedTime_criteria,
"tenant": sr_enum_tenant_criteria
}
sr_enum_default_criteria
Description
Criteria expression specification of default attribute in entity sr_enum
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_enum_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_enum
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"
}
sr_enum_description_criteria
Description
Criteria expression specification of description attribute in entity sr_enum
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_enum_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_enum
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_enum_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_enum
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_enum_id_criteria
Description
Criteria expression specification of id attribute in entity sr_enum
Example
{"_eq": 123, "_lte": 123, "_gte": 987, "_gt": 987, "_lt": 123}
sr_enum_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_enum
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_enum_name_criteria
Description
Criteria expression specification of name attribute in entity sr_enum
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_enum_namespace_criteria
Description
Criteria expression specification of namespace attribute in entity sr_enum
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_enum_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
aliases - order_by_enum
|
The enum aliases |
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
symbols - order_by_enum
|
The enum symbols |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The type default |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
namespace - order_by_enum
|
The enum namespace |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"aliases": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"symbols": "asc",
"ownerEmail": "asc",
"default": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"namespace": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_enum_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_enum
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_enum_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_enum
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_enum_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_enum
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_enum_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_enum
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_enum_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_enum
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"
}
sr_enum_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_enum
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_field
Description
Type representing a field
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
aliases - [String]
|
The field aliases |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
label - String
|
The field label |
ownerEmail - String
|
|
default - String
|
The field default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
tag - Int
|
The field tag |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
record - sr_record
|
The record |
Arguments
|
|
type - sr_type
|
The field type |
Arguments
|
|
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"aliases": ["abc123"],
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"label": "xyz789",
"ownerEmail": "xyz789",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"doc": "abc123",
"id": 123,
"tag": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "xyz789",
"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_context_criteria
Description
Criteria expression specification of context attribute in entity sr_field
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_field_count
Description
Type representing a field
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
aliases - [String]
|
The field aliases |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
label - String
|
The field label |
ownerEmail - String
|
|
default - String
|
The field default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
tag - Int
|
The field tag |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
record - sr_record
|
The record |
Arguments
|
|
type - sr_type
|
The field type |
Arguments
|
|
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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",
"aliases": ["xyz789"],
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"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": "abc123",
"doc": "xyz789",
"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": ["abc123"],
"entity_count": 123
}
sr_field_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_field
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"
}
sr_field_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_field_criteria]
|
Logical operation for expressions |
_and - [sr_field_criteria]
|
Logical operation for expressions |
owner - sr_field_owner_criteria
|
|
userDescription - sr_field_userDescription_criteria
|
|
qualifiedName - sr_field_qualifiedName_criteria
|
|
displayName - sr_field_displayName_criteria
|
|
description - sr_field_description_criteria
|
|
updateTime - sr_field_updateTime_criteria
|
The update time |
nameLower - sr_field_nameLower_criteria
|
Lowercase representation of the name |
label - sr_field_label_criteria
|
The field label |
ownerEmail - sr_field_ownerEmail_criteria
|
|
default - sr_field_default_criteria
|
The field default |
createTime - sr_field_createTime_criteria
|
The create time |
name - sr_field_name_criteria
|
|
context - sr_field_context_criteria
|
The schema context |
doc - sr_field_doc_criteria
|
Documentation |
id - sr_field_id_criteria
|
The schema id |
tag - sr_field_tag_criteria
|
The field tag |
deprecatedTime - sr_field_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_field_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_field_criteria],
"_and": [sr_field_criteria],
"owner": sr_field_owner_criteria,
"userDescription": sr_field_userDescription_criteria,
"qualifiedName": sr_field_qualifiedName_criteria,
"displayName": sr_field_displayName_criteria,
"description": sr_field_description_criteria,
"updateTime": sr_field_updateTime_criteria,
"nameLower": sr_field_nameLower_criteria,
"label": sr_field_label_criteria,
"ownerEmail": sr_field_ownerEmail_criteria,
"default": sr_field_default_criteria,
"createTime": sr_field_createTime_criteria,
"name": sr_field_name_criteria,
"context": sr_field_context_criteria,
"doc": sr_field_doc_criteria,
"id": sr_field_id_criteria,
"tag": sr_field_tag_criteria,
"deprecatedTime": sr_field_deprecatedTime_criteria,
"tenant": sr_field_tenant_criteria
}
sr_field_default_criteria
Description
Criteria expression specification of default attribute in entity sr_field
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_field_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_field
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"
}
sr_field_description_criteria
Description
Criteria expression specification of description attribute in entity sr_field
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_field_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_field
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_field_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_field
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_field_id_criteria
Description
Criteria expression specification of id attribute in entity sr_field
Example
{"_eq": 987, "_lte": 123, "_gte": 987, "_gt": 987, "_lt": 123}
sr_field_label_criteria
Description
Criteria expression specification of label attribute in entity sr_field
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_field_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_field
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_field_name_criteria
Description
Criteria expression specification of name attribute in entity sr_field
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_field_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
aliases - order_by_enum
|
The field aliases |
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
label - order_by_enum
|
The field label |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The field default |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
tag - order_by_enum
|
The field tag |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"aliases": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"label": "asc",
"ownerEmail": "asc",
"default": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"tag": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_field_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_field
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_field_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_field
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_field_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_field
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_field_tag_criteria
Description
Criteria expression specification of tag attribute in entity sr_field
Example
{"_eq": 123, "_lte": 123, "_gte": 123, "_gt": 123, "_lt": 987}
sr_field_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_field
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_field_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_field
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"
}
sr_field_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_field
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_fixed
Description
Type representing a fixed datatype
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
aliases - [String]
|
The fixed aliases |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
ownerEmail - String
|
|
default - String
|
The type default |
size - Int
|
The fixed size |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
namespace - String
|
The fixed namespace |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"aliases": ["abc123"],
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"default": "xyz789",
"size": 123,
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"namespace": "xyz789",
"doc": "xyz789",
"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": ["abc123"]
}
sr_fixed_context_criteria
Description
Criteria expression specification of context attribute in entity sr_fixed
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_fixed_count
Description
Type representing a fixed datatype
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
aliases - [String]
|
The fixed aliases |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
ownerEmail - String
|
|
default - String
|
The type default |
size - Int
|
The fixed size |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
namespace - String
|
The fixed namespace |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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",
"aliases": ["xyz789"],
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"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": "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": ["xyz789"],
"entity_count": 123
}
sr_fixed_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_fixed
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"
}
sr_fixed_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_fixed_criteria]
|
Logical operation for expressions |
_and - [sr_fixed_criteria]
|
Logical operation for expressions |
owner - sr_fixed_owner_criteria
|
|
userDescription - sr_fixed_userDescription_criteria
|
|
qualifiedName - sr_fixed_qualifiedName_criteria
|
|
displayName - sr_fixed_displayName_criteria
|
|
description - sr_fixed_description_criteria
|
|
updateTime - sr_fixed_updateTime_criteria
|
The update time |
nameLower - sr_fixed_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_fixed_ownerEmail_criteria
|
|
default - sr_fixed_default_criteria
|
The type default |
size - sr_fixed_size_criteria
|
The fixed size |
createTime - sr_fixed_createTime_criteria
|
The create time |
name - sr_fixed_name_criteria
|
|
context - sr_fixed_context_criteria
|
The schema context |
namespace - sr_fixed_namespace_criteria
|
The fixed namespace |
doc - sr_fixed_doc_criteria
|
Documentation |
id - sr_fixed_id_criteria
|
The schema id |
deprecatedTime - sr_fixed_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_fixed_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_fixed_criteria],
"_and": [sr_fixed_criteria],
"owner": sr_fixed_owner_criteria,
"userDescription": sr_fixed_userDescription_criteria,
"qualifiedName": sr_fixed_qualifiedName_criteria,
"displayName": sr_fixed_displayName_criteria,
"description": sr_fixed_description_criteria,
"updateTime": sr_fixed_updateTime_criteria,
"nameLower": sr_fixed_nameLower_criteria,
"ownerEmail": sr_fixed_ownerEmail_criteria,
"default": sr_fixed_default_criteria,
"size": sr_fixed_size_criteria,
"createTime": sr_fixed_createTime_criteria,
"name": sr_fixed_name_criteria,
"context": sr_fixed_context_criteria,
"namespace": sr_fixed_namespace_criteria,
"doc": sr_fixed_doc_criteria,
"id": sr_fixed_id_criteria,
"deprecatedTime": sr_fixed_deprecatedTime_criteria,
"tenant": sr_fixed_tenant_criteria
}
sr_fixed_default_criteria
Description
Criteria expression specification of default attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_fixed_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_fixed
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"
}
sr_fixed_description_criteria
Description
Criteria expression specification of description attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_fixed_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_fixed
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_fixed_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_fixed_id_criteria
Description
Criteria expression specification of id attribute in entity sr_fixed
Example
{"_eq": 987, "_lte": 123, "_gte": 123, "_gt": 123, "_lt": 123}
sr_fixed_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_fixed_name_criteria
Description
Criteria expression specification of name attribute in entity sr_fixed
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_fixed_namespace_criteria
Description
Criteria expression specification of namespace attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_fixed_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
aliases - order_by_enum
|
The fixed aliases |
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The type default |
size - order_by_enum
|
The fixed size |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
namespace - order_by_enum
|
The fixed namespace |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"aliases": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"default": "asc",
"size": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"namespace": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_fixed_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_fixed_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_fixed
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_fixed_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_fixed_size_criteria
Description
Criteria expression specification of size attribute in entity sr_fixed
Example
{"_eq": 987, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 987}
sr_fixed_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_fixed_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_fixed
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"
}
sr_fixed_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_fixed
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_map
Description
Type representing a map datatype
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
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
value_type - sr_type
|
The value type |
Arguments
|
|
key_type - sr_type
|
The key type |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"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": "xyz789",
"id": 987,
"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": ["abc123"]
}
sr_map_context_criteria
Description
Criteria expression specification of context attribute in entity sr_map
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_map_count
Description
Type representing a map datatype
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
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
value_type - sr_type
|
The value type |
Arguments
|
|
key_type - sr_type
|
The key type |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
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",
"default": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"doc": "abc123",
"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": ["abc123"],
"entity_count": 987
}
sr_map_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_map
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"
}
sr_map_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_map_criteria]
|
Logical operation for expressions |
_and - [sr_map_criteria]
|
Logical operation for expressions |
owner - sr_map_owner_criteria
|
|
userDescription - sr_map_userDescription_criteria
|
|
qualifiedName - sr_map_qualifiedName_criteria
|
|
displayName - sr_map_displayName_criteria
|
|
description - sr_map_description_criteria
|
|
updateTime - sr_map_updateTime_criteria
|
The update time |
nameLower - sr_map_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_map_ownerEmail_criteria
|
|
default - sr_map_default_criteria
|
The type default |
createTime - sr_map_createTime_criteria
|
The create time |
name - sr_map_name_criteria
|
|
context - sr_map_context_criteria
|
The schema context |
doc - sr_map_doc_criteria
|
Documentation |
id - sr_map_id_criteria
|
The schema id |
deprecatedTime - sr_map_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_map_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_map_criteria],
"_and": [sr_map_criteria],
"owner": sr_map_owner_criteria,
"userDescription": sr_map_userDescription_criteria,
"qualifiedName": sr_map_qualifiedName_criteria,
"displayName": sr_map_displayName_criteria,
"description": sr_map_description_criteria,
"updateTime": sr_map_updateTime_criteria,
"nameLower": sr_map_nameLower_criteria,
"ownerEmail": sr_map_ownerEmail_criteria,
"default": sr_map_default_criteria,
"createTime": sr_map_createTime_criteria,
"name": sr_map_name_criteria,
"context": sr_map_context_criteria,
"doc": sr_map_doc_criteria,
"id": sr_map_id_criteria,
"deprecatedTime": sr_map_deprecatedTime_criteria,
"tenant": sr_map_tenant_criteria
}
sr_map_default_criteria
Description
Criteria expression specification of default attribute in entity sr_map
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_map_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_map
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"
}
sr_map_description_criteria
Description
Criteria expression specification of description attribute in entity sr_map
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_map_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_map
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_map_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_map
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_map_id_criteria
Description
Criteria expression specification of id attribute in entity sr_map
Example
{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 123}
sr_map_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_map
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_map_name_criteria
Description
Criteria expression specification of name attribute in entity sr_map
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_map_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The type default |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"default": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_map_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_map
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_map_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_map
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_map_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_map
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_map_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_map
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_map_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_map
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"
}
sr_map_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_map
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_path
Description
An object path that can be tagged
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 |
schema - sr_schema
|
The schema |
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"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": "xyz789",
"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
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 |
schema - sr_schema
|
The schema |
Arguments
|
|
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": "xyz789",
"displayName": "abc123",
"description": "abc123",
"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",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["abc123"],
"entity_count": 123
}
sr_path_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_path
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"
}
sr_path_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_path_criteria]
|
Logical operation for expressions |
_and - [sr_path_criteria]
|
Logical operation for expressions |
owner - sr_path_owner_criteria
|
|
userDescription - sr_path_userDescription_criteria
|
|
qualifiedName - sr_path_qualifiedName_criteria
|
|
displayName - sr_path_displayName_criteria
|
|
description - sr_path_description_criteria
|
|
updateTime - sr_path_updateTime_criteria
|
The update time |
nameLower - sr_path_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_path_ownerEmail_criteria
|
|
createTime - sr_path_createTime_criteria
|
The create time |
name - sr_path_name_criteria
|
|
doc - sr_path_doc_criteria
|
Documentation |
deprecatedTime - sr_path_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_path_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_path_criteria],
"_and": [sr_path_criteria],
"owner": sr_path_owner_criteria,
"userDescription": sr_path_userDescription_criteria,
"qualifiedName": sr_path_qualifiedName_criteria,
"displayName": sr_path_displayName_criteria,
"description": sr_path_description_criteria,
"updateTime": sr_path_updateTime_criteria,
"nameLower": sr_path_nameLower_criteria,
"ownerEmail": sr_path_ownerEmail_criteria,
"createTime": sr_path_createTime_criteria,
"name": sr_path_name_criteria,
"doc": sr_path_doc_criteria,
"deprecatedTime": sr_path_deprecatedTime_criteria,
"tenant": sr_path_tenant_criteria
}
sr_path_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_path
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"
}
sr_path_description_criteria
Description
Criteria expression specification of description attribute in entity sr_path
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_path_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_path
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_path_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_path
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_path_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_path
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_path_name_criteria
Description
Criteria expression specification of name attribute in entity sr_path
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_path_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_path_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_path
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_path_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_path
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_path_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_path
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_path_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_path
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_path_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_path
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"
}
sr_path_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_path
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_primitive
Description
Type representing a primitive datatype
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 |
type - String
|
The primitive type |
ownerEmail - String
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"type": "abc123",
"ownerEmail": "abc123",
"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,
"parent_type": sr_type,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["xyz789"]
}
sr_primitive_context_criteria
Description
Criteria expression specification of context attribute in entity sr_primitive
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_primitive_count
Description
Type representing a primitive datatype
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 |
type - String
|
The primitive type |
ownerEmail - String
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"type": "abc123",
"ownerEmail": "abc123",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"doc": "xyz789",
"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": ["abc123"],
"entity_count": 987
}
sr_primitive_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_primitive
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"
}
sr_primitive_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
Example
{
"_or": [sr_primitive_criteria],
"_and": [sr_primitive_criteria],
"owner": sr_primitive_owner_criteria,
"userDescription": sr_primitive_userDescription_criteria,
"qualifiedName": sr_primitive_qualifiedName_criteria,
"displayName": sr_primitive_displayName_criteria,
"description": sr_primitive_description_criteria,
"updateTime": sr_primitive_updateTime_criteria,
"nameLower": sr_primitive_nameLower_criteria,
"type": sr_primitive_type_criteria,
"ownerEmail": sr_primitive_ownerEmail_criteria,
"default": sr_primitive_default_criteria,
"createTime": sr_primitive_createTime_criteria,
"name": sr_primitive_name_criteria,
"context": sr_primitive_context_criteria,
"doc": sr_primitive_doc_criteria,
"id": sr_primitive_id_criteria,
"deprecatedTime": sr_primitive_deprecatedTime_criteria,
"tenant": sr_primitive_tenant_criteria
}
sr_primitive_default_criteria
Description
Criteria expression specification of default attribute in entity sr_primitive
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_primitive_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_primitive
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"
}
sr_primitive_description_criteria
Description
Criteria expression specification of description attribute in entity sr_primitive
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_primitive_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_primitive
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_primitive_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_primitive
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_primitive_id_criteria
Description
Criteria expression specification of id attribute in entity sr_primitive
Example
{"_eq": 123, "_lte": 123, "_gte": 987, "_gt": 987, "_lt": 123}
sr_primitive_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_primitive
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_primitive_name_criteria
Description
Criteria expression specification of name attribute in entity sr_primitive
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_primitive_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
type - order_by_enum
|
The primitive type |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The type default |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"type": "asc",
"ownerEmail": "asc",
"default": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_primitive_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_primitive
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_primitive_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_primitive
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_primitive_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_primitive
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_primitive_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_primitive
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_primitive_type_criteria
Description
Criteria expression specification of type attribute in entity sr_primitive
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_primitive_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_primitive
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"
}
sr_primitive_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_primitive
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_record
Description
Type representing a record
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
aliases - [String]
|
The record aliases |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
ownerEmail - String
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
namespace - String
|
The record namespace |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
fields - [sr_field]
|
The record fields |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"aliases": ["xyz789"],
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"default": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"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_context_criteria
Description
Criteria expression specification of context attribute in entity sr_record
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_record_count
Description
Type representing a record
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
aliases - [String]
|
The record aliases |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
ownerEmail - String
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
namespace - String
|
The record namespace |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
fields - [sr_field]
|
The record fields |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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",
"aliases": ["xyz789"],
"userDescription": "xyz789",
"qualifiedName": "abc123",
"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",
"namespace": "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,
"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_record_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_record
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"
}
sr_record_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_record_criteria]
|
Logical operation for expressions |
_and - [sr_record_criteria]
|
Logical operation for expressions |
owner - sr_record_owner_criteria
|
|
userDescription - sr_record_userDescription_criteria
|
|
qualifiedName - sr_record_qualifiedName_criteria
|
|
displayName - sr_record_displayName_criteria
|
|
description - sr_record_description_criteria
|
|
updateTime - sr_record_updateTime_criteria
|
The update time |
nameLower - sr_record_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_record_ownerEmail_criteria
|
|
default - sr_record_default_criteria
|
The type default |
createTime - sr_record_createTime_criteria
|
The create time |
name - sr_record_name_criteria
|
|
context - sr_record_context_criteria
|
The schema context |
namespace - sr_record_namespace_criteria
|
The record namespace |
doc - sr_record_doc_criteria
|
Documentation |
id - sr_record_id_criteria
|
The schema id |
deprecatedTime - sr_record_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_record_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_record_criteria],
"_and": [sr_record_criteria],
"owner": sr_record_owner_criteria,
"userDescription": sr_record_userDescription_criteria,
"qualifiedName": sr_record_qualifiedName_criteria,
"displayName": sr_record_displayName_criteria,
"description": sr_record_description_criteria,
"updateTime": sr_record_updateTime_criteria,
"nameLower": sr_record_nameLower_criteria,
"ownerEmail": sr_record_ownerEmail_criteria,
"default": sr_record_default_criteria,
"createTime": sr_record_createTime_criteria,
"name": sr_record_name_criteria,
"context": sr_record_context_criteria,
"namespace": sr_record_namespace_criteria,
"doc": sr_record_doc_criteria,
"id": sr_record_id_criteria,
"deprecatedTime": sr_record_deprecatedTime_criteria,
"tenant": sr_record_tenant_criteria
}
sr_record_default_criteria
Description
Criteria expression specification of default attribute in entity sr_record
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_record_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_record
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"
}
sr_record_description_criteria
Description
Criteria expression specification of description attribute in entity sr_record
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_record_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_record
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_record_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_record
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_record_id_criteria
Description
Criteria expression specification of id attribute in entity sr_record
Example
{"_eq": 123, "_lte": 123, "_gte": 987, "_gt": 123, "_lt": 987}
sr_record_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_record
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_record_name_criteria
Description
Criteria expression specification of name attribute in entity sr_record
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_record_namespace_criteria
Description
Criteria expression specification of namespace attribute in entity sr_record
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_record_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
aliases - order_by_enum
|
The record aliases |
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The type default |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
namespace - order_by_enum
|
The record namespace |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"aliases": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"default": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"namespace": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_record_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_record
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_record_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_record
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_record_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_record
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_record_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_record
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_record_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_record
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"
}
sr_record_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_record
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_rule
Description
A schema rule
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
onError - String
|
The action if the rule fails |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
kind - schema_rule_kind
|
The rule kind |
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
type - String
|
The rule type |
ownerEmail - String
|
|
mode - schema_rule_mode
|
The rule mode |
createTime - DateTime
|
The create time |
name - String
|
|
doc - String
|
Documentation |
expr - String
|
The rule body |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
onSuccess - String
|
The action if the rule succeeds |
schema - sr_schema
|
The schema |
Arguments
|
|
parameters - [sr_rule_parameter]
|
The rule parameters |
Arguments
|
|
rule_tags - [sr_rule_tag]
|
The rule tags |
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"onError": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "xyz789",
"kind": "UNSPECIFIED",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"type": "xyz789",
"ownerEmail": "abc123",
"mode": "UNSPECIFIED",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"expr": "abc123",
"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": ["abc123"]
}
sr_rule_count
Description
A schema rule
Fields
| Field Name | Description |
|---|---|
owner - String
|
|
onError - String
|
The action if the rule fails |
userDescription - String
|
|
qualifiedName - String
|
|
displayName - String
|
|
kind - schema_rule_kind
|
The rule kind |
description - String
|
|
updateTime - DateTime
|
The update time |
nameLower - String
|
Lowercase representation of the name |
type - String
|
The rule type |
ownerEmail - String
|
|
mode - schema_rule_mode
|
The rule mode |
createTime - DateTime
|
The create time |
name - String
|
|
doc - String
|
Documentation |
expr - String
|
The rule body |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
onSuccess - String
|
The action if the rule succeeds |
schema - sr_schema
|
The schema |
Arguments
|
|
parameters - [sr_rule_parameter]
|
The rule parameters |
Arguments
|
|
rule_tags - [sr_rule_tag]
|
The rule tags |
Arguments
|
|
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": "abc123",
"onError": "abc123",
"userDescription": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"kind": "UNSPECIFIED",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"type": "xyz789",
"ownerEmail": "abc123",
"mode": "UNSPECIFIED",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"doc": "xyz789",
"expr": "xyz789",
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"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"],
"entity_count": 123
}
sr_rule_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_rule
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"
}
sr_rule_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_rule_criteria]
|
Logical operation for expressions |
_and - [sr_rule_criteria]
|
Logical operation for expressions |
owner - sr_rule_owner_criteria
|
|
onError - sr_rule_onError_criteria
|
The action if the rule fails |
userDescription - sr_rule_userDescription_criteria
|
|
qualifiedName - sr_rule_qualifiedName_criteria
|
|
displayName - sr_rule_displayName_criteria
|
|
kind - sr_rule_kind_criteria
|
The rule kind |
description - sr_rule_description_criteria
|
|
updateTime - sr_rule_updateTime_criteria
|
The update time |
nameLower - sr_rule_nameLower_criteria
|
Lowercase representation of the name |
type - sr_rule_type_criteria
|
The rule type |
ownerEmail - sr_rule_ownerEmail_criteria
|
|
mode - sr_rule_mode_criteria
|
The rule mode |
createTime - sr_rule_createTime_criteria
|
The create time |
name - sr_rule_name_criteria
|
|
doc - sr_rule_doc_criteria
|
Documentation |
expr - sr_rule_expr_criteria
|
The rule body |
deprecatedTime - sr_rule_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_rule_tenant_criteria
|
The tenant |
onSuccess - sr_rule_onSuccess_criteria
|
The action if the rule succeeds |
Example
{
"_or": [sr_rule_criteria],
"_and": [sr_rule_criteria],
"owner": sr_rule_owner_criteria,
"onError": sr_rule_onError_criteria,
"userDescription": sr_rule_userDescription_criteria,
"qualifiedName": sr_rule_qualifiedName_criteria,
"displayName": sr_rule_displayName_criteria,
"kind": sr_rule_kind_criteria,
"description": sr_rule_description_criteria,
"updateTime": sr_rule_updateTime_criteria,
"nameLower": sr_rule_nameLower_criteria,
"type": sr_rule_type_criteria,
"ownerEmail": sr_rule_ownerEmail_criteria,
"mode": sr_rule_mode_criteria,
"createTime": sr_rule_createTime_criteria,
"name": sr_rule_name_criteria,
"doc": sr_rule_doc_criteria,
"expr": sr_rule_expr_criteria,
"deprecatedTime": sr_rule_deprecatedTime_criteria,
"tenant": sr_rule_tenant_criteria,
"onSuccess": sr_rule_onSuccess_criteria
}
sr_rule_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_rule
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"
}
sr_rule_description_criteria
Description
Criteria expression specification of description attribute in entity sr_rule
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_rule
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_rule
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_expr_criteria
Description
Criteria expression specification of expr attribute in entity sr_rule
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_kind_criteria
Description
Criteria expression specification of kind attribute in entity sr_rule
Fields
| Input Field | Description |
|---|---|
_eq - schema_rule_kind
|
Equals criteria |
_lte - schema_rule_kind
|
Less than or equals criteria |
_gte - schema_rule_kind
|
Greater or equals criteria |
_gt - schema_rule_kind
|
Greater than criteria |
_lt - schema_rule_kind
|
Less than criteria |
_starts_with - schema_rule_kind
|
Starts with criteria |
Example
{
"_eq": "UNSPECIFIED",
"_lte": "UNSPECIFIED",
"_gte": "UNSPECIFIED",
"_gt": "UNSPECIFIED",
"_lt": "UNSPECIFIED",
"_starts_with": "UNSPECIFIED"
}
sr_rule_mode_criteria
Description
Criteria expression specification of mode attribute in entity sr_rule
Fields
| Input Field | Description |
|---|---|
_eq - schema_rule_mode
|
Equals criteria |
_lte - schema_rule_mode
|
Less than or equals criteria |
_gte - schema_rule_mode
|
Greater or equals criteria |
_gt - schema_rule_mode
|
Greater than criteria |
_lt - schema_rule_mode
|
Less than criteria |
_starts_with - schema_rule_mode
|
Starts with criteria |
Example
{
"_eq": "UNSPECIFIED",
"_lte": "UNSPECIFIED",
"_gte": "UNSPECIFIED",
"_gt": "UNSPECIFIED",
"_lt": "UNSPECIFIED",
"_starts_with": "UNSPECIFIED"
}
sr_rule_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_rule
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_name_criteria
Description
Criteria expression specification of name attribute in entity sr_rule
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_onError_criteria
Description
Criteria expression specification of onError attribute in entity sr_rule
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_onSuccess_criteria
Description
Criteria expression specification of onSuccess attribute in entity sr_rule
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_rule_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
onError - order_by_enum
|
The action if the rule fails |
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
kind - order_by_enum
|
The rule kind |
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
type - order_by_enum
|
The rule type |
ownerEmail - order_by_enum
|
|
mode - order_by_enum
|
The rule mode |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
doc - order_by_enum
|
Documentation |
expr - order_by_enum
|
The rule body |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
onSuccess - order_by_enum
|
The action if the rule succeeds |
Example
{
"owner": "asc",
"onError": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"kind": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"type": "asc",
"ownerEmail": "asc",
"mode": "asc",
"createTime": "asc",
"name": "asc",
"doc": "asc",
"expr": "asc",
"deprecatedTime": "asc",
"tenant": "asc",
"onSuccess": "asc"
}
sr_rule_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_rule
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_rule
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_parameter
Description
Type representing a rule parameter
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
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
value - String
|
The parameter value |
tenant - String
|
The tenant |
rule - sr_rule
|
The rule |
Arguments
|
|
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"value": "abc123",
"tenant": "abc123",
"rule": sr_rule,
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["xyz789"]
}
sr_rule_parameter_context_criteria
Description
Criteria expression specification of context attribute in entity sr_rule_parameter
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_parameter_count
Description
Type representing a rule parameter
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
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
value - String
|
The parameter value |
tenant - String
|
The tenant |
rule - sr_rule
|
The rule |
Arguments
|
|
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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": "abc123",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"doc": "xyz789",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"value": "xyz789",
"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_parameter_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_rule_parameter
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"
}
sr_rule_parameter_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
Example
{
"_or": [sr_rule_parameter_criteria],
"_and": [sr_rule_parameter_criteria],
"owner": sr_rule_parameter_owner_criteria,
"userDescription": sr_rule_parameter_userDescription_criteria,
"qualifiedName": sr_rule_parameter_qualifiedName_criteria,
"displayName": sr_rule_parameter_displayName_criteria,
"description": sr_rule_parameter_description_criteria,
"updateTime": sr_rule_parameter_updateTime_criteria,
"nameLower": sr_rule_parameter_nameLower_criteria,
"ownerEmail": sr_rule_parameter_ownerEmail_criteria,
"createTime": sr_rule_parameter_createTime_criteria,
"name": sr_rule_parameter_name_criteria,
"context": sr_rule_parameter_context_criteria,
"doc": sr_rule_parameter_doc_criteria,
"id": sr_rule_parameter_id_criteria,
"deprecatedTime": sr_rule_parameter_deprecatedTime_criteria,
"value": sr_rule_parameter_value_criteria,
"tenant": sr_rule_parameter_tenant_criteria
}
sr_rule_parameter_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_rule_parameter
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"
}
sr_rule_parameter_description_criteria
Description
Criteria expression specification of description attribute in entity sr_rule_parameter
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_parameter_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_rule_parameter
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_rule_parameter_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_rule_parameter
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_parameter_id_criteria
Description
Criteria expression specification of id attribute in entity sr_rule_parameter
Example
{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 987, "_lt": 987}
sr_rule_parameter_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_rule_parameter
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_parameter_name_criteria
Description
Criteria expression specification of name attribute in entity sr_rule_parameter
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_parameter_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
value - order_by_enum
|
The parameter value |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"value": "asc",
"tenant": "asc"
}
sr_rule_parameter_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_rule_parameter
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_rule_parameter_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_rule_parameter
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_parameter_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_rule_parameter
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_parameter_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_rule_parameter
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_parameter_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_rule_parameter
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"
}
sr_rule_parameter_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_rule_parameter
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_parameter_value_criteria
Description
Criteria expression specification of value attribute in entity sr_rule_parameter
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_rule
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_tag
Description
Type representing a rule tag
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
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
rule - sr_rule
|
The rule |
Arguments
|
|
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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 |
Example
{
"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": "abc123",
"context": "abc123",
"doc": "abc123",
"id": 987,
"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_context_criteria
Description
Criteria expression specification of context attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_tag_count
Description
Type representing a rule tag
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
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
rule - sr_rule
|
The rule |
Arguments
|
|
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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": "abc123",
"qualifiedName": "xyz789",
"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": "xyz789",
"rule": sr_rule,
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["xyz789"],
"entity_count": 123
}
sr_rule_tag_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_rule_tag
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"
}
sr_rule_tag_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_rule_tag_criteria]
|
Logical operation for expressions |
_and - [sr_rule_tag_criteria]
|
Logical operation for expressions |
owner - sr_rule_tag_owner_criteria
|
|
userDescription - sr_rule_tag_userDescription_criteria
|
|
qualifiedName - sr_rule_tag_qualifiedName_criteria
|
|
displayName - sr_rule_tag_displayName_criteria
|
|
description - sr_rule_tag_description_criteria
|
|
updateTime - sr_rule_tag_updateTime_criteria
|
The update time |
nameLower - sr_rule_tag_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_rule_tag_ownerEmail_criteria
|
|
createTime - sr_rule_tag_createTime_criteria
|
The create time |
name - sr_rule_tag_name_criteria
|
|
context - sr_rule_tag_context_criteria
|
The schema context |
doc - sr_rule_tag_doc_criteria
|
Documentation |
id - sr_rule_tag_id_criteria
|
The schema id |
deprecatedTime - sr_rule_tag_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_rule_tag_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_rule_tag_criteria],
"_and": [sr_rule_tag_criteria],
"owner": sr_rule_tag_owner_criteria,
"userDescription": sr_rule_tag_userDescription_criteria,
"qualifiedName": sr_rule_tag_qualifiedName_criteria,
"displayName": sr_rule_tag_displayName_criteria,
"description": sr_rule_tag_description_criteria,
"updateTime": sr_rule_tag_updateTime_criteria,
"nameLower": sr_rule_tag_nameLower_criteria,
"ownerEmail": sr_rule_tag_ownerEmail_criteria,
"createTime": sr_rule_tag_createTime_criteria,
"name": sr_rule_tag_name_criteria,
"context": sr_rule_tag_context_criteria,
"doc": sr_rule_tag_doc_criteria,
"id": sr_rule_tag_id_criteria,
"deprecatedTime": sr_rule_tag_deprecatedTime_criteria,
"tenant": sr_rule_tag_tenant_criteria
}
sr_rule_tag_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_rule_tag
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"
}
sr_rule_tag_description_criteria
Description
Criteria expression specification of description attribute in entity sr_rule_tag
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_tag_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_tag_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_tag_id_criteria
Description
Criteria expression specification of id attribute in entity sr_rule_tag
Example
{"_eq": 123, "_lte": 987, "_gte": 123, "_gt": 123, "_lt": 123}
sr_rule_tag_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_tag_name_criteria
Description
Criteria expression specification of name attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_rule_tag_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_rule_tag_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_tag_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_tag_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_tag_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_rule_tag
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_rule_tag_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_rule_tag
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"
}
sr_rule_tag_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_rule_tag
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_rule
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_rule_type_criteria
Description
Criteria expression specification of type attribute in entity sr_rule
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_rule_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_rule
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"
}
sr_rule_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_rule
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_schema
Description
Type representing a schema namespace
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 |
sensitive - [String]
|
The names of sensitive properties |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
schemaType - String
|
The schema type |
namespace - String
|
The schema namespace |
doc - String
|
Documentation |
embeddedTags - [String]
|
The embedded tags for the schema |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
types - [sr_type]
|
The schema types |
Arguments
|
|
paths - [sr_path]
|
The object paths in the schema |
Arguments
|
|
subject_versions - [sr_subject_version]
|
The subject versions |
Arguments
|
|
migration_rules - [sr_rule]
|
The migration rules for the schema |
Arguments
|
|
properties - [sr_schema_property]
|
The schema properties |
Arguments
|
|
domain_rules - [sr_rule]
|
The domain rules for the schema |
Arguments
|
|
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"sensitive": ["xyz789"],
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "abc123",
"schemaType": "abc123",
"namespace": "xyz789",
"doc": "abc123",
"embeddedTags": ["abc123"],
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"tenant": "abc123",
"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"]
}
sr_schema_context_criteria
Description
Criteria expression specification of context attribute in entity sr_schema
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_count
Description
Type representing a schema namespace
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 |
sensitive - [String]
|
The names of sensitive properties |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
schemaType - String
|
The schema type |
namespace - String
|
The schema namespace |
doc - String
|
Documentation |
embeddedTags - [String]
|
The embedded tags for the schema |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
types - [sr_type]
|
The schema types |
Arguments
|
|
paths - [sr_path]
|
The object paths in the schema |
Arguments
|
|
subject_versions - [sr_subject_version]
|
The subject versions |
Arguments
|
|
migration_rules - [sr_rule]
|
The migration rules for the schema |
Arguments
|
|
properties - [sr_schema_property]
|
The schema properties |
Arguments
|
|
domain_rules - [sr_rule]
|
The domain rules for the schema |
Arguments
|
|
schema - sr_schema
|
Schema for the entity |
Arguments
|
|
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": "abc123",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"sensitive": ["abc123"],
"ownerEmail": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"name": "xyz789",
"context": "xyz789",
"schemaType": "xyz789",
"namespace": "xyz789",
"doc": "xyz789",
"embeddedTags": ["abc123"],
"id": 123,
"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"],
"entity_count": 123
}
sr_schema_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_schema
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"
}
sr_schema_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_schema_criteria]
|
Logical operation for expressions |
_and - [sr_schema_criteria]
|
Logical operation for expressions |
owner - sr_schema_owner_criteria
|
|
userDescription - sr_schema_userDescription_criteria
|
|
qualifiedName - sr_schema_qualifiedName_criteria
|
|
displayName - sr_schema_displayName_criteria
|
|
description - sr_schema_description_criteria
|
|
updateTime - sr_schema_updateTime_criteria
|
The update time |
nameLower - sr_schema_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_schema_ownerEmail_criteria
|
|
createTime - sr_schema_createTime_criteria
|
The create time |
name - sr_schema_name_criteria
|
|
context - sr_schema_context_criteria
|
The schema context |
schemaType - sr_schema_schemaType_criteria
|
The schema type |
namespace - sr_schema_namespace_criteria
|
The schema namespace |
doc - sr_schema_doc_criteria
|
Documentation |
id - sr_schema_id_criteria
|
The schema id |
deprecatedTime - sr_schema_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_schema_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_schema_criteria],
"_and": [sr_schema_criteria],
"owner": sr_schema_owner_criteria,
"userDescription": sr_schema_userDescription_criteria,
"qualifiedName": sr_schema_qualifiedName_criteria,
"displayName": sr_schema_displayName_criteria,
"description": sr_schema_description_criteria,
"updateTime": sr_schema_updateTime_criteria,
"nameLower": sr_schema_nameLower_criteria,
"ownerEmail": sr_schema_ownerEmail_criteria,
"createTime": sr_schema_createTime_criteria,
"name": sr_schema_name_criteria,
"context": sr_schema_context_criteria,
"schemaType": sr_schema_schemaType_criteria,
"namespace": sr_schema_namespace_criteria,
"doc": sr_schema_doc_criteria,
"id": sr_schema_id_criteria,
"deprecatedTime": sr_schema_deprecatedTime_criteria,
"tenant": sr_schema_tenant_criteria
}
sr_schema_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_schema
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"
}
sr_schema_description_criteria
Description
Criteria expression specification of description attribute in entity sr_schema
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_schema_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_schema
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_schema_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_schema
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_schema_id_criteria
Description
Criteria expression specification of id attribute in entity sr_schema
Example
{"_eq": 987, "_lte": 987, "_gte": 123, "_gt": 987, "_lt": 123}
sr_schema_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_schema
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_schema_name_criteria
Description
Criteria expression specification of name attribute in entity sr_schema
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_namespace_criteria
Description
Criteria expression specification of namespace attribute in entity sr_schema
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_schema_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
sensitive - order_by_enum
|
The names of sensitive properties |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
schemaType - order_by_enum
|
The schema type |
namespace - order_by_enum
|
The schema namespace |
doc - order_by_enum
|
Documentation |
embeddedTags - order_by_enum
|
The embedded tags for the schema |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"sensitive": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"schemaType": "asc",
"namespace": "asc",
"doc": "asc",
"embeddedTags": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_schema_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_schema
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_schema_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_schema
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_schema_property
Description
Type representing a schema property
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
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
value - String
|
The property value |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
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 |
Example
{
"owner": "abc123",
"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": "xyz789",
"context": "xyz789",
"doc": "abc123",
"id": 123,
"deprecatedTime": "2007-12-03T10:15:30Z",
"value": "abc123",
"tenant": "xyz789",
"schema": sr_schema,
"tag_defs": [tag_def],
"entity_status": "active",
"business_metadata": [business_metadata_attribute],
"tags": ["abc123"]
}
sr_schema_property_context_criteria
Description
Criteria expression specification of context attribute in entity sr_schema_property
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_property_count
Description
Type representing a schema property
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
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
value - String
|
The property value |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
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": "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",
"context": "abc123",
"doc": "xyz789",
"id": 987,
"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": ["abc123"],
"entity_count": 987
}
sr_schema_property_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_schema_property
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"
}
sr_schema_property_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
Example
{
"_or": [sr_schema_property_criteria],
"_and": [sr_schema_property_criteria],
"owner": sr_schema_property_owner_criteria,
"userDescription": sr_schema_property_userDescription_criteria,
"qualifiedName": sr_schema_property_qualifiedName_criteria,
"displayName": sr_schema_property_displayName_criteria,
"description": sr_schema_property_description_criteria,
"updateTime": sr_schema_property_updateTime_criteria,
"nameLower": sr_schema_property_nameLower_criteria,
"ownerEmail": sr_schema_property_ownerEmail_criteria,
"createTime": sr_schema_property_createTime_criteria,
"name": sr_schema_property_name_criteria,
"context": sr_schema_property_context_criteria,
"doc": sr_schema_property_doc_criteria,
"id": sr_schema_property_id_criteria,
"deprecatedTime": sr_schema_property_deprecatedTime_criteria,
"value": sr_schema_property_value_criteria,
"tenant": sr_schema_property_tenant_criteria
}
sr_schema_property_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_schema_property
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"
}
sr_schema_property_description_criteria
Description
Criteria expression specification of description attribute in entity sr_schema_property
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_property_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_schema_property
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_property_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_schema_property
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_property_id_criteria
Description
Criteria expression specification of id attribute in entity sr_schema_property
Example
{"_eq": 987, "_lte": 123, "_gte": 987, "_gt": 987, "_lt": 987}
sr_schema_property_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_schema_property
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_property_name_criteria
Description
Criteria expression specification of name attribute in entity sr_schema_property
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_schema_property_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
value - order_by_enum
|
The property value |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"value": "asc",
"tenant": "asc"
}
sr_schema_property_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_schema_property
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_property_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_schema_property
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_schema_property_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_schema_property
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_schema_property_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_schema_property
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_schema_property_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_schema_property
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"
}
sr_schema_property_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_schema_property
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_schema_property_value_criteria
Description
Criteria expression specification of value attribute in entity sr_schema_property
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_schema_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_schema
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_schema_schemaType_criteria
Description
Criteria expression specification of schemaType attribute in entity sr_schema
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_schema_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_schema
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_schema_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_schema
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"
}
sr_schema_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_schema
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_subject_version
Description
Type representing a subject-version
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 |
version - Int
|
The subject version |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
schemaType - String
|
The schema type |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
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 |
Example
{
"owner": "xyz789",
"userDescription": "abc123",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "abc123",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"version": 123,
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "abc123",
"schemaType": "xyz789",
"doc": "abc123",
"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_subject_version_context_criteria
Description
Criteria expression specification of context attribute in entity sr_subject_version
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_subject_version_count
Description
Type representing a subject-version
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 |
version - Int
|
The subject version |
ownerEmail - String
|
|
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
schemaType - String
|
The schema type |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
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": "abc123",
"qualifiedName": "xyz789",
"displayName": "xyz789",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"version": 123,
"ownerEmail": "xyz789",
"createTime": "2007-12-03T10:15:30Z",
"name": "abc123",
"context": "xyz789",
"schemaType": "abc123",
"doc": "abc123",
"id": 987,
"deprecatedTime": "2007-12-03T10:15:30Z",
"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_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_subject_version
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"
}
sr_subject_version_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
Example
{
"_or": [sr_subject_version_criteria],
"_and": [sr_subject_version_criteria],
"owner": sr_subject_version_owner_criteria,
"userDescription": sr_subject_version_userDescription_criteria,
"qualifiedName": sr_subject_version_qualifiedName_criteria,
"displayName": sr_subject_version_displayName_criteria,
"description": sr_subject_version_description_criteria,
"updateTime": sr_subject_version_updateTime_criteria,
"nameLower": sr_subject_version_nameLower_criteria,
"version": sr_subject_version_version_criteria,
"ownerEmail": sr_subject_version_ownerEmail_criteria,
"createTime": sr_subject_version_createTime_criteria,
"name": sr_subject_version_name_criteria,
"context": sr_subject_version_context_criteria,
"schemaType": sr_subject_version_schemaType_criteria,
"doc": sr_subject_version_doc_criteria,
"id": sr_subject_version_id_criteria,
"deprecatedTime": sr_subject_version_deprecatedTime_criteria,
"tenant": sr_subject_version_tenant_criteria
}
sr_subject_version_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_subject_version
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"
}
sr_subject_version_description_criteria
Description
Criteria expression specification of description attribute in entity sr_subject_version
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_subject_version_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_subject_version
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_subject_version_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_subject_version
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_subject_version_id_criteria
Description
Criteria expression specification of id attribute in entity sr_subject_version
Example
{"_eq": 987, "_lte": 987, "_gte": 987, "_gt": 987, "_lt": 123}
sr_subject_version_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_subject_version
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_subject_version_name_criteria
Description
Criteria expression specification of name attribute in entity sr_subject_version
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_subject_version_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
version - order_by_enum
|
The subject version |
ownerEmail - order_by_enum
|
|
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
schemaType - order_by_enum
|
The schema type |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"version": "asc",
"ownerEmail": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"schemaType": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_subject_version_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_subject_version
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_subject_version_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_subject_version
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_subject_version_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_subject_version
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_subject_version_schemaType_criteria
Description
Criteria expression specification of schemaType attribute in entity sr_subject_version
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_subject_version_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_subject_version
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_subject_version_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_subject_version
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"
}
sr_subject_version_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_subject_version
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_subject_version_version_criteria
Description
Criteria expression specification of version attribute in entity sr_subject_version
Example
{"_eq": 987, "_lte": 123, "_gte": 987, "_gt": 987, "_lt": 123}
sr_type
Description
Type representing an abstract type
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
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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
| sr_type Types |
|---|
Example
{
"owner": "xyz789",
"userDescription": "xyz789",
"qualifiedName": "abc123",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "abc123",
"ownerEmail": "abc123",
"default": "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,
"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_type_context_criteria
Description
Criteria expression specification of context attribute in entity sr_type
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_type_count
Description
Type representing an abstract type
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
|
|
default - String
|
The type default |
createTime - DateTime
|
The create time |
name - String
|
|
context - String
|
The schema context |
doc - String
|
Documentation |
id - Int
|
The schema id |
deprecatedTime - DateTime
|
The time when the entity is deprecated |
tenant - String
|
The tenant |
schema - sr_schema
|
The schema |
Arguments
|
|
field - sr_field
|
The field |
Arguments
|
|
array - sr_array
|
The array |
Arguments
|
|
map_value - sr_map
|
The map |
Arguments
|
|
map_key - sr_map
|
The map |
Arguments
|
|
child_types - [sr_type]
|
The child types |
Arguments
|
|
combined - sr_combined
|
The combined type |
Arguments
|
|
parent_type - sr_type
|
The parent type |
Arguments
|
|
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": "abc123",
"userDescription": "xyz789",
"qualifiedName": "xyz789",
"displayName": "abc123",
"description": "xyz789",
"updateTime": "2007-12-03T10:15:30Z",
"nameLower": "xyz789",
"ownerEmail": "xyz789",
"default": "xyz789",
"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,
"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_type_createTime_criteria
Description
Criteria expression specification of createTime attribute in entity sr_type
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"
}
sr_type_criteria
Description
Where logical specification of the provided list of criteria expressions
Fields
| Input Field | Description |
|---|---|
_or - [sr_type_criteria]
|
Logical operation for expressions |
_and - [sr_type_criteria]
|
Logical operation for expressions |
owner - sr_type_owner_criteria
|
|
userDescription - sr_type_userDescription_criteria
|
|
qualifiedName - sr_type_qualifiedName_criteria
|
|
displayName - sr_type_displayName_criteria
|
|
description - sr_type_description_criteria
|
|
updateTime - sr_type_updateTime_criteria
|
The update time |
nameLower - sr_type_nameLower_criteria
|
Lowercase representation of the name |
ownerEmail - sr_type_ownerEmail_criteria
|
|
default - sr_type_default_criteria
|
The type default |
createTime - sr_type_createTime_criteria
|
The create time |
name - sr_type_name_criteria
|
|
context - sr_type_context_criteria
|
The schema context |
doc - sr_type_doc_criteria
|
Documentation |
id - sr_type_id_criteria
|
The schema id |
deprecatedTime - sr_type_deprecatedTime_criteria
|
The time when the entity is deprecated |
tenant - sr_type_tenant_criteria
|
The tenant |
Example
{
"_or": [sr_type_criteria],
"_and": [sr_type_criteria],
"owner": sr_type_owner_criteria,
"userDescription": sr_type_userDescription_criteria,
"qualifiedName": sr_type_qualifiedName_criteria,
"displayName": sr_type_displayName_criteria,
"description": sr_type_description_criteria,
"updateTime": sr_type_updateTime_criteria,
"nameLower": sr_type_nameLower_criteria,
"ownerEmail": sr_type_ownerEmail_criteria,
"default": sr_type_default_criteria,
"createTime": sr_type_createTime_criteria,
"name": sr_type_name_criteria,
"context": sr_type_context_criteria,
"doc": sr_type_doc_criteria,
"id": sr_type_id_criteria,
"deprecatedTime": sr_type_deprecatedTime_criteria,
"tenant": sr_type_tenant_criteria
}
sr_type_default_criteria
Description
Criteria expression specification of default attribute in entity sr_type
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_type_deprecatedTime_criteria
Description
Criteria expression specification of deprecatedTime attribute in entity sr_type
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"
}
sr_type_description_criteria
Description
Criteria expression specification of description attribute in entity sr_type
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "xyz789"
}
sr_type_displayName_criteria
Description
Criteria expression specification of displayName attribute in entity sr_type
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_type_doc_criteria
Description
Criteria expression specification of doc attribute in entity sr_type
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "xyz789"
}
sr_type_id_criteria
Description
Criteria expression specification of id attribute in entity sr_type
Example
{"_eq": 123, "_lte": 123, "_gte": 123, "_gt": 123, "_lt": 123}
sr_type_nameLower_criteria
Description
Criteria expression specification of nameLower attribute in entity sr_type
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "xyz789",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_type_name_criteria
Description
Criteria expression specification of name attribute in entity sr_type
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_type_order
Description
Order by attribute
Fields
| Input Field | Description |
|---|---|
owner - order_by_enum
|
|
replicatedTo - order_by_enum
|
|
userDescription - order_by_enum
|
|
replicatedFrom - order_by_enum
|
|
qualifiedName - order_by_enum
|
|
displayName - order_by_enum
|
|
description - order_by_enum
|
|
updateTime - order_by_enum
|
The update time |
nameLower - order_by_enum
|
Lowercase representation of the name |
ownerEmail - order_by_enum
|
|
default - order_by_enum
|
The type default |
createTime - order_by_enum
|
The create time |
name - order_by_enum
|
|
context - order_by_enum
|
The schema context |
doc - order_by_enum
|
Documentation |
id - order_by_enum
|
The schema id |
deprecatedTime - order_by_enum
|
The time when the entity is deprecated |
tenant - order_by_enum
|
The tenant |
Example
{
"owner": "asc",
"replicatedTo": "asc",
"userDescription": "asc",
"replicatedFrom": "asc",
"qualifiedName": "asc",
"displayName": "asc",
"description": "asc",
"updateTime": "asc",
"nameLower": "asc",
"ownerEmail": "asc",
"default": "asc",
"createTime": "asc",
"name": "asc",
"context": "asc",
"doc": "asc",
"id": "asc",
"deprecatedTime": "asc",
"tenant": "asc"
}
sr_type_ownerEmail_criteria
Description
Criteria expression specification of ownerEmail attribute in entity sr_type
Example
{
"_eq": "abc123",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_type_owner_criteria
Description
Criteria expression specification of owner attribute in entity sr_type
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_type_qualifiedName_criteria
Description
Criteria expression specification of qualifiedName attribute in entity sr_type
Example
{
"_eq": "xyz789",
"_lte": "xyz789",
"_gte": "xyz789",
"_gt": "xyz789",
"_lt": "abc123",
"_starts_with": "abc123"
}
sr_type_tenant_criteria
Description
Criteria expression specification of tenant attribute in entity sr_type
Example
{
"_eq": "xyz789",
"_lte": "abc123",
"_gte": "abc123",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
sr_type_updateTime_criteria
Description
Criteria expression specification of updateTime attribute in entity sr_type
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"
}
sr_type_userDescription_criteria
Description
Criteria expression specification of userDescription attribute in entity sr_type
Example
{
"_eq": "abc123",
"_lte": "abc123",
"_gte": "xyz789",
"_gt": "abc123",
"_lt": "xyz789",
"_starts_with": "abc123"
}
tag_def
Description
TagDef associated with the entity and its metadata
Example
{
"name": "abc123",
"description": "abc123",
"createTime": "2007-12-03T10:15:30Z",
"updateTime": "2007-12-03T10:15:30Z",
"color": "abc123"
}