Root Schema : Oracle GoldenGate Distribution Path
Type: object
Title: Oracle GoldenGate Distribution Path
Show Source
{
"title":"Oracle GoldenGate Distribution Path",
"type":"object",
"properties":{
"begin":{
"description":"Starting point for data processing",
"default":{
"sequence":0,
"offset":0
},
"x-oneOf":[
{
"enum":[
"now"
]
},
{
"type":"string",
"pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
"minLength":20,
"maxLength":32
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"type:position/atTrailRBA"
]
},
"sequence":{
"description":"Trail file sequence number",
"type":"integer",
"minimum":0,
"maximum":999999999,
"default":0
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":0,
"default":0,
"maximum":2147483647
}
},
"required":[
"sequence"
],
"additionalProperties":false
}
]
},
"name":{
"description":"distribution path name",
"type":"string",
"pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
"minLength":1,
"maxLength":32
},
"encryptionProfile":{
"description":"Name of 'ogg:encryptionProfile' value",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9_:-]*$",
"minLength":1,
"maxLength":64
},
"$schema":{
"enum":[
"ogg:distPath"
]
},
"status":{
"description":"Oracle GoldenGate Distribution Path Status",
"default":"stopped",
"x-oneOf":[
{
"enum":[
"paused",
"running",
"stopping",
"stopped",
"killed",
"uninitialized"
],
"default":"stopped"
},
{
"type":"object",
"description":"Extended options for starting a distribution path",
"x-oneOf":[
{
"type":"object",
"properties":{
"desired":{
"enum":[
"running"
]
},
"at":{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
},
"additionalProperties":false,
"required":[
"desired",
"at"
]
},
{
"type":"object",
"properties":{
"desired":{
"enum":[
"running"
]
},
"after":{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
},
"additionalProperties":false,
"required":[
"desired",
"after"
]
}
]
},
{
"type":"object",
"description":"Extended options for stopping a distribution path",
"properties":{
"desired":{
"enum":[
"stopped"
]
},
"force":{
"type":"boolean",
"default":false
}
},
"additionalProperties":false,
"required":[
"desired",
"force"
]
}
]
},
"targetInitiated":{
"description":"Whether the target endpoint initiates the path. If true, the path needs to be created and modified through Receiver Server, who initiates the connection with Distribution Server. Otherwise, this behavior is reversed.",
"type":"boolean",
"default":false
},
"ruleset":{
"x-oneOf":[
{
"description":"Ruleset for the distribution path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRuleset"
]
},
"name":{
"description":"name of the path ruleset",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path ruleset",
"type":"string",
"minLength":1,
"maxLength":4095
},
"rules":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"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",
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathPartitionNames"
]
},
"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
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
}
},
"required":[
"rules"
],
"additionalProperties":false
},
{
"type":"null"
}
]
},
"source":{
"description":"source endpoint of the path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpoint"
]
},
"description":{
"description":"Description for the endpoint",
"type":"string",
"minLength":1,
"maxLength":4095
},
"uri":{
"description":"endpoint URI specification",
"x-oneOf":[
{
"type":"array",
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"minItems":1,
"maxItems":2147483647
},
{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
}
]
},
"proxy":{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
},
"details":{
"description":"endpoint detail information",
"type":"object"
},
"isDynamicOggPort":{
"description":"If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).",
"type":"boolean",
"default":true
},
"authenticationMethod":{
"description":"Authentication method to use when starting the path",
"x-oneOf":[
{
"description":"OAuth2.0 Client Credentials authentication",
"enum":[
"oauth2ClientCredentials"
]
},
{
"type":"object",
"description":"Certificate authentication",
"properties":{
"certificate":{
"description":"Certificate name",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$",
"minLength":1,
"maxLength":32
}
},
"additionalProperties":false,
"required":[
"certificate"
]
},
{
"description":"Credentials authentication",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
]
}
},
"additionalProperties":false
},
"target":{
"description":"target endpoint of the path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpoint"
]
},
"description":{
"description":"Description for the endpoint",
"type":"string",
"minLength":1,
"maxLength":4095
},
"uri":{
"description":"endpoint URI specification",
"x-oneOf":[
{
"type":"array",
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"minItems":1,
"maxItems":2147483647
},
{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
}
]
},
"proxy":{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
},
"details":{
"description":"endpoint detail information",
"type":"object"
},
"isDynamicOggPort":{
"description":"If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).",
"type":"boolean",
"default":true
},
"authenticationMethod":{
"description":"Authentication method to use when starting the path",
"x-oneOf":[
{
"description":"OAuth2.0 Client Credentials authentication",
"enum":[
"oauth2ClientCredentials"
]
},
{
"type":"object",
"description":"Certificate authentication",
"properties":{
"certificate":{
"description":"Certificate name",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$",
"minLength":1,
"maxLength":32
}
},
"additionalProperties":false,
"required":[
"certificate"
]
},
{
"description":"Credentials authentication",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
]
}
},
"additionalProperties":false
},
"options":{
"description":"options for the distribution path",
"type":"object",
"properties":{
"tcpSourceTimer":{
"description":"Adjusts the timestamp of data records when they are sent to other systems",
"type":"boolean",
"default":true
},
"reportCount":{
"description":"Reportcount option to report a count of transactions records processed by DS.",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:reportcountOption"
]
},
"measurementUnit":{
"description":"The unit of measure for count.",
"type":"string",
"enum":[
"records",
"seconds",
"minutes",
"hours"
]
},
"count":{
"description":"The interval after which to output a count.",
"type":"integer",
"minimum":1,
"maximum":4.294967295E9,
"default":5000
},
"rate":{
"description":"Report the number of operations per second and the change in rate, as a measurment of performance.",
"type":"boolean",
"default":true
}
},
"required":[
"measurementUnit"
],
"additionalProperties":false
},
"network":{
"description":"Endpoint network details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:networkOptions"
]
},
"socketOptions":{
"description":"socket options",
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"tcpKeepAliveTimeout":{
"description":"Timeout (seconds) for keep-alive",
"type":"integer",
"default":60,
"minimum":1,
"maximum":10800
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":-1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
]
},
"appOptions":{
"description":"application options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:appOptions"
]
},
"appFlushBytes":{
"description":"application flush size",
"type":"integer",
"default":27985,
"minimum":1024,
"maximum":524288
},
"appFlushSecs":{
"description":"application flush interval",
"type":"integer",
"default":1,
"minimum":1,
"maximum":300
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
"$schema":{
"enum":[
"ogg:distPathOptions"
]
},
"streaming":{
"description":"Asynchronous network streaming protocol where sender does not wait for an acknowledgement from the receiver.",
"type":"boolean",
"default":true
},
"critical":{
"description":"Indicates the distribution path is critical to the deployment",
"type":"boolean",
"default":false
},
"autoRestart":{
"description":"Describe if a killed path needs to be restarted automatically",
"type":"object",
"properties":{
"retries":{
"description":"maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0",
"type":"integer",
"minimum":0,
"maximum":3600,
"default":10
},
"delay":{
"description":"The amount of time, in minutes, to pause between restarting the path.",
"type":"integer",
"minimum":0,
"default":2,
"maximum":60
}
},
"required":[
"retries"
],
"additionalProperties":false
},
"eofDelayCSecs":{
"description":"EOF delay in centi-seconds before searching for source data",
"type":"integer",
"minimum":1,
"default":10,
"maximum":6000
},
"checkpointFrequency":{
"description":"Frequency in seconds for path taking routine checkpoints.",
"type":"integer",
"minimum":1,
"default":10,
"maximum":4.294967295E9
}
},
"additionalProperties":false
},
"description":{
"description":"Description for the path",
"type":"string",
"minLength":1,
"maxLength":4095
}
},
"additionalProperties":false
}
Nested Schema : begin
Starting point for data processing
Default Value: {
"sequence":0,
"offset":0
}
Match One
Show Source
-
Allowed Values: [
"now"
]
-
string
Minimum Length: 20
Maximum Length: 32
Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
-
object begin-x-oneOf[2]
{
"description":"Starting point for data processing",
"default":{
"sequence":0,
"offset":0
},
"x-oneOf":[
{
"enum":[
"now"
]
},
{
"type":"string",
"pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
"minLength":20,
"maxLength":32
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"type:position/atTrailRBA"
]
},
"sequence":{
"description":"Trail file sequence number",
"type":"integer",
"minimum":0,
"maximum":999999999,
"default":0
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":0,
"default":0,
"maximum":2147483647
}
},
"required":[
"sequence"
],
"additionalProperties":false
}
]
}
Nested Schema : options
Type: object
options for the distribution path
Show Source
{
"description":"options for the distribution path",
"type":"object",
"properties":{
"tcpSourceTimer":{
"description":"Adjusts the timestamp of data records when they are sent to other systems",
"type":"boolean",
"default":true
},
"reportCount":{
"description":"Reportcount option to report a count of transactions records processed by DS.",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:reportcountOption"
]
},
"measurementUnit":{
"description":"The unit of measure for count.",
"type":"string",
"enum":[
"records",
"seconds",
"minutes",
"hours"
]
},
"count":{
"description":"The interval after which to output a count.",
"type":"integer",
"minimum":1,
"maximum":4.294967295E9,
"default":5000
},
"rate":{
"description":"Report the number of operations per second and the change in rate, as a measurment of performance.",
"type":"boolean",
"default":true
}
},
"required":[
"measurementUnit"
],
"additionalProperties":false
},
"network":{
"description":"Endpoint network details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:networkOptions"
]
},
"socketOptions":{
"description":"socket options",
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"tcpKeepAliveTimeout":{
"description":"Timeout (seconds) for keep-alive",
"type":"integer",
"default":60,
"minimum":1,
"maximum":10800
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":-1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
]
},
"appOptions":{
"description":"application options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:appOptions"
]
},
"appFlushBytes":{
"description":"application flush size",
"type":"integer",
"default":27985,
"minimum":1024,
"maximum":524288
},
"appFlushSecs":{
"description":"application flush interval",
"type":"integer",
"default":1,
"minimum":1,
"maximum":300
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
"$schema":{
"enum":[
"ogg:distPathOptions"
]
},
"streaming":{
"description":"Asynchronous network streaming protocol where sender does not wait for an acknowledgement from the receiver.",
"type":"boolean",
"default":true
},
"critical":{
"description":"Indicates the distribution path is critical to the deployment",
"type":"boolean",
"default":false
},
"autoRestart":{
"description":"Describe if a killed path needs to be restarted automatically",
"type":"object",
"properties":{
"retries":{
"description":"maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0",
"type":"integer",
"minimum":0,
"maximum":3600,
"default":10
},
"delay":{
"description":"The amount of time, in minutes, to pause between restarting the path.",
"type":"integer",
"minimum":0,
"default":2,
"maximum":60
}
},
"required":[
"retries"
],
"additionalProperties":false
},
"eofDelayCSecs":{
"description":"EOF delay in centi-seconds before searching for source data",
"type":"integer",
"minimum":1,
"default":10,
"maximum":6000
},
"checkpointFrequency":{
"description":"Frequency in seconds for path taking routine checkpoints.",
"type":"integer",
"minimum":1,
"default":10,
"maximum":4.294967295E9
}
},
"additionalProperties":false
}
Nested Schema : ruleset
Match One
Show Source
{
"x-oneOf":[
{
"description":"Ruleset for the distribution path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRuleset"
]
},
"name":{
"description":"name of the path ruleset",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path ruleset",
"type":"string",
"minLength":1,
"maxLength":4095
},
"rules":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"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",
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathPartitionNames"
]
},
"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
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
}
},
"required":[
"rules"
],
"additionalProperties":false
},
{
"type":"null"
}
]
}
Nested Schema : source
Type: object
source endpoint of the path
Show Source
{
"description":"source endpoint of the path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpoint"
]
},
"description":{
"description":"Description for the endpoint",
"type":"string",
"minLength":1,
"maxLength":4095
},
"uri":{
"description":"endpoint URI specification",
"x-oneOf":[
{
"type":"array",
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"minItems":1,
"maxItems":2147483647
},
{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
}
]
},
"proxy":{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
},
"details":{
"description":"endpoint detail information",
"type":"object"
},
"isDynamicOggPort":{
"description":"If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).",
"type":"boolean",
"default":true
},
"authenticationMethod":{
"description":"Authentication method to use when starting the path",
"x-oneOf":[
{
"description":"OAuth2.0 Client Credentials authentication",
"enum":[
"oauth2ClientCredentials"
]
},
{
"type":"object",
"description":"Certificate authentication",
"properties":{
"certificate":{
"description":"Certificate name",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$",
"minLength":1,
"maxLength":32
}
},
"additionalProperties":false,
"required":[
"certificate"
]
},
{
"description":"Credentials authentication",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
]
}
},
"additionalProperties":false
}
Nested Schema : status
Oracle GoldenGate Distribution Path Status
Default Value: stopped
Match One
Show Source
-
Default Value: stopped
Allowed Values: [
"paused",
"running",
"stopping",
"stopped",
"killed",
"uninitialized"
]
-
object status-x-oneOf[1]
Extended options for starting a distribution path
-
object status-x-oneOf[2]
Extended options for stopping a distribution path
{
"description":"Oracle GoldenGate Distribution Path Status",
"default":"stopped",
"x-oneOf":[
{
"enum":[
"paused",
"running",
"stopping",
"stopped",
"killed",
"uninitialized"
],
"default":"stopped"
},
{
"type":"object",
"description":"Extended options for starting a distribution path",
"x-oneOf":[
{
"type":"object",
"properties":{
"desired":{
"enum":[
"running"
]
},
"at":{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
},
"additionalProperties":false,
"required":[
"desired",
"at"
]
},
{
"type":"object",
"properties":{
"desired":{
"enum":[
"running"
]
},
"after":{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
},
"additionalProperties":false,
"required":[
"desired",
"after"
]
}
]
},
{
"type":"object",
"description":"Extended options for stopping a distribution path",
"properties":{
"desired":{
"enum":[
"stopped"
]
},
"force":{
"type":"boolean",
"default":false
}
},
"additionalProperties":false,
"required":[
"desired",
"force"
]
}
]
}
Nested Schema : target
Type: object
target endpoint of the path
Show Source
{
"description":"target endpoint of the path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpoint"
]
},
"description":{
"description":"Description for the endpoint",
"type":"string",
"minLength":1,
"maxLength":4095
},
"uri":{
"description":"endpoint URI specification",
"x-oneOf":[
{
"type":"array",
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"minItems":1,
"maxItems":2147483647
},
{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
}
]
},
"proxy":{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
},
"details":{
"description":"endpoint detail information",
"type":"object"
},
"isDynamicOggPort":{
"description":"If the trail URI starts with 'ogg://' then this property specifies if it is a static port (recvsrvr acting as a legacy collector) or a dynamic port (legacy installation, so the port in the URI is the mgr port).",
"type":"boolean",
"default":true
},
"authenticationMethod":{
"description":"Authentication method to use when starting the path",
"x-oneOf":[
{
"description":"OAuth2.0 Client Credentials authentication",
"enum":[
"oauth2ClientCredentials"
]
},
{
"type":"object",
"description":"Certificate authentication",
"properties":{
"certificate":{
"description":"Certificate name",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$",
"minLength":1,
"maxLength":32
}
},
"additionalProperties":false,
"required":[
"certificate"
]
},
{
"description":"Credentials authentication",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
]
}
},
"additionalProperties":false
}
Nested Schema : begin-x-oneOf[2]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"type:position/atTrailRBA"
]
},
"sequence":{
"description":"Trail file sequence number",
"type":"integer",
"minimum":0,
"maximum":999999999,
"default":0
},
"offset":{
"description":"Offset in trail sequence file",
"type":"integer",
"minimum":0,
"default":0,
"maximum":2147483647
}
},
"required":[
"sequence"
],
"additionalProperties":false
}
Nested Schema : autoRestart
Type: object
Describe if a killed path needs to be restarted automatically
Show Source
-
delay(optional):
integer
Minimum Value: 0
Maximum Value: 60
Default Value: 2
The amount of time, in minutes, to pause between restarting the path.
-
retries:
integer
Minimum Value: 0
Maximum Value: 3600
Default Value: 10
maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0
{
"description":"Describe if a killed path needs to be restarted automatically",
"type":"object",
"properties":{
"retries":{
"description":"maximum number of retries for restarting a killed path, disable autoRestart by setting retries to 0",
"type":"integer",
"minimum":0,
"maximum":3600,
"default":10
},
"delay":{
"description":"The amount of time, in minutes, to pause between restarting the path.",
"type":"integer",
"minimum":0,
"default":2,
"maximum":60
}
},
"required":[
"retries"
],
"additionalProperties":false
}
Nested Schema : network
Type: object
Endpoint network details
Show Source
{
"description":"Endpoint network details",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:networkOptions"
]
},
"socketOptions":{
"description":"socket options",
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"tcpKeepAliveTimeout":{
"description":"Timeout (seconds) for keep-alive",
"type":"integer",
"default":60,
"minimum":1,
"maximum":10800
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":-1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
]
},
"appOptions":{
"description":"application options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:appOptions"
]
},
"appFlushBytes":{
"description":"application flush size",
"type":"integer",
"default":27985,
"minimum":1024,
"maximum":524288
},
"appFlushSecs":{
"description":"application flush interval",
"type":"integer",
"default":1,
"minimum":1,
"maximum":300
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : reportCount
Type: object
Reportcount option to report a count of transactions records processed by DS.
Show Source
-
$schema(optional):
Allowed Values: [
"ogg:reportcountOption"
]
-
count(optional):
integer
Minimum Value: 1
Maximum Value: 4.294967295E9
Default Value: 5000
The interval after which to output a count.
-
measurementUnit:
string
Allowed Values: [
"records",
"seconds",
"minutes",
"hours"
]
The unit of measure for count.
-
rate(optional):
boolean
Default Value: true
Report the number of operations per second and the change in rate, as a measurment of performance.
{
"description":"Reportcount option to report a count of transactions records processed by DS.",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:reportcountOption"
]
},
"measurementUnit":{
"description":"The unit of measure for count.",
"type":"string",
"enum":[
"records",
"seconds",
"minutes",
"hours"
]
},
"count":{
"description":"The interval after which to output a count.",
"type":"integer",
"minimum":1,
"maximum":4.294967295E9,
"default":5000
},
"rate":{
"description":"Report the number of operations per second and the change in rate, as a measurment of performance.",
"type":"boolean",
"default":true
}
},
"required":[
"measurementUnit"
],
"additionalProperties":false
}
Nested Schema : appOptions
Type: object
application options
Show Source
{
"description":"application options",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:appOptions"
]
},
"appFlushBytes":{
"description":"application flush size",
"type":"integer",
"default":27985,
"minimum":1024,
"maximum":524288
},
"appFlushSecs":{
"description":"application flush interval",
"type":"integer",
"default":1,
"minimum":1,
"maximum":300
}
},
"additionalProperties":false
}
Nested Schema : socketOptions
socket options
Match One
Show Source
{
"description":"socket options",
"x-oneOf":[
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"tcpKeepAliveTimeout":{
"description":"Timeout (seconds) for keep-alive",
"type":"integer",
"default":60,
"minimum":1,
"maximum":10800
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
}
},
"additionalProperties":false
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":-1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
]
}
Nested Schema : socketOptions-x-oneOf[0]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:tcpOptions"
]
},
"tcpOptions":{
"description":"tcp tuning options",
"type":"object",
"properties":{
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"tcpKeepAliveTimeout":{
"description":"Timeout (seconds) for keep-alive",
"type":"integer",
"default":60,
"minimum":1,
"maximum":10800
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : socketOptions-x-oneOf[1]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:udpOptions"
]
},
"udpOptions":{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":-1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
},
"additionalProperties":false
}
Nested Schema : tcpOptions
Type: object
tcp tuning options
Show Source
-
$schema(optional):
Allowed Values: [
"ogg:tcpOption"
]
-
ipDscp(optional):
Allowed Values: [
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
network differentiated services
-
ipTos(optional):
Allowed Values: [
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
term of services
-
tcpCork(optional):
boolean
Whether use Nagle algorithm cork option or not
-
tcpKeepAliveTimeout(optional):
integer
Minimum Value: 1
Maximum Value: 10800
Default Value: 60
Timeout (seconds) for keep-alive
-
tcpNoDelay(optional):
boolean
Default Value: true
nodelay in Nagle's option
-
tcpQuickAck(optional):
boolean
send out acknowledgements as early as possible
-
tcpRcvBuf(optional):
integer
Minimum Value: 1024
Maximum Value: 4.294967295E9
system receive buffer size
-
tcpSndBuf(optional):
integer
Minimum Value: 1024
Maximum Value: 4.294967295E9
system send buffer size
{
"description":"tcp tuning options",
"type":"object",
"properties":{
"ipDscp":{
"description":"network differentiated services",
"enum":[
"DEFAULT",
"AF11",
"AF12",
"AF13",
"AF21",
"AF22",
"AF23",
"AF31",
"AF32",
"AF33",
"AF41",
"AF42",
"AF43",
"EF"
]
},
"tcpKeepAliveTimeout":{
"description":"Timeout (seconds) for keep-alive",
"type":"integer",
"default":60,
"minimum":1,
"maximum":10800
},
"tcpNoDelay":{
"description":"nodelay in Nagle's option",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:tcpOption"
]
},
"tcpSndBuf":{
"description":"system send buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpQuickAck":{
"description":"send out acknowledgements as early as possible",
"type":"boolean"
},
"tcpRcvBuf":{
"description":"system receive buffer size",
"type":"integer",
"minimum":1024,
"maximum":4.294967295E9
},
"tcpCork":{
"description":"Whether use Nagle algorithm cork option or not",
"type":"boolean"
},
"ipTos":{
"description":"term of services",
"enum":[
"DEFAULT",
"LOWCOST",
"RELIABILITY",
"THROUGHPUT",
"LOWDELAY"
]
}
},
"additionalProperties":false
}
Nested Schema : udpOptions
Type: object
udp tuning options
Show Source
{
"description":"udp tuning options",
"type":"object",
"properties":{
"udpRcvBuf":{
"description":"UDP socket receiver buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtRendezvous":{
"description":"Rendezvous connection setup.",
"type":"boolean",
"default":false
},
"udpSndBuf":{
"description":"UDP socket sender buffer size (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtSndTimeO":{
"description":"Sending call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndSyn":{
"description":"Synchronization mode of data sending.",
"type":"boolean"
},
"udtFC":{
"description":"Maximum window size (packets)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtCC":{
"description":"User defined congestion control algorithm.",
"enum":[
"DEFAULT"
]
},
"udtRcvTimeO":{
"description":"Receiving call timeout (milliseconds).",
"type":"integer",
"minimum":-1,
"maximum":1000000000
},
"udtSndBuf":{
"description":"UDT sender buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtReuseAddr":{
"description":"Reuse an existing address or create a new one.",
"type":"boolean",
"default":true
},
"$schema":{
"enum":[
"ogg:udpOption"
]
},
"udtSltTimeO":{
"description":"Select call timeout (Seconds).",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtRcvBuf":{
"description":"UDT receiver buffer size limit (bytes)",
"type":"integer",
"minimum":1,
"maximum":2147483647
},
"udtMaxBW":{
"description":"Maximum bandwidth that one single UDT connection can use (bytes per second).",
"type":"integer",
"minimum":-1,
"maximum":2147483647
},
"udtRcvSyn":{
"description":"Synchronization mode for receiving.",
"type":"boolean"
},
"udtLinger":{
"description":"Linger time on close().",
"type":"integer",
"minimum":0,
"maximum":1000000000
},
"udtMss":{
"description":"Maximum packet size (bytes).",
"type":"integer",
"minimum":1,
"maximum":2147483647
}
},
"additionalProperties":false
}
Nested Schema : ruleset-x-oneOf[0]
Type: object
Ruleset for the distribution path
Show Source
{
"description":"Ruleset for the distribution path",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRuleset"
]
},
"name":{
"description":"name of the path ruleset",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path ruleset",
"type":"string",
"minLength":1,
"maxLength":4095
},
"rules":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"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",
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathPartitionNames"
]
},
"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
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
}
},
"required":[
"rules"
],
"additionalProperties":false
}
Nested Schema : rules
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 1024
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"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",
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathPartitionNames"
]
},
"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
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":1024
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathRule"
]
},
"name":{
"description":"name of the rule",
"type":"string",
"minLength":1,
"maxLength":30
},
"description":{
"description":"Description for the path rule",
"type":"string",
"minLength":1,
"maxLength":4095
},
"filters":{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"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",
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathPartitionNames"
]
},
"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
}
]
},
"minItems":1,
"maxItems":4096
},
"filterRelation":{
"description":"relationship among the filters",
"enum":[
"and",
"or"
],
"default":"or"
},
"actions":{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
},
"required":[
"name",
"filters",
"actions"
],
"additionalProperties":false
}
Nested Schema : actions
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
Show Source
{
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":128
}
Nested Schema : filters
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 4096
Show Source
{
"type":"array",
"items":{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"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",
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathPartitionNames"
]
},
"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
}
]
},
"minItems":1,
"maxItems":4096
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathAction"
]
},
"description":{
"description":"Description for the path action",
"type":"string",
"minLength":1,
"maxLength":4095
},
"command":{
"enum":[
"include",
"exclude"
],
"default":"include"
}
},
"required":[
"command"
],
"additionalProperties":false
}
Nested Schema : items
Match One
Show Source
{
"x-oneOf":[
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"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",
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathPartitionNames"
]
},
"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 : items-x-oneOf[0]
Type: object
Show Source
{
"type":"object",
"properties":{
"chunkIds":{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIds"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[1]
Type: object
Show Source
{
"type":"object",
"properties":{
"chunkIdRanges":{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"chunkIdRanges"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[2]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathObjectNames"
]
},
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectNames"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[3]
Type: object
Show Source
{
"type":"object",
"properties":{
"objectTypes":{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"objectTypes"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[4]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathColumnValues"
]
},
"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",
"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
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"columnValues"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[5]
Type: object
Show Source
{
"type":"object",
"properties":{
"tags":{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"tags"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[6]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathProcedureFeatureNames"
]
},
"procedureFeatureNames":{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
},
"negate":{
"description":"negation of the above set",
"type":"boolean",
"default":false
}
},
"required":[
"procedureFeatureNames"
],
"additionalProperties":false
}
Nested Schema : items-x-oneOf[7]
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathPartitionNames"
]
},
"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 : chunkIds
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 2147483647
set of chunk ids
Show Source
{
"type":"array",
"description":"set of chunk ids",
"items":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"minItems":0,
"maxItems":2147483647
}
Nested Schema : chunkIdRanges
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
set of chunk id ranges
Show Source
{
"type":"array",
"description":"set of chunk id ranges",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"additionalProperties":false
},
"minItems":1,
"maxItems":2147483647
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathChunkidRange"
]
},
"chunkIdBegin":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
},
"chunkIdEnd":{
"type":"integer",
"minimum":1,
"maximum":4.294967295E9
}
},
"required":[
"chunkIdBegin",
"chunkIdEnd"
],
"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 : objectTypes
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 7
set of object types
Show Source
-
Array of:
Allowed Values: [
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
{
"type":"array",
"description":"set of object types",
"items":{
"enum":[
"DML",
"DDL",
"Procedure",
"INSERT",
"UPDATE",
"UPSERT",
"DELETE"
]
},
"minItems":1,
"maxItems":7
}
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",
"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:
string
Minimum Length: 1
Maximum Length: 130
Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
name of the column
-
columnValue:
columnValue
column data, currently only support char and binary integer
-
imageType(optional):
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(optional):
Default Value: equalTo
Allowed Values: [
"equalTo",
"notEqualTo",
"lessThan",
"lessThanOrEqualTo",
"greaterThan",
"greaterThanOrEqualTo"
]
comparison operator
-
tableName:
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",
"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
Match One
Show Source
{
"description":"column data, currently only support char and binary integer",
"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 tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag
Match One
Show Source
{
"description":"set of tags. specify 'all' for LCRs with any valid tag values and 'none' for LCRs without tag",
"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":2147483647
},
{
"enum":[
"all",
"none"
]
}
]
}
Nested Schema : tags-x-oneOf[0]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
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":2147483647
}
Nested Schema : procedureFeatureNames
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 32
set of procedure feature names
Show Source
-
Array of:
string
Minimum Length: 1
Maximum Length: 128
Pattern: ^[*a-zA-Z][*a-zA-Z0-9_#$]*$
{
"description":"set of procedure feature names",
"type":"array",
"items":{
"type":"string",
"pattern":"^[*a-zA-Z][*a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":128
},
"minItems":1,
"maxItems":32
}
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 : authenticationMethod
Authentication method to use when starting the path
Match One
Show Source
{
"description":"Authentication method to use when starting the path",
"x-oneOf":[
{
"description":"OAuth2.0 Client Credentials authentication",
"enum":[
"oauth2ClientCredentials"
]
},
{
"type":"object",
"description":"Certificate authentication",
"properties":{
"certificate":{
"description":"Certificate name",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$",
"minLength":1,
"maxLength":32
}
},
"additionalProperties":false,
"required":[
"certificate"
]
},
{
"description":"Credentials authentication",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
]
}
Nested Schema : details
Type: object
endpoint detail information
Nested Schema : proxy
Type: object
proxy to connect to target
Show Source
-
$schema(optional):
Allowed Values: [
"ogg:distPathEndpointProxy"
]
-
csAlias(optional):
string
Minimum Length: 1
Maximum Length: 30
Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Credential store alias
-
csDomain(optional):
string
Minimum Length: 1
Maximum Length: 30
Default Value: OracleGoldenGate
Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Credential store domain
-
type:
string
Allowed Values: [
"SOCKS5",
"HTTP"
]
Type of the proxy server
-
uri:
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
Uri of the proxy server
{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
}
Nested Schema : uri
endpoint URI specification
Match One
Show Source
-
array uri-x-oneOf[0]
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
-
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
{
"description":"endpoint URI specification",
"x-oneOf":[
{
"type":"array",
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"minItems":1,
"maxItems":2147483647
},
{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
}
]
}
Nested Schema : authenticationMethod-x-oneOf[1]
Type: object
Certificate authentication
Show Source
-
certificate:
string
Minimum Length: 1
Maximum Length: 32
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
Certificate name
{
"type":"object",
"description":"Certificate authentication",
"properties":{
"certificate":{
"description":"Certificate name",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$",
"minLength":1,
"maxLength":32
}
},
"additionalProperties":false,
"required":[
"certificate"
]
}
Nested Schema : authenticationMethod-x-oneOf[2]
Type: object
Credentials authentication
Show Source
{
"description":"Credentials authentication",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : uri-x-oneOf[0]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
Show Source
-
Array of:
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
{
"type":"array",
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"minItems":1,
"maxItems":2147483647
}
Nested Schema : status-x-oneOf[1]
Type: object
Extended options for starting a distribution path
Match One
Show Source
{
"type":"object",
"description":"Extended options for starting a distribution path",
"x-oneOf":[
{
"type":"object",
"properties":{
"desired":{
"enum":[
"running"
]
},
"at":{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
},
"additionalProperties":false,
"required":[
"desired",
"at"
]
},
{
"type":"object",
"properties":{
"desired":{
"enum":[
"running"
]
},
"after":{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
},
"additionalProperties":false,
"required":[
"desired",
"after"
]
}
]
}
Nested Schema : status-x-oneOf[2]
Type: object
Extended options for stopping a distribution path
Show Source
{
"type":"object",
"description":"Extended options for stopping a distribution path",
"properties":{
"desired":{
"enum":[
"stopped"
]
},
"force":{
"type":"boolean",
"default":false
}
},
"additionalProperties":false,
"required":[
"desired",
"force"
]
}
Nested Schema : status-x-oneOf[1]-x-oneOf[0]
Type: object
Show Source
{
"type":"object",
"properties":{
"desired":{
"enum":[
"running"
]
},
"at":{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
},
"additionalProperties":false,
"required":[
"desired",
"at"
]
}
Nested Schema : status-x-oneOf[1]-x-oneOf[1]
Type: object
Show Source
{
"type":"object",
"properties":{
"desired":{
"enum":[
"running"
]
},
"after":{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
},
"additionalProperties":false,
"required":[
"desired",
"after"
]
}
Nested Schema : at
Match One
Show Source
-
integer
Minimum Value: 0
Maximum Value: 9.223372036854776E18
System Change Number(Normal Format) for Oracle Database.
Example: 6488359
-
string
Minimum Length: 3
Maximum Length: 64
Pattern: [0-9]+[.][0-9]+
System Change Number(Alternate Format) for Oracle Database.
Example: 6488359.3456712
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
Nested Schema : after
Match One
Show Source
-
integer
Minimum Value: 0
Maximum Value: 9.223372036854776E18
System Change Number(Normal Format) for Oracle Database.
Example: 6488359
-
string
Minimum Length: 3
Maximum Length: 64
Pattern: [0-9]+[.][0-9]+
System Change Number(Alternate Format) for Oracle Database.
Example: 6488359.3456712
{
"x-oneOf":[
{
"description":"System Change Number(Normal Format) for Oracle Database.",
"type":"integer",
"minimum":0,
"maximum":9.223372036854776E18,
"example":"6488359"
},
{
"description":"System Change Number(Alternate Format) for Oracle Database.",
"type":"string",
"pattern":"[0-9]+[.][0-9]+",
"minLength":3,
"maxLength":64,
"example":"6488359.3456712"
}
]
}
Nested Schema : authenticationMethod
Authentication method to use when starting the path
Match One
Show Source
{
"description":"Authentication method to use when starting the path",
"x-oneOf":[
{
"description":"OAuth2.0 Client Credentials authentication",
"enum":[
"oauth2ClientCredentials"
]
},
{
"type":"object",
"description":"Certificate authentication",
"properties":{
"certificate":{
"description":"Certificate name",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$",
"minLength":1,
"maxLength":32
}
},
"additionalProperties":false,
"required":[
"certificate"
]
},
{
"description":"Credentials authentication",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
]
}
Nested Schema : details
Type: object
endpoint detail information
Nested Schema : proxy
Type: object
proxy to connect to target
Show Source
-
$schema(optional):
Allowed Values: [
"ogg:distPathEndpointProxy"
]
-
csAlias(optional):
string
Minimum Length: 1
Maximum Length: 30
Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Credential store alias
-
csDomain(optional):
string
Minimum Length: 1
Maximum Length: 30
Default Value: OracleGoldenGate
Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]*$
Credential store domain
-
type:
string
Allowed Values: [
"SOCKS5",
"HTTP"
]
Type of the proxy server
-
uri:
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
Uri of the proxy server
{
"description":"proxy to connect to target",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:distPathEndpointProxy"
]
},
"uri":{
"description":"Uri of the proxy server",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"type":{
"description":"Type of the proxy server",
"type":"string",
"enum":[
"SOCKS5",
"HTTP"
]
},
"csAlias":{
"description":"Credential store alias",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
},
"csDomain":{
"description":"Credential store domain",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
}
},
"required":[
"uri",
"type"
],
"additionalProperties":false
}
Nested Schema : uri
endpoint URI specification
Match One
Show Source
-
array uri-x-oneOf[0]
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
-
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
{
"description":"endpoint URI specification",
"x-oneOf":[
{
"type":"array",
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"minItems":1,
"maxItems":2147483647
},
{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
}
]
}
Nested Schema : authenticationMethod-x-oneOf[1]
Type: object
Certificate authentication
Show Source
-
certificate:
string
Minimum Length: 1
Maximum Length: 32
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
Certificate name
{
"type":"object",
"description":"Certificate authentication",
"properties":{
"certificate":{
"description":"Certificate name",
"type":"string",
"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$",
"minLength":1,
"maxLength":32
}
},
"additionalProperties":false,
"required":[
"certificate"
]
}
Nested Schema : authenticationMethod-x-oneOf[2]
Type: object
Credentials authentication
Show Source
{
"description":"Credentials authentication",
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:credentialsRef"
]
},
"domain":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30,
"default":"OracleGoldenGate"
},
"alias":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
"minLength":1,
"maxLength":30
}
},
"required":[
"alias"
],
"additionalProperties":false
}
Nested Schema : uri-x-oneOf[0]
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 2147483647
Show Source
-
Array of:
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
{
"type":"array",
"items":{
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":2,
"maxLength":4095
},
"minItems":1,
"maxItems":2147483647
}