RuntimeEntitySchema
Stay organized with collections
Save and categorize content based on your preferences.
Schema of a runtime entity.
JSON representation |
{
"entity": string,
"fields": [
{
object (Field )
}
],
"jsonSchema": {
object (JsonSchema )
}
} |
Fields |
entity |
string
Output only. Name of the entity.
|
fields[] |
object (Field )
Output only. List of fields in the entity.
|
jsonSchema |
object (JsonSchema )
Output only. JsonSchema representation of this entity's metadata
|
Field
Metadata of an entity field.
JSON representation |
{
"field": string,
"description": string,
"dataType": enum (DataType ),
"key": boolean,
"readonly": boolean,
"nullable": boolean,
"defaultValue": value,
"additionalDetails": {
object
},
"jsonSchema": {
object (JsonSchema )
}
} |
Fields |
field |
string
Name of the Field.
|
description |
string
A brief description of the Field.
|
dataType |
enum (DataType )
The data type of the Field.
|
key |
boolean
The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
|
readonly |
boolean
Specifies if the Field is readonly.
|
nullable |
boolean
Specifies whether a null value is allowed.
|
defaultValue |
value (Value format)
The following field specifies the default value of the Field provided by the external system if a value is not provided.
|
additionalDetails |
object (Struct format)
The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
|
jsonSchema |
object (JsonSchema )
JsonSchema representation of this entity's schema
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-01-29 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]