Root Schema : Configuration Service Backend Summary
Type: object
Title: Configuration Service Backend Summary
A list of storage backends known to Configuration Service
Show Source
{
"title":"Configuration Service Backend Summary",
"description":"A list of storage backends known to Configuration Service",
"required":[
"$schema",
"items"
],
"type":"object",
"properties":{
"$schema":{
"description":"The unique identifier for this JSON schema",
"type":"string",
"enum":[
"config:backends"
]
},
"items":{
"description":"Array of known Backends",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"Unique identifier for the Backend",
"type":"string",
"format":"uuid"
},
"configuration":{
"description":"Additional configuration data needed by the Backend",
"x-anyOf":[
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for storing configuration data.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"ensemble":{
"description":"Addresses of one or more members of the HAMIWS ensemble",
"type":"array",
"items":{
"type":"object",
"properties":{
"host":{
"description":"Host name or IP Address",
"x-oneOf":[
{
"description":"Network host name",
"type":"string",
"pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
"minLength":"1",
"maxLength":"4095"
},
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
]
},
"port":{
"description":"IP Port number",
"type":"integer",
"minimum":"1",
"maximum":"65535"
}
},
"required":[
"host",
"port"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"64"
},
"certificatePem":{
"description":"Client certificate to use when connecting to the ensemble.",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"privateKeyPem":{
"description":"Private key for the client certificate",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"caCertificates":{
"description":"A collection of CA certificates to use when connecting to the ensemble.",
"type":"array",
"minItems":"1",
"maxItems":"128",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"523288"
}
}
},
"required":[
"ensemble",
"certificatePem",
"caCertificates"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"version":{
"description":"The OGG version that this legacy backend represents.",
"type":"string",
"enum":[
"21c"
]
}
},
"required":[
"version"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"uri":{
"description":"The URI for the MongoDB server.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"username":{
"description":"The name of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"512"
},
"password":{
"description":"The password of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"database":{
"description":"The name of the MongoDB database. The default value is `config:configurationFile:installationId`.",
"type":"string",
"pattern":"^[^\\/\\\\. \"$*<>:|?]{1,63}$",
"minLength":"1",
"maxLength":"63"
},
"collection":{
"description":"The name of the MongoDB collection. The default value is `config:backend:id`.",
"type":"string",
"pattern":"^[^$]{0,255}$",
"minLength":"1",
"maxLength":"255"
}
},
"required":[
"uri"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"connectionString":{
"description":"Information used to identify and connect to an Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"username":{
"description":"The name of the user defined in the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"password":{
"description":"The password of the user for authenticating with the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"tableName":{
"description":"The name of the Oracle table to use. The default value is `config:backend:id`.",
"type":"string",
"minLength":"1",
"maxLength":"512"
}
},
"required":[
"connectionString"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for the Oracle Wallet",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"serialized":{
"description":"Indicates the Oracle Wallet should be serialized to the 'data' property",
"type":"boolean",
"default":false
},
"data":{
"description":"The base64 encoded Oracle Wallet data - up to 100MB",
"maxLength":"139810134",
"type":"string",
"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$",
"minLength":"4"
}
},
"additionalProperties":false
}
]
},
"name":{
"description":"Human-friendly name for the Backend",
"type":"string",
"minLength":"1",
"maxLength":"512"
},
"replacedBy":{
"description":"The Backend that replaced this backend",
"type":"string",
"format":"uuid"
},
"encrypted":{
"description":"If true, data is encrypted at rest in the Backend",
"type":"boolean",
"default":false
},
"$schema":{
"description":"The unique identifier for this JSON schema",
"type":"string",
"enum":[
"config:backend"
]
},
"encryptionKey":{
"description":"The key to use for encrypting data in the Backend; if not specified, a random key will be generated",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"readOnly":{
"description":"This Backend does not accept any requests that modify data",
"type":"boolean",
"default":false
},
"type":{
"description":"The type of the Backend",
"type":"string",
"enum":[
"Files",
"HAMIWS",
"Legacy",
"Memory",
"MongoDB",
"Oracle",
"Wallet"
]
},
"messages":{
"description":"Oracle GoldenGate messages issued during the request",
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:message"
]
},
"type":{
"description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"title":{
"description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
"type":"string",
"minLength":"1",
"maxLength":"4095"
},
"code":{
"description":"The Oracle GoldenGate message code",
"type":"string",
"pattern":"^OGG[-][0-9]{5}$",
"minLength":"9",
"maxLength":"9"
},
"severity":{
"description":"The severity of the message",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"issued":{
"description":"The date and time that the message was issued",
"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"
}
},
"required":[
"type",
"title",
"code",
"severity",
"issued"
],
"additionalProperties":false
},
"minItems":"0",
"maxItems":"65535"
},
"locked":{
"description":"This Backend does not accept any requests",
"type":"boolean",
"default":false
},
"options":{
"description":"Configuration options for the Backend",
"type":"array",
"items":{
"x-anyOf":[
{
"description":"Data item names may be repeated for children of the same parent",
"type":"string",
"enum":[
"duplicateNames"
]
}
]
},
"minItems":"0",
"maxItems":"1"
},
"replaced":{
"description":"The Backends that this backend replaced",
"type":"array",
"items":{
"type":"string",
"format":"uuid"
},
"minItems":"1",
"maxItems":"512"
}
},
"additionalProperties":false
},
"minItems":"0",
"maxItems":"1024"
}
},
"additionalProperties":false,
"example":{
"$schema":"config:backends",
"items":[
{
"id":"5086c4c1-4f48-4c13-9fad-095f23072a5b",
"name":"Default Filesystem",
"type":"Files"
}
]
}
}
Example:
{
"$schema":"config:backends",
"items":[
{
"id":"5086c4c1-4f48-4c13-9fad-095f23072a5b",
"name":"Default Filesystem",
"type":"Files"
}
]
}
Nested Schema : items
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Array of known Backends
Show Source
{
"description":"Array of known Backends",
"type":"array",
"items":{
"type":"object",
"properties":{
"id":{
"description":"Unique identifier for the Backend",
"type":"string",
"format":"uuid"
},
"configuration":{
"description":"Additional configuration data needed by the Backend",
"x-anyOf":[
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for storing configuration data.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"ensemble":{
"description":"Addresses of one or more members of the HAMIWS ensemble",
"type":"array",
"items":{
"type":"object",
"properties":{
"host":{
"description":"Host name or IP Address",
"x-oneOf":[
{
"description":"Network host name",
"type":"string",
"pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
"minLength":"1",
"maxLength":"4095"
},
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
]
},
"port":{
"description":"IP Port number",
"type":"integer",
"minimum":"1",
"maximum":"65535"
}
},
"required":[
"host",
"port"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"64"
},
"certificatePem":{
"description":"Client certificate to use when connecting to the ensemble.",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"privateKeyPem":{
"description":"Private key for the client certificate",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"caCertificates":{
"description":"A collection of CA certificates to use when connecting to the ensemble.",
"type":"array",
"minItems":"1",
"maxItems":"128",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"523288"
}
}
},
"required":[
"ensemble",
"certificatePem",
"caCertificates"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"version":{
"description":"The OGG version that this legacy backend represents.",
"type":"string",
"enum":[
"21c"
]
}
},
"required":[
"version"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"uri":{
"description":"The URI for the MongoDB server.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"username":{
"description":"The name of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"512"
},
"password":{
"description":"The password of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"database":{
"description":"The name of the MongoDB database. The default value is `config:configurationFile:installationId`.",
"type":"string",
"pattern":"^[^\\/\\\\. \"$*<>:|?]{1,63}$",
"minLength":"1",
"maxLength":"63"
},
"collection":{
"description":"The name of the MongoDB collection. The default value is `config:backend:id`.",
"type":"string",
"pattern":"^[^$]{0,255}$",
"minLength":"1",
"maxLength":"255"
}
},
"required":[
"uri"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"connectionString":{
"description":"Information used to identify and connect to an Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"username":{
"description":"The name of the user defined in the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"password":{
"description":"The password of the user for authenticating with the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"tableName":{
"description":"The name of the Oracle table to use. The default value is `config:backend:id`.",
"type":"string",
"minLength":"1",
"maxLength":"512"
}
},
"required":[
"connectionString"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for the Oracle Wallet",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"serialized":{
"description":"Indicates the Oracle Wallet should be serialized to the 'data' property",
"type":"boolean",
"default":false
},
"data":{
"description":"The base64 encoded Oracle Wallet data - up to 100MB",
"maxLength":"139810134",
"type":"string",
"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$",
"minLength":"4"
}
},
"additionalProperties":false
}
]
},
"name":{
"description":"Human-friendly name for the Backend",
"type":"string",
"minLength":"1",
"maxLength":"512"
},
"replacedBy":{
"description":"The Backend that replaced this backend",
"type":"string",
"format":"uuid"
},
"encrypted":{
"description":"If true, data is encrypted at rest in the Backend",
"type":"boolean",
"default":false
},
"$schema":{
"description":"The unique identifier for this JSON schema",
"type":"string",
"enum":[
"config:backend"
]
},
"encryptionKey":{
"description":"The key to use for encrypting data in the Backend; if not specified, a random key will be generated",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"readOnly":{
"description":"This Backend does not accept any requests that modify data",
"type":"boolean",
"default":false
},
"type":{
"description":"The type of the Backend",
"type":"string",
"enum":[
"Files",
"HAMIWS",
"Legacy",
"Memory",
"MongoDB",
"Oracle",
"Wallet"
]
},
"messages":{
"description":"Oracle GoldenGate messages issued during the request",
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:message"
]
},
"type":{
"description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"title":{
"description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
"type":"string",
"minLength":"1",
"maxLength":"4095"
},
"code":{
"description":"The Oracle GoldenGate message code",
"type":"string",
"pattern":"^OGG[-][0-9]{5}$",
"minLength":"9",
"maxLength":"9"
},
"severity":{
"description":"The severity of the message",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"issued":{
"description":"The date and time that the message was issued",
"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"
}
},
"required":[
"type",
"title",
"code",
"severity",
"issued"
],
"additionalProperties":false
},
"minItems":"0",
"maxItems":"65535"
},
"locked":{
"description":"This Backend does not accept any requests",
"type":"boolean",
"default":false
},
"options":{
"description":"Configuration options for the Backend",
"type":"array",
"items":{
"x-anyOf":[
{
"description":"Data item names may be repeated for children of the same parent",
"type":"string",
"enum":[
"duplicateNames"
]
}
]
},
"minItems":"0",
"maxItems":"1"
},
"replaced":{
"description":"The Backends that this backend replaced",
"type":"array",
"items":{
"type":"string",
"format":"uuid"
},
"minItems":"1",
"maxItems":"512"
}
},
"additionalProperties":false
},
"minItems":"0",
"maxItems":"1024"
}
Nested Schema : items
Type: object
Show Source
-
$schema:
string
Allowed Values: [
"config:backend"
]
The unique identifier for this JSON schema
-
configuration:
configuration
Additional configuration data needed by the Backend
-
encrypted:
boolean
Default Value: false
If true, data is encrypted at rest in the Backend
-
encryptionKey:
string
Minimum Length: 1
Maximum Length: 256
The key to use for encrypting data in the Backend; if not specified, a random key will be generated
-
id:
string(uuid)
Unique identifier for the Backend
-
locked:
boolean
Default Value: false
This Backend does not accept any requests
-
messages:
array messages
Minimum Number of Items: 0
Maximum Number of Items: 65535
Oracle GoldenGate messages issued during the request
-
name:
string
Minimum Length: 1
Maximum Length: 512
Human-friendly name for the Backend
-
options:
array options
Minimum Number of Items: 0
Maximum Number of Items: 1
Configuration options for the Backend
-
readOnly:
boolean
Default Value: false
This Backend does not accept any requests that modify data
-
replaced:
array replaced
Minimum Number of Items: 1
Maximum Number of Items: 512
The Backends that this backend replaced
-
replacedBy:
string(uuid)
The Backend that replaced this backend
-
type:
string
Allowed Values: [
"Files",
"HAMIWS",
"Legacy",
"Memory",
"MongoDB",
"Oracle",
"Wallet"
]
The type of the Backend
{
"type":"object",
"properties":{
"id":{
"description":"Unique identifier for the Backend",
"type":"string",
"format":"uuid"
},
"configuration":{
"description":"Additional configuration data needed by the Backend",
"x-anyOf":[
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for storing configuration data.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"ensemble":{
"description":"Addresses of one or more members of the HAMIWS ensemble",
"type":"array",
"items":{
"type":"object",
"properties":{
"host":{
"description":"Host name or IP Address",
"x-oneOf":[
{
"description":"Network host name",
"type":"string",
"pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
"minLength":"1",
"maxLength":"4095"
},
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
]
},
"port":{
"description":"IP Port number",
"type":"integer",
"minimum":"1",
"maximum":"65535"
}
},
"required":[
"host",
"port"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"64"
},
"certificatePem":{
"description":"Client certificate to use when connecting to the ensemble.",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"privateKeyPem":{
"description":"Private key for the client certificate",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"caCertificates":{
"description":"A collection of CA certificates to use when connecting to the ensemble.",
"type":"array",
"minItems":"1",
"maxItems":"128",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"523288"
}
}
},
"required":[
"ensemble",
"certificatePem",
"caCertificates"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"version":{
"description":"The OGG version that this legacy backend represents.",
"type":"string",
"enum":[
"21c"
]
}
},
"required":[
"version"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"uri":{
"description":"The URI for the MongoDB server.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"username":{
"description":"The name of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"512"
},
"password":{
"description":"The password of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"database":{
"description":"The name of the MongoDB database. The default value is `config:configurationFile:installationId`.",
"type":"string",
"pattern":"^[^\\/\\\\. \"$*<>:|?]{1,63}$",
"minLength":"1",
"maxLength":"63"
},
"collection":{
"description":"The name of the MongoDB collection. The default value is `config:backend:id`.",
"type":"string",
"pattern":"^[^$]{0,255}$",
"minLength":"1",
"maxLength":"255"
}
},
"required":[
"uri"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"connectionString":{
"description":"Information used to identify and connect to an Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"username":{
"description":"The name of the user defined in the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"password":{
"description":"The password of the user for authenticating with the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"tableName":{
"description":"The name of the Oracle table to use. The default value is `config:backend:id`.",
"type":"string",
"minLength":"1",
"maxLength":"512"
}
},
"required":[
"connectionString"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for the Oracle Wallet",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"serialized":{
"description":"Indicates the Oracle Wallet should be serialized to the 'data' property",
"type":"boolean",
"default":false
},
"data":{
"description":"The base64 encoded Oracle Wallet data - up to 100MB",
"maxLength":"139810134",
"type":"string",
"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$",
"minLength":"4"
}
},
"additionalProperties":false
}
]
},
"name":{
"description":"Human-friendly name for the Backend",
"type":"string",
"minLength":"1",
"maxLength":"512"
},
"replacedBy":{
"description":"The Backend that replaced this backend",
"type":"string",
"format":"uuid"
},
"encrypted":{
"description":"If true, data is encrypted at rest in the Backend",
"type":"boolean",
"default":false
},
"$schema":{
"description":"The unique identifier for this JSON schema",
"type":"string",
"enum":[
"config:backend"
]
},
"encryptionKey":{
"description":"The key to use for encrypting data in the Backend; if not specified, a random key will be generated",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"readOnly":{
"description":"This Backend does not accept any requests that modify data",
"type":"boolean",
"default":false
},
"type":{
"description":"The type of the Backend",
"type":"string",
"enum":[
"Files",
"HAMIWS",
"Legacy",
"Memory",
"MongoDB",
"Oracle",
"Wallet"
]
},
"messages":{
"description":"Oracle GoldenGate messages issued during the request",
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:message"
]
},
"type":{
"description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"title":{
"description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
"type":"string",
"minLength":"1",
"maxLength":"4095"
},
"code":{
"description":"The Oracle GoldenGate message code",
"type":"string",
"pattern":"^OGG[-][0-9]{5}$",
"minLength":"9",
"maxLength":"9"
},
"severity":{
"description":"The severity of the message",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"issued":{
"description":"The date and time that the message was issued",
"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"
}
},
"required":[
"type",
"title",
"code",
"severity",
"issued"
],
"additionalProperties":false
},
"minItems":"0",
"maxItems":"65535"
},
"locked":{
"description":"This Backend does not accept any requests",
"type":"boolean",
"default":false
},
"options":{
"description":"Configuration options for the Backend",
"type":"array",
"items":{
"x-anyOf":[
{
"description":"Data item names may be repeated for children of the same parent",
"type":"string",
"enum":[
"duplicateNames"
]
}
]
},
"minItems":"0",
"maxItems":"1"
},
"replaced":{
"description":"The Backends that this backend replaced",
"type":"array",
"items":{
"type":"string",
"format":"uuid"
},
"minItems":"1",
"maxItems":"512"
}
},
"additionalProperties":false
}
Nested Schema : configuration
Additional configuration data needed by the Backend
Match Any
Show Source
{
"description":"Additional configuration data needed by the Backend",
"x-anyOf":[
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for storing configuration data.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
}
},
"additionalProperties":false
},
{
"type":"object",
"properties":{
"ensemble":{
"description":"Addresses of one or more members of the HAMIWS ensemble",
"type":"array",
"items":{
"type":"object",
"properties":{
"host":{
"description":"Host name or IP Address",
"x-oneOf":[
{
"description":"Network host name",
"type":"string",
"pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
"minLength":"1",
"maxLength":"4095"
},
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
]
},
"port":{
"description":"IP Port number",
"type":"integer",
"minimum":"1",
"maximum":"65535"
}
},
"required":[
"host",
"port"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"64"
},
"certificatePem":{
"description":"Client certificate to use when connecting to the ensemble.",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"privateKeyPem":{
"description":"Private key for the client certificate",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"caCertificates":{
"description":"A collection of CA certificates to use when connecting to the ensemble.",
"type":"array",
"minItems":"1",
"maxItems":"128",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"523288"
}
}
},
"required":[
"ensemble",
"certificatePem",
"caCertificates"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"version":{
"description":"The OGG version that this legacy backend represents.",
"type":"string",
"enum":[
"21c"
]
}
},
"required":[
"version"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"uri":{
"description":"The URI for the MongoDB server.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"username":{
"description":"The name of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"512"
},
"password":{
"description":"The password of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"database":{
"description":"The name of the MongoDB database. The default value is `config:configurationFile:installationId`.",
"type":"string",
"pattern":"^[^\\/\\\\. \"$*<>:|?]{1,63}$",
"minLength":"1",
"maxLength":"63"
},
"collection":{
"description":"The name of the MongoDB collection. The default value is `config:backend:id`.",
"type":"string",
"pattern":"^[^$]{0,255}$",
"minLength":"1",
"maxLength":"255"
}
},
"required":[
"uri"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"connectionString":{
"description":"Information used to identify and connect to an Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"username":{
"description":"The name of the user defined in the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"password":{
"description":"The password of the user for authenticating with the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"tableName":{
"description":"The name of the Oracle table to use. The default value is `config:backend:id`.",
"type":"string",
"minLength":"1",
"maxLength":"512"
}
},
"required":[
"connectionString"
],
"additionalProperties":false
},
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for the Oracle Wallet",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"serialized":{
"description":"Indicates the Oracle Wallet should be serialized to the 'data' property",
"type":"boolean",
"default":false
},
"data":{
"description":"The base64 encoded Oracle Wallet data - up to 100MB",
"maxLength":"139810134",
"type":"string",
"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$",
"minLength":"4"
}
},
"additionalProperties":false
}
]
}
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Oracle GoldenGate messages issued during the request
Show Source
{
"description":"Oracle GoldenGate messages issued during the request",
"type":"array",
"items":{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:message"
]
},
"type":{
"description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"title":{
"description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
"type":"string",
"minLength":"1",
"maxLength":"4095"
},
"code":{
"description":"The Oracle GoldenGate message code",
"type":"string",
"pattern":"^OGG[-][0-9]{5}$",
"minLength":"9",
"maxLength":"9"
},
"severity":{
"description":"The severity of the message",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"issued":{
"description":"The date and time that the message was issued",
"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"
}
},
"required":[
"type",
"title",
"code",
"severity",
"issued"
],
"additionalProperties":false
},
"minItems":"0",
"maxItems":"65535"
}
Nested Schema : options
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1
Configuration options for the Backend
Show Source
{
"description":"Configuration options for the Backend",
"type":"array",
"items":{
"x-anyOf":[
{
"description":"Data item names may be repeated for children of the same parent",
"type":"string",
"enum":[
"duplicateNames"
]
}
]
},
"minItems":"0",
"maxItems":"1"
}
Nested Schema : replaced
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 512
The Backends that this backend replaced
Show Source
{
"description":"The Backends that this backend replaced",
"type":"array",
"items":{
"type":"string",
"format":"uuid"
},
"minItems":"1",
"maxItems":"512"
}
Nested Schema : configuration-x-anyOf[0]
Type: object
Show Source
-
directory:
string
Minimum Length: 1
Maximum Length: 1024
The directory for storing configuration data.
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for storing configuration data.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
}
},
"additionalProperties":false
}
Nested Schema : configuration-x-anyOf[1]
Type: object
Show Source
{
"type":"object",
"properties":{
"ensemble":{
"description":"Addresses of one or more members of the HAMIWS ensemble",
"type":"array",
"items":{
"type":"object",
"properties":{
"host":{
"description":"Host name or IP Address",
"x-oneOf":[
{
"description":"Network host name",
"type":"string",
"pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
"minLength":"1",
"maxLength":"4095"
},
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
]
},
"port":{
"description":"IP Port number",
"type":"integer",
"minimum":"1",
"maximum":"65535"
}
},
"required":[
"host",
"port"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"64"
},
"certificatePem":{
"description":"Client certificate to use when connecting to the ensemble.",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"privateKeyPem":{
"description":"Private key for the client certificate",
"type":"string",
"minLength":"1",
"maxLength":"523288"
},
"caCertificates":{
"description":"A collection of CA certificates to use when connecting to the ensemble.",
"type":"array",
"minItems":"1",
"maxItems":"128",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"523288"
}
}
},
"required":[
"ensemble",
"certificatePem",
"caCertificates"
],
"additionalProperties":false
}
Nested Schema : configuration-x-anyOf[2]
Type: object
Show Source
{
"type":"object",
"properties":{
"version":{
"description":"The OGG version that this legacy backend represents.",
"type":"string",
"enum":[
"21c"
]
}
},
"required":[
"version"
],
"additionalProperties":false
}
Nested Schema : configuration-x-anyOf[3]
Type: object
Show Source
-
collection:
string
Minimum Length: 1
Maximum Length: 255
Pattern: ^[^$]{0,255}$
The name of the MongoDB collection. The default value is `config:backend:id`.
-
database:
string
Minimum Length: 1
Maximum Length: 63
Pattern: ^[^\/\\. "$*<>:|?]{1,63}$
The name of the MongoDB database. The default value is `config:configurationFile:installationId`.
-
password:
string
Minimum Length: 1
Maximum Length: 256
The password of the user for authenticating with the MongoDB server.
-
uri(required):
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
The URI for the MongoDB server.
-
username:
string
Minimum Length: 1
Maximum Length: 512
The name of the user for authenticating with the MongoDB server.
{
"type":"object",
"properties":{
"uri":{
"description":"The URI for the MongoDB server.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"username":{
"description":"The name of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"512"
},
"password":{
"description":"The password of the user for authenticating with the MongoDB server.",
"type":"string",
"minLength":"1",
"maxLength":"256"
},
"database":{
"description":"The name of the MongoDB database. The default value is `config:configurationFile:installationId`.",
"type":"string",
"pattern":"^[^\\/\\\\. \"$*<>:|?]{1,63}$",
"minLength":"1",
"maxLength":"63"
},
"collection":{
"description":"The name of the MongoDB collection. The default value is `config:backend:id`.",
"type":"string",
"pattern":"^[^$]{0,255}$",
"minLength":"1",
"maxLength":"255"
}
},
"required":[
"uri"
],
"additionalProperties":false
}
Nested Schema : configuration-x-anyOf[4]
Type: object
Show Source
-
connectionString(required):
string
Minimum Length: 1
Maximum Length: 4096
Information used to identify and connect to an Oracle database.
-
password:
string
Minimum Length: 1
Maximum Length: 1024
The password of the user for authenticating with the Oracle database.
-
tableName:
string
Minimum Length: 1
Maximum Length: 512
The name of the Oracle table to use. The default value is `config:backend:id`.
-
username:
string
Minimum Length: 1
Maximum Length: 1024
The name of the user defined in the Oracle database.
{
"type":"object",
"properties":{
"connectionString":{
"description":"Information used to identify and connect to an Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"4096"
},
"username":{
"description":"The name of the user defined in the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"password":{
"description":"The password of the user for authenticating with the Oracle database.",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"tableName":{
"description":"The name of the Oracle table to use. The default value is `config:backend:id`.",
"type":"string",
"minLength":"1",
"maxLength":"512"
}
},
"required":[
"connectionString"
],
"additionalProperties":false
}
Nested Schema : configuration-x-anyOf[5]
Type: object
Show Source
-
data:
string
Minimum Length: 4
Maximum Length: 139810134
Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
The base64 encoded Oracle Wallet data - up to 100MB
-
directory:
string
Minimum Length: 1
Maximum Length: 1024
The directory for the Oracle Wallet
-
serialized:
boolean
Default Value: false
Indicates the Oracle Wallet should be serialized to the 'data' property
{
"type":"object",
"properties":{
"directory":{
"description":"The directory for the Oracle Wallet",
"type":"string",
"minLength":"1",
"maxLength":"1024"
},
"serialized":{
"description":"Indicates the Oracle Wallet should be serialized to the 'data' property",
"type":"boolean",
"default":false
},
"data":{
"description":"The base64 encoded Oracle Wallet data - up to 100MB",
"maxLength":"139810134",
"type":"string",
"pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$",
"minLength":"4"
}
},
"additionalProperties":false
}
Nested Schema : caCertificates
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
A collection of CA certificates to use when connecting to the ensemble.
Show Source
{
"description":"A collection of CA certificates to use when connecting to the ensemble.",
"type":"array",
"minItems":"1",
"maxItems":"128",
"items":{
"type":"string",
"minLength":"1",
"maxLength":"523288"
}
}
Nested Schema : ensemble
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 64
Addresses of one or more members of the HAMIWS ensemble
Show Source
{
"description":"Addresses of one or more members of the HAMIWS ensemble",
"type":"array",
"items":{
"type":"object",
"properties":{
"host":{
"description":"Host name or IP Address",
"x-oneOf":[
{
"description":"Network host name",
"type":"string",
"pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
"minLength":"1",
"maxLength":"4095"
},
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
]
},
"port":{
"description":"IP Port number",
"type":"integer",
"minimum":"1",
"maximum":"65535"
}
},
"required":[
"host",
"port"
],
"additionalProperties":false
},
"minItems":"1",
"maxItems":"64"
}
Nested Schema : items
Type: object
Show Source
{
"type":"object",
"properties":{
"host":{
"description":"Host name or IP Address",
"x-oneOf":[
{
"description":"Network host name",
"type":"string",
"pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
"minLength":"1",
"maxLength":"4095"
},
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
]
},
"port":{
"description":"IP Port number",
"type":"integer",
"minimum":"1",
"maximum":"65535"
}
},
"required":[
"host",
"port"
],
"additionalProperties":false
}
Nested Schema : host
Host name or IP Address
Match One
Show Source
-
string
Minimum Length: 1
Maximum Length: 4095
Pattern: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$
Network host name
-
host-x-oneOf[1]
{
"description":"Host name or IP Address",
"x-oneOf":[
{
"description":"Network host name",
"type":"string",
"pattern":"^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$",
"minLength":"1",
"maxLength":"4095"
},
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
]
}
Nested Schema : host-x-oneOf[1]
Network IP address
Match One
Show Source
-
string
Minimum Length: 7
Maximum Length: 15
Pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Network IPv4 address
-
string
Minimum Length: 1
Maximum Length: 256
Pattern: ^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$
Network IPv6 address
{
"description":"Network IP address",
"x-oneOf":[
{
"description":"Network IPv4 address",
"type":"string",
"pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"minLength":"7",
"maxLength":"15"
},
{
"description":"Network IPv6 address",
"type":"string",
"pattern":"^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$",
"minLength":"1",
"maxLength":"256"
}
]
}
Nested Schema : items
Type: object
Show Source
-
$schema:
Allowed Values: [
"ogg:message"
]
-
code(required):
string
Minimum Length: 9
Maximum Length: 9
Pattern: ^OGG[-][0-9]{5}$
The Oracle GoldenGate message code
-
issued(required):
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])$
The date and time that the message was issued
-
severity(required):
Allowed Values: [
"INFO",
"WARNING",
"ERROR"
]
The severity of the message
-
title(required):
string
Minimum Length: 1
Maximum Length: 4095
A human-readable description that provides information and detail specific to this occurence of the information, warning or error.
-
type(required):
string
Minimum Length: 2
Maximum Length: 4095
Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
An absolute URI [RFC3986] to a page that describes the info, warning or error type.
{
"type":"object",
"properties":{
"$schema":{
"enum":[
"ogg:message"
]
},
"type":{
"description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
"type":"string",
"pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
"minLength":"2",
"maxLength":"4095"
},
"title":{
"description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
"type":"string",
"minLength":"1",
"maxLength":"4095"
},
"code":{
"description":"The Oracle GoldenGate message code",
"type":"string",
"pattern":"^OGG[-][0-9]{5}$",
"minLength":"9",
"maxLength":"9"
},
"severity":{
"description":"The severity of the message",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"issued":{
"description":"The date and time that the message was issued",
"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"
}
},
"required":[
"type",
"title",
"code",
"severity",
"issued"
],
"additionalProperties":false
}
Nested Schema : items
Match Any
Show Source
-
string
Allowed Values: [
"duplicateNames"
]
Data item names may be repeated for children of the same parent
{
"x-anyOf":[
{
"description":"Data item names may be repeated for children of the same parent",
"type":"string",
"enum":[
"duplicateNames"
]
}
]
}