1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="connectors_v1.html">Connectors API</a> . <a href="connectors_v1.projects.html">projects</a> . <a href="connectors_v1.projects.locations.html">locations</a> . <a href="connectors_v1.projects.locations.connections.html">connections</a> . <a href="connectors_v1.projects.locations.connections.runtimeEntitySchemas.html">runtimeEntitySchemas</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List schema of a runtime entities filtered by entity name.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List schema of a runtime entities filtered by entity name.
Args:
parent: string, Required. Parent resource of RuntimeEntitySchema Format: projects/{project}/locations/{location}/connections/{connection} (required)
filter: string, Required. Filter Format: entity="{entityId}" Only entity field is supported with literal equality operator. Accepted filter example: entity="Order" Wildcards are not supported in the filter currently.
pageSize: integer, Page size.
pageToken: string, Page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ConnectorsService.ListRuntimeEntitySchemas.
"nextPageToken": "A String", # Next page token.
"runtimeEntitySchemas": [ # Runtime entity schemas.
{ # Schema of a runtime entity.
"entity": "A String", # Output only. Name of the entity.
"fields": [ # Output only. List of fields in the entity.
{ # Metadata of an entity field.
"additionalDetails": { # The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.
"a_key": "", # Properties of the object.
},
"dataType": "A String", # The data type of the Field.
"defaultValue": "", # The following field specifies the default value of the Field provided by the external system if a value is not provided.
"description": "A String", # A brief description of the Field.
"field": "A String", # Name of the Field.
"jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this entity's schema
"additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
"a_key": "", # Properties of the object.
},
"default": "", # The default value of the field or object described by this schema.
"description": "A String", # A description of this schema.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
"jdbcType": "A String", # JDBC datatype of the field.
"properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
"a_key": # Object with schema name: JsonSchema
},
"required": [ # Whether this property is required.
"A String",
],
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
},
"key": True or False, # The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.
"nullable": True or False, # Specifies whether a null value is allowed.
"readonly": True or False, # Specifies if the Field is readonly.
},
],
"jsonSchema": { # JsonSchema representation of schema metadata # Output only. JsonSchema representation of this entity's metadata
"additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema
"a_key": "", # Properties of the object.
},
"default": "", # The default value of the field or object described by this schema.
"description": "A String", # A description of this schema.
"enum": [ # Possible values for an enumeration. This works in conjunction with `type` to represent types with a fixed set of legal values
"",
],
"format": "A String", # Format of the value as per https://json-schema.org/understanding-json-schema/reference/string.html#format
"items": # Object with schema name: JsonSchema # Schema that applies to array values, applicable only if this is of type `array`.
"jdbcType": "A String", # JDBC datatype of the field.
"properties": { # The child schemas, applicable only if this is of type `object`. The key is the name of the property and the value is the json schema that describes that property
"a_key": # Object with schema name: JsonSchema
},
"required": [ # Whether this property is required.
"A String",
],
"type": [ # JSON Schema Validation: A Vocabulary for Structural Validation of JSON
"A String",
],
},
"operations": [ # List of operations supported by this entity
"A String",
],
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
