Root Schema : Oracle GoldenGate Data Streaming Resource Configuration
Type: object
Title: Oracle GoldenGate Data Streaming Resource Configuration
This schema describes the configuration of a data streaming resource.
Show Source
{
"title":"Oracle GoldenGate Data Streaming Resource Configuration",
"description":"This schema describes the configuration of a data streaming resource.",
"required":[
"source"
],
"type":"object",
"properties":{
"tcpKeepAliveTimeout":{
"description":"Timeout (seconds) for keep-alive",
"type":"integer",
"default":"120",
"minimum":"1",
"maximum":"10800"
},
"qualityOfService":{
"description":"The quality level of the data streaming service ",
"type":"string",
"enum":[
"atLeastOnce",
"exactlyOnce",
"atMostOnce"
],
"default":"exactlyOnce"
},
"encoding":{
"description":"data encoding method",
"default":"json",
"x-oneOf":[
{
"description":"json encoding configuration",
"type":"object",
"properties":{
"json":{
"type":"object",
"properties":{
"beforeImageName":{
"description":"JSON element name for before image, applicable to op model only",
"type":"string",
"minLength":"1",
"maxLength":"32",
"default":"before"
},
"model":{
"description":"the model of records",
"enum":[
"op",
"row"
],
"default":"op"
},
"maxDDLTextSize":{
"description":"DDL text is truncated when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"1",
"maximum":"4294967295",
"default":"1000000"
},
"omitNullColumnValues":{
"description":"excludes columns with a null value",
"type":"boolean",
"default":false
},
"afterImageName":{
"description":"JSON element name for after image, applicable to op model only",
"type":"string",
"minLength":"1",
"maxLength":"32",
"default":"after"
},
"operationStrings":{
"description":"operation type string values",
"type":"object",
"properties":{
"insertOp":{
"default":"INSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"updateOp":{
"default":"UPDATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"deleteOp":{
"default":"DELETE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"truncateOp":{
"default":"TRUNCATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"upsertOp":{
"default":"UPSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"ddlOp":{
"default":"DDL",
"type":"string",
"minLength":"1",
"maxLength":"32"
}
},
"additionalProperties":false
},
"$schema":{
"enum":[
"ogg:outputFormatJson"
]
},
"delimiter":{
"description":"delimiter between records",
"type":"string",
"minLength":"0",
"maxLength":"32"
},
"metaFields":{
"description":"specifies metadata to include in records",
"type":"object",
"properties":{
"table":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"pos":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opType":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opSeqno":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"schema":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"transInd":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"currentTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"xid":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTs":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"env":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"currentTs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"qualifiedTable":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"primaryKeys":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"sys":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"csn":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"catalog":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"tokens":{
"default":null,
"x-oneOf":[
{
"enum":[
null,
"user",
"ggs",
"all"
]
},
{
"type":"object"
}
]
}
},
"additionalProperties":false
},
"includeJSONSchemaRecord":{
"description":"includes JSONSchema records describing every record in the stream including stream metadata record, object metadata record, DML record, and DDL record",
"type":"boolean",
"default":true
},
"maxLobSize":{
"description":"LOB data is truncated when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"1",
"maximum":"18446744073709552000",
"default":"64000"
},
"staticFields":{
"description":"specifies fields with static values in records",
"type":"object"
},
"treatAllColumnsAsStrings":{
"description":"writes all column values as strings instead of their native types",
"type":"boolean",
"default":false
},
"includeObjectMetadataRecords":{
"description":"includes metadata records describing a table, such as a list of its columns and types",
"type":"boolean",
"default":true
},
"flattenDelimiter":{
"description":"delimiter for concatenated JSON element names in before and after image columns, applicable to op model only",
"type":"string",
"minLength":"0",
"maxLength":"32"
},
"maxRecordSize":{
"description":"record is truncated or chunked when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"131072",
"maximum":"10485760",
"default":"1048576"
},
"flatten":{
"description":"flattens before and after image columns, applicable to op model only",
"type":"boolean",
"default":false
},
"includeStreamMetadataRecord":{
"description":"includes metadata record describing global information related to the source database and producer",
"type":"boolean",
"default":true
},
"truncateOrChunk":{
"description":"whether to truncate or chunk a record exceeding the maximum record size",
"enum":[
"truncate",
"chunk"
],
"default":"truncate"
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"enum":[
"json"
]
}
]
},
"$schema":{
"enum":[
"ogg:dataStream"
]
},
"rules":{
"type":"array",
"items":{
"description":"data streaming rule",
"type":"object",
"properties":{
"description":{
"description":"Description for the rule",
"type":"string",
"minLength":"1",
"maxLength":"4095"
},
"filter":{
"description":"data streams rule filter",
"x-oneOf":[
{
"description":"data record object names",
"type":"object",
"properties":{
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"description":"data record operation types",
"type":"object",
"properties":{
"operationTypes":{
"description":"set of operation types",
"type":"array",
"items":{
"enum":[
"DML",
"DDL",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":"1",
"maxItems":"6"
}
},
"required":[
"operationTypes"
],
"additionalProperties":false
},
{
"description":"data record column values",
"type":"object",
"properties":{
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"1",
"maxLength":"130"
},
"columnValue":{
"description":"column data, currently only support char and binary integer type",
"x-oneOf":[
{
"type":"string",
"minLength":"0",
"maxLength":"32767"
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"description":"data record tags",
"type":"object",
"properties":{
"tags":{
"description":"set of binary tags",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":"1",
"maxItems":"32767"
},
{
"enum":[
"all",
"none"
]
}
]
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"description":"data record partition names",
"type":"object",
"properties":{
"partitionNames":{
"description":"set of partition names",
"type":"array",
"items":{
"description":"Qualified partition name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"7",
"maxLength":"523"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"partitionNames"
],
"additionalProperties":false
},
{
"description":"data record user tokens",
"type":"object",
"properties":{
"userTokens":{
"description":"set of user tokens",
"type":"array",
"items":{
"type":"object",
"properties":{
"tokenName":{
"description":"user token name",
"type":"string",
"minLength":"1",
"maxLength":"30"
},
"tokenValue":{
"description":"user token value",
"type":"string",
"minLength":"1",
"maxLength":"32767"
},
"matchType":{
"description":"how to match the filter value",
"enum":[
"exactCaseSensitive",
"exactCaseInsensitive",
"partialCaseSensitive",
"partialCaseInsensitive"
],
"default":"exactCaseSensistive"
}
},
"required":[
"tokenName",
"tokenValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"userTokens"
],
"additionalProperties":false
}
]
},
"action":{
"enum":[
"include",
"exclude"
]
}
},
"required":[
"filter",
"action"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"1024"
},
"source":{
"description":"source endpoint of the data stream.",
"type":"object",
"properties":{
"trail":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[a-zA-Z0-9_#$/-]*$",
"minLength":"2",
"maxLength":"512"
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
}
},
"additionalProperties":false
},
"bufferSize":{
"description":"data buffer size in bytes before flush",
"type":"integer",
"minimum":"131072",
"maximum":"10485760",
"default":"1048576"
},
"cloudEventsFormat":{
"description":"data records conform to cloudEvents format",
"type":"boolean",
"default":false
},
"description":{
"description":"Description for the data stream",
"type":"string",
"minLength":"1",
"maxLength":"4096"
}
},
"additionalProperties":false
}
Nested Schema : encoding
data encoding method
Default Value: json
Match One
Show Source
{
"description":"data encoding method",
"default":"json",
"x-oneOf":[
{
"description":"json encoding configuration",
"type":"object",
"properties":{
"json":{
"type":"object",
"properties":{
"beforeImageName":{
"description":"JSON element name for before image, applicable to op model only",
"type":"string",
"minLength":"1",
"maxLength":"32",
"default":"before"
},
"model":{
"description":"the model of records",
"enum":[
"op",
"row"
],
"default":"op"
},
"maxDDLTextSize":{
"description":"DDL text is truncated when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"1",
"maximum":"4294967295",
"default":"1000000"
},
"omitNullColumnValues":{
"description":"excludes columns with a null value",
"type":"boolean",
"default":false
},
"afterImageName":{
"description":"JSON element name for after image, applicable to op model only",
"type":"string",
"minLength":"1",
"maxLength":"32",
"default":"after"
},
"operationStrings":{
"description":"operation type string values",
"type":"object",
"properties":{
"insertOp":{
"default":"INSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"updateOp":{
"default":"UPDATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"deleteOp":{
"default":"DELETE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"truncateOp":{
"default":"TRUNCATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"upsertOp":{
"default":"UPSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"ddlOp":{
"default":"DDL",
"type":"string",
"minLength":"1",
"maxLength":"32"
}
},
"additionalProperties":false
},
"$schema":{
"enum":[
"ogg:outputFormatJson"
]
},
"delimiter":{
"description":"delimiter between records",
"type":"string",
"minLength":"0",
"maxLength":"32"
},
"metaFields":{
"description":"specifies metadata to include in records",
"type":"object",
"properties":{
"table":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"pos":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opType":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opSeqno":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"schema":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"transInd":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"currentTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"xid":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTs":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"env":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"currentTs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"qualifiedTable":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"primaryKeys":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"sys":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"csn":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"catalog":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"tokens":{
"default":null,
"x-oneOf":[
{
"enum":[
null,
"user",
"ggs",
"all"
]
},
{
"type":"object"
}
]
}
},
"additionalProperties":false
},
"includeJSONSchemaRecord":{
"description":"includes JSONSchema records describing every record in the stream including stream metadata record, object metadata record, DML record, and DDL record",
"type":"boolean",
"default":true
},
"maxLobSize":{
"description":"LOB data is truncated when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"1",
"maximum":"18446744073709552000",
"default":"64000"
},
"staticFields":{
"description":"specifies fields with static values in records",
"type":"object"
},
"treatAllColumnsAsStrings":{
"description":"writes all column values as strings instead of their native types",
"type":"boolean",
"default":false
},
"includeObjectMetadataRecords":{
"description":"includes metadata records describing a table, such as a list of its columns and types",
"type":"boolean",
"default":true
},
"flattenDelimiter":{
"description":"delimiter for concatenated JSON element names in before and after image columns, applicable to op model only",
"type":"string",
"minLength":"0",
"maxLength":"32"
},
"maxRecordSize":{
"description":"record is truncated or chunked when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"131072",
"maximum":"10485760",
"default":"1048576"
},
"flatten":{
"description":"flattens before and after image columns, applicable to op model only",
"type":"boolean",
"default":false
},
"includeStreamMetadataRecord":{
"description":"includes metadata record describing global information related to the source database and producer",
"type":"boolean",
"default":true
},
"truncateOrChunk":{
"description":"whether to truncate or chunk a record exceeding the maximum record size",
"enum":[
"truncate",
"chunk"
],
"default":"truncate"
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"enum":[
"json"
]
}
]
}
Nested Schema : rules
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1024
Show Source
{
"type":"array",
"items":{
"description":"data streaming rule",
"type":"object",
"properties":{
"description":{
"description":"Description for the rule",
"type":"string",
"minLength":"1",
"maxLength":"4095"
},
"filter":{
"description":"data streams rule filter",
"x-oneOf":[
{
"description":"data record object names",
"type":"object",
"properties":{
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"description":"data record operation types",
"type":"object",
"properties":{
"operationTypes":{
"description":"set of operation types",
"type":"array",
"items":{
"enum":[
"DML",
"DDL",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":"1",
"maxItems":"6"
}
},
"required":[
"operationTypes"
],
"additionalProperties":false
},
{
"description":"data record column values",
"type":"object",
"properties":{
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"1",
"maxLength":"130"
},
"columnValue":{
"description":"column data, currently only support char and binary integer type",
"x-oneOf":[
{
"type":"string",
"minLength":"0",
"maxLength":"32767"
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"description":"data record tags",
"type":"object",
"properties":{
"tags":{
"description":"set of binary tags",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":"1",
"maxItems":"32767"
},
{
"enum":[
"all",
"none"
]
}
]
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"description":"data record partition names",
"type":"object",
"properties":{
"partitionNames":{
"description":"set of partition names",
"type":"array",
"items":{
"description":"Qualified partition name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"7",
"maxLength":"523"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"partitionNames"
],
"additionalProperties":false
},
{
"description":"data record user tokens",
"type":"object",
"properties":{
"userTokens":{
"description":"set of user tokens",
"type":"array",
"items":{
"type":"object",
"properties":{
"tokenName":{
"description":"user token name",
"type":"string",
"minLength":"1",
"maxLength":"30"
},
"tokenValue":{
"description":"user token value",
"type":"string",
"minLength":"1",
"maxLength":"32767"
},
"matchType":{
"description":"how to match the filter value",
"enum":[
"exactCaseSensitive",
"exactCaseInsensitive",
"partialCaseSensitive",
"partialCaseInsensitive"
],
"default":"exactCaseSensistive"
}
},
"required":[
"tokenName",
"tokenValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"userTokens"
],
"additionalProperties":false
}
]
},
"action":{
"enum":[
"include",
"exclude"
]
}
},
"required":[
"filter",
"action"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"1024"
}
Nested Schema : source
Type: object
source endpoint of the data stream.
Show Source
-
path:
string
Minimum Length: 1
Maximum Length: 4096
The path where trail data is stored
-
trail:
string
Minimum Length: 2
Maximum Length: 512
Pattern: ^[a-zA-Z0-9_#$/-]*$
The name of the trail
{
"description":"source endpoint of the data stream.",
"type":"object",
"properties":{
"trail":{
"description":"The name of the trail",
"type":"string",
"pattern":"^[a-zA-Z0-9_#$/-]*$",
"minLength":"2",
"maxLength":"512"
},
"path":{
"description":"The path where trail data is stored",
"type":"string",
"minLength":"1",
"maxLength":"4096"
}
},
"additionalProperties":false
}
Nested Schema : encoding-x-oneOf[0]
Type: object
json encoding configuration
Show Source
{
"description":"json encoding configuration",
"type":"object",
"properties":{
"json":{
"type":"object",
"properties":{
"beforeImageName":{
"description":"JSON element name for before image, applicable to op model only",
"type":"string",
"minLength":"1",
"maxLength":"32",
"default":"before"
},
"model":{
"description":"the model of records",
"enum":[
"op",
"row"
],
"default":"op"
},
"maxDDLTextSize":{
"description":"DDL text is truncated when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"1",
"maximum":"4294967295",
"default":"1000000"
},
"omitNullColumnValues":{
"description":"excludes columns with a null value",
"type":"boolean",
"default":false
},
"afterImageName":{
"description":"JSON element name for after image, applicable to op model only",
"type":"string",
"minLength":"1",
"maxLength":"32",
"default":"after"
},
"operationStrings":{
"description":"operation type string values",
"type":"object",
"properties":{
"insertOp":{
"default":"INSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"updateOp":{
"default":"UPDATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"deleteOp":{
"default":"DELETE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"truncateOp":{
"default":"TRUNCATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"upsertOp":{
"default":"UPSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"ddlOp":{
"default":"DDL",
"type":"string",
"minLength":"1",
"maxLength":"32"
}
},
"additionalProperties":false
},
"$schema":{
"enum":[
"ogg:outputFormatJson"
]
},
"delimiter":{
"description":"delimiter between records",
"type":"string",
"minLength":"0",
"maxLength":"32"
},
"metaFields":{
"description":"specifies metadata to include in records",
"type":"object",
"properties":{
"table":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"pos":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opType":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opSeqno":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"schema":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"transInd":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"currentTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"xid":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTs":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"env":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"currentTs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"qualifiedTable":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"primaryKeys":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"sys":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"csn":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"catalog":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"tokens":{
"default":null,
"x-oneOf":[
{
"enum":[
null,
"user",
"ggs",
"all"
]
},
{
"type":"object"
}
]
}
},
"additionalProperties":false
},
"includeJSONSchemaRecord":{
"description":"includes JSONSchema records describing every record in the stream including stream metadata record, object metadata record, DML record, and DDL record",
"type":"boolean",
"default":true
},
"maxLobSize":{
"description":"LOB data is truncated when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"1",
"maximum":"18446744073709552000",
"default":"64000"
},
"staticFields":{
"description":"specifies fields with static values in records",
"type":"object"
},
"treatAllColumnsAsStrings":{
"description":"writes all column values as strings instead of their native types",
"type":"boolean",
"default":false
},
"includeObjectMetadataRecords":{
"description":"includes metadata records describing a table, such as a list of its columns and types",
"type":"boolean",
"default":true
},
"flattenDelimiter":{
"description":"delimiter for concatenated JSON element names in before and after image columns, applicable to op model only",
"type":"string",
"minLength":"0",
"maxLength":"32"
},
"maxRecordSize":{
"description":"record is truncated or chunked when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"131072",
"maximum":"10485760",
"default":"1048576"
},
"flatten":{
"description":"flattens before and after image columns, applicable to op model only",
"type":"boolean",
"default":false
},
"includeStreamMetadataRecord":{
"description":"includes metadata record describing global information related to the source database and producer",
"type":"boolean",
"default":true
},
"truncateOrChunk":{
"description":"whether to truncate or chunk a record exceeding the maximum record size",
"enum":[
"truncate",
"chunk"
],
"default":"truncate"
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : json
Type: object
Show Source
{
"type":"object",
"properties":{
"beforeImageName":{
"description":"JSON element name for before image, applicable to op model only",
"type":"string",
"minLength":"1",
"maxLength":"32",
"default":"before"
},
"model":{
"description":"the model of records",
"enum":[
"op",
"row"
],
"default":"op"
},
"maxDDLTextSize":{
"description":"DDL text is truncated when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"1",
"maximum":"4294967295",
"default":"1000000"
},
"omitNullColumnValues":{
"description":"excludes columns with a null value",
"type":"boolean",
"default":false
},
"afterImageName":{
"description":"JSON element name for after image, applicable to op model only",
"type":"string",
"minLength":"1",
"maxLength":"32",
"default":"after"
},
"operationStrings":{
"description":"operation type string values",
"type":"object",
"properties":{
"insertOp":{
"default":"INSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"updateOp":{
"default":"UPDATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"deleteOp":{
"default":"DELETE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"truncateOp":{
"default":"TRUNCATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"upsertOp":{
"default":"UPSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"ddlOp":{
"default":"DDL",
"type":"string",
"minLength":"1",
"maxLength":"32"
}
},
"additionalProperties":false
},
"$schema":{
"enum":[
"ogg:outputFormatJson"
]
},
"delimiter":{
"description":"delimiter between records",
"type":"string",
"minLength":"0",
"maxLength":"32"
},
"metaFields":{
"description":"specifies metadata to include in records",
"type":"object",
"properties":{
"table":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"pos":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opType":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opSeqno":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"schema":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"transInd":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"currentTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"xid":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTs":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"env":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"currentTs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"qualifiedTable":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"primaryKeys":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"sys":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"csn":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"catalog":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"tokens":{
"default":null,
"x-oneOf":[
{
"enum":[
null,
"user",
"ggs",
"all"
]
},
{
"type":"object"
}
]
}
},
"additionalProperties":false
},
"includeJSONSchemaRecord":{
"description":"includes JSONSchema records describing every record in the stream including stream metadata record, object metadata record, DML record, and DDL record",
"type":"boolean",
"default":true
},
"maxLobSize":{
"description":"LOB data is truncated when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"1",
"maximum":"18446744073709552000",
"default":"64000"
},
"staticFields":{
"description":"specifies fields with static values in records",
"type":"object"
},
"treatAllColumnsAsStrings":{
"description":"writes all column values as strings instead of their native types",
"type":"boolean",
"default":false
},
"includeObjectMetadataRecords":{
"description":"includes metadata records describing a table, such as a list of its columns and types",
"type":"boolean",
"default":true
},
"flattenDelimiter":{
"description":"delimiter for concatenated JSON element names in before and after image columns, applicable to op model only",
"type":"string",
"minLength":"0",
"maxLength":"32"
},
"maxRecordSize":{
"description":"record is truncated or chunked when exceeding this maximum size in bytes",
"type":"integer",
"minimum":"131072",
"maximum":"10485760",
"default":"1048576"
},
"flatten":{
"description":"flattens before and after image columns, applicable to op model only",
"type":"boolean",
"default":false
},
"includeStreamMetadataRecord":{
"description":"includes metadata record describing global information related to the source database and producer",
"type":"boolean",
"default":true
},
"truncateOrChunk":{
"description":"whether to truncate or chunk a record exceeding the maximum record size",
"enum":[
"truncate",
"chunk"
],
"default":"truncate"
}
},
"additionalProperties":false
}
Nested Schema : metaFields
Type: object
specifies metadata to include in records
Show Source
{
"description":"specifies metadata to include in records",
"type":"object",
"properties":{
"table":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"pos":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opType":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opSeqno":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"schema":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"transInd":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"currentTsMicroSecs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"xid":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"opTs":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"env":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"currentTs":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"qualifiedTable":{
"default":true,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"primaryKeys":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"sys":{
"default":null,
"x-oneOf":[
{
"enum":[
null
]
},
{
"type":"object"
}
]
},
"csn":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"catalog":{
"default":false,
"x-oneOf":[
{
"type":"boolean"
},
{
"type":"string",
"minLength":"1",
"maxLength":"255"
}
]
},
"tokens":{
"default":null,
"x-oneOf":[
{
"enum":[
null,
"user",
"ggs",
"all"
]
},
{
"type":"object"
}
]
}
},
"additionalProperties":false
}
Nested Schema : operationStrings
Type: object
operation type string values
Show Source
{
"description":"operation type string values",
"type":"object",
"properties":{
"insertOp":{
"default":"INSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"updateOp":{
"default":"UPDATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"deleteOp":{
"default":"DELETE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"truncateOp":{
"default":"TRUNCATE",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"upsertOp":{
"default":"UPSERT",
"type":"string",
"minLength":"1",
"maxLength":"32"
},
"ddlOp":{
"default":"DDL",
"type":"string",
"minLength":"1",
"maxLength":"32"
}
},
"additionalProperties":false
}
Nested Schema : staticFields
Type: object
specifies fields with static values in records
Nested Schema : items
Type: object
data streaming rule
Show Source
{
"description":"data streaming rule",
"type":"object",
"properties":{
"description":{
"description":"Description for the rule",
"type":"string",
"minLength":"1",
"maxLength":"4095"
},
"filter":{
"description":"data streams rule filter",
"x-oneOf":[
{
"description":"data record object names",
"type":"object",
"properties":{
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"description":"data record operation types",
"type":"object",
"properties":{
"operationTypes":{
"description":"set of operation types",
"type":"array",
"items":{
"enum":[
"DML",
"DDL",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":"1",
"maxItems":"6"
}
},
"required":[
"operationTypes"
],
"additionalProperties":false
},
{
"description":"data record column values",
"type":"object",
"properties":{
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"1",
"maxLength":"130"
},
"columnValue":{
"description":"column data, currently only support char and binary integer type",
"x-oneOf":[
{
"type":"string",
"minLength":"0",
"maxLength":"32767"
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"description":"data record tags",
"type":"object",
"properties":{
"tags":{
"description":"set of binary tags",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":"1",
"maxItems":"32767"
},
{
"enum":[
"all",
"none"
]
}
]
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"description":"data record partition names",
"type":"object",
"properties":{
"partitionNames":{
"description":"set of partition names",
"type":"array",
"items":{
"description":"Qualified partition name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"7",
"maxLength":"523"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"partitionNames"
],
"additionalProperties":false
},
{
"description":"data record user tokens",
"type":"object",
"properties":{
"userTokens":{
"description":"set of user tokens",
"type":"array",
"items":{
"type":"object",
"properties":{
"tokenName":{
"description":"user token name",
"type":"string",
"minLength":"1",
"maxLength":"30"
},
"tokenValue":{
"description":"user token value",
"type":"string",
"minLength":"1",
"maxLength":"32767"
},
"matchType":{
"description":"how to match the filter value",
"enum":[
"exactCaseSensitive",
"exactCaseInsensitive",
"partialCaseSensitive",
"partialCaseInsensitive"
],
"default":"exactCaseSensistive"
}
},
"required":[
"tokenName",
"tokenValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"userTokens"
],
"additionalProperties":false
}
]
},
"action":{
"enum":[
"include",
"exclude"
]
}
},
"required":[
"filter",
"action"
],
"additionalProperties":false
}
Nested Schema : filter
data streams rule filter
Match One
Show Source
{
"description":"data streams rule filter",
"x-oneOf":[
{
"description":"data record object names",
"type":"object",
"properties":{
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"description":"data record operation types",
"type":"object",
"properties":{
"operationTypes":{
"description":"set of operation types",
"type":"array",
"items":{
"enum":[
"DML",
"DDL",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":"1",
"maxItems":"6"
}
},
"required":[
"operationTypes"
],
"additionalProperties":false
},
{
"description":"data record column values",
"type":"object",
"properties":{
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"1",
"maxLength":"130"
},
"columnValue":{
"description":"column data, currently only support char and binary integer type",
"x-oneOf":[
{
"type":"string",
"minLength":"0",
"maxLength":"32767"
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"description":"data record tags",
"type":"object",
"properties":{
"tags":{
"description":"set of binary tags",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":"1",
"maxItems":"32767"
},
{
"enum":[
"all",
"none"
]
}
]
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"description":"data record partition names",
"type":"object",
"properties":{
"partitionNames":{
"description":"set of partition names",
"type":"array",
"items":{
"description":"Qualified partition name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"7",
"maxLength":"523"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"partitionNames"
],
"additionalProperties":false
},
{
"description":"data record user tokens",
"type":"object",
"properties":{
"userTokens":{
"description":"set of user tokens",
"type":"array",
"items":{
"type":"object",
"properties":{
"tokenName":{
"description":"user token name",
"type":"string",
"minLength":"1",
"maxLength":"30"
},
"tokenValue":{
"description":"user token value",
"type":"string",
"minLength":"1",
"maxLength":"32767"
},
"matchType":{
"description":"how to match the filter value",
"enum":[
"exactCaseSensitive",
"exactCaseInsensitive",
"partialCaseSensitive",
"partialCaseInsensitive"
],
"default":"exactCaseSensistive"
}
},
"required":[
"tokenName",
"tokenValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"userTokens"
],
"additionalProperties":false
}
]
}
Nested Schema : filter-x-oneOf[0]
Type: object
data record object names
Show Source
{
"description":"data record object names",
"type":"object",
"properties":{
"objectNames":{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"objectNames"
],
"additionalProperties":false
}
Nested Schema : filter-x-oneOf[1]
Type: object
data record operation types
Show Source
{
"description":"data record operation types",
"type":"object",
"properties":{
"operationTypes":{
"description":"set of operation types",
"type":"array",
"items":{
"enum":[
"DML",
"DDL",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":"1",
"maxItems":"6"
}
},
"required":[
"operationTypes"
],
"additionalProperties":false
}
Nested Schema : filter-x-oneOf[2]
Type: object
data record column values
Show Source
{
"description":"data record column values",
"type":"object",
"properties":{
"columnValues":{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"1",
"maxLength":"130"
},
"columnValue":{
"description":"column data, currently only support char and binary integer type",
"x-oneOf":[
{
"type":"string",
"minLength":"0",
"maxLength":"32767"
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"columnValues"
],
"additionalProperties":false
}
Nested Schema : filter-x-oneOf[3]
Type: object
data record tags
Show Source
{
"description":"data record tags",
"type":"object",
"properties":{
"tags":{
"description":"set of binary tags",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":"1",
"maxItems":"32767"
},
{
"enum":[
"all",
"none"
]
}
]
}
},
"required":[
"tags"
],
"additionalProperties":false
}
Nested Schema : filter-x-oneOf[4]
Type: object
data record partition names
Show Source
{
"description":"data record partition names",
"type":"object",
"properties":{
"partitionNames":{
"description":"set of partition names",
"type":"array",
"items":{
"description":"Qualified partition name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"7",
"maxLength":"523"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"partitionNames"
],
"additionalProperties":false
}
Nested Schema : filter-x-oneOf[5]
Type: object
data record user tokens
Show Source
{
"description":"data record user tokens",
"type":"object",
"properties":{
"userTokens":{
"description":"set of user tokens",
"type":"array",
"items":{
"type":"object",
"properties":{
"tokenName":{
"description":"user token name",
"type":"string",
"minLength":"1",
"maxLength":"30"
},
"tokenValue":{
"description":"user token value",
"type":"string",
"minLength":"1",
"maxLength":"32767"
},
"matchType":{
"description":"how to match the filter value",
"enum":[
"exactCaseSensitive",
"exactCaseInsensitive",
"partialCaseSensitive",
"partialCaseInsensitive"
],
"default":"exactCaseSensistive"
}
},
"required":[
"tokenName",
"tokenValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
},
"required":[
"userTokens"
],
"additionalProperties":false
}
Nested Schema : objectNames
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of object names
Show Source
-
Array of:
items
Qualified table name where any name component may contain wildcard characters
{
"description":"set of object names",
"type":"array",
"items":{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
Nested Schema : items
Qualified table name where any name component may contain wildcard characters
Match Any
Show Source
-
string
Minimum Length: 3
Maximum Length: 261
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 5
Maximum Length: 392
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"Qualified table name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
}
Nested Schema : operationTypes
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 6
set of operation types
Show Source
-
Array of:
Allowed Values: [
"DML",
"DDL",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
{
"description":"set of operation types",
"type":"array",
"items":{
"enum":[
"DML",
"DDL",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":"1",
"maxItems":"6"
}
Nested Schema : columnValues
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of column values
Show Source
{
"description":"set of column values",
"type":"array",
"items":{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"1",
"maxLength":"130"
},
"columnValue":{
"description":"column data, currently only support char and binary integer type",
"x-oneOf":[
{
"type":"string",
"minLength":"0",
"maxLength":"32767"
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
Nested Schema : items
Type: object
Show Source
-
columnName(required):
string
Minimum Length: 1
Maximum Length: 130
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
name of the column
-
columnValue(required):
columnValue
column data, currently only support char and binary integer type
-
imageType:
Default Value: before
Allowed Values: [
"before",
"after"
]
before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.
-
operator:
Default Value: equalTo
Allowed Values: [
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
]
comparison operator
-
tableName(required):
tableName
name of the table in which the column(s) reside
{
"type":"object",
"properties":{
"tableName":{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"columnName":{
"description":"name of the column",
"type":"string",
"pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"1",
"maxLength":"130"
},
"columnValue":{
"description":"column data, currently only support char and binary integer type",
"x-oneOf":[
{
"type":"string",
"minLength":"0",
"maxLength":"32767"
},
{
"type":"number"
},
{
"type":"null"
}
]
},
"imageType":{
"description":"before or after column image. INSERT only has after image and DELETE only has before image, applies to cases where both before and after images are available.",
"enum":[
"before",
"after"
],
"default":"before"
},
"operator":{
"description":"comparison operator",
"enum":[
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
],
"default":"equalTo"
}
},
"required":[
"tableName",
"columnName",
"columnValue"
],
"additionalProperties":false
}
Nested Schema : columnValue
column data, currently only support char and binary integer type
Match One
Show Source
{
"description":"column data, currently only support char and binary integer type",
"x-oneOf":[
{
"type":"string",
"minLength":"0",
"maxLength":"32767"
},
{
"type":"number"
},
{
"type":"null"
}
]
}
Nested Schema : tableName
name of the table in which the column(s) reside
Match Any
Show Source
-
string
Minimum Length: 3
Maximum Length: 261
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 5
Maximum Length: 392
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"name of the table in which the column(s) reside",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"3",
"maxLength":"261"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
}
Nested Schema : tags
set of binary tags
Match One
Show Source
{
"description":"set of binary tags",
"x-oneOf":[
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":"1",
"maxItems":"32767"
},
{
"enum":[
"all",
"none"
]
}
]
}
Nested Schema : tags-x-oneOf[0]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 32767
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"description":"Binary string representing the tag value.",
"type":"object",
"properties":{
"binValue":{
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binValue"
],
"additionalProperties":false
},
{
"description":"Hexdecimal string representing the tag value.",
"type":"object",
"properties":{
"hexValue":{
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexValue"
],
"additionalProperties":false
},
{
"description":"binary tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"binMask":{
"description":"binary string representing the tag mask value.",
"type":"string",
"pattern":"^[01]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"binMask"
],
"additionalProperties":false
},
{
"description":"Hexdecimal tag bitmask value, bitwise AND operation will be performed against the tag associated with the LCR.",
"type":"object",
"properties":{
"hexMask":{
"description":"Hexdecimal string representing the tag mask value.",
"type":"string",
"pattern":"^[A-Fa-f0-9]{1,2000}$",
"minLength":"1",
"maxLength":"2000"
}
},
"required":[
"hexMask"
],
"additionalProperties":false
}
]
},
"minItems":"1",
"maxItems":"32767"
}
Nested Schema : partitionNames
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of partition names
Show Source
-
Array of:
items
Qualified partition name where any name component may contain wildcard characters
{
"description":"set of partition names",
"type":"array",
"items":{
"description":"Qualified partition name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"7",
"maxLength":"523"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
},
"minItems":"1",
"maxItems":"65535"
}
Nested Schema : items
Qualified partition name where any name component may contain wildcard characters
Match Any
Show Source
-
string
Minimum Length: 7
Maximum Length: 523
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
-
string
Minimum Length: 5
Maximum Length: 392
Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
{
"description":"Qualified partition name where any name component may contain wildcard characters",
"x-anyOf":[
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"7",
"maxLength":"523"
},
{
"type":"string",
"pattern":"^([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])[.]([^.\"]{1,128}|[\"].{1,128}[\"])$",
"minLength":"5",
"maxLength":"392"
}
]
}
Nested Schema : userTokens
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
set of user tokens
Show Source
{
"description":"set of user tokens",
"type":"array",
"items":{
"type":"object",
"properties":{
"tokenName":{
"description":"user token name",
"type":"string",
"minLength":"1",
"maxLength":"30"
},
"tokenValue":{
"description":"user token value",
"type":"string",
"minLength":"1",
"maxLength":"32767"
},
"matchType":{
"description":"how to match the filter value",
"enum":[
"exactCaseSensitive",
"exactCaseInsensitive",
"partialCaseSensitive",
"partialCaseInsensitive"
],
"default":"exactCaseSensistive"
}
},
"required":[
"tokenName",
"tokenValue"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"65535"
}
Nested Schema : items
Type: object
Show Source
-
matchType:
Default Value: exactCaseSensistive
Allowed Values: [
"exactCaseSensitive",
"exactCaseInsensitive",
"partialCaseSensitive",
"partialCaseInsensitive"
]
how to match the filter value
-
tokenName(required):
string
Minimum Length: 1
Maximum Length: 30
user token name
-
tokenValue(required):
string
Minimum Length: 1
Maximum Length: 32767
user token value
{
"type":"object",
"properties":{
"tokenName":{
"description":"user token name",
"type":"string",
"minLength":"1",
"maxLength":"30"
},
"tokenValue":{
"description":"user token value",
"type":"string",
"minLength":"1",
"maxLength":"32767"
},
"matchType":{
"description":"how to match the filter value",
"enum":[
"exactCaseSensitive",
"exactCaseInsensitive",
"partialCaseSensitive",
"partialCaseInsensitive"
],
"default":"exactCaseSensistive"
}
},
"required":[
"tokenName",
"tokenValue"
],
"additionalProperties":false
}