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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
<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_v2.html">Connectors API</a> . <a href="connectors_v2.projects.html">projects</a> . <a href="connectors_v2.projects.locations.html">locations</a> . <a href="connectors_v2.projects.locations.connections.html">connections</a> . <a href="connectors_v2.projects.locations.connections.entityTypes.html">entityTypes</a> . <a href="connectors_v2.projects.locations.connections.entityTypes.entities.html">entities</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a `Entity` message object returned as a response by the external system.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an existing entity row matching the entity type and entity id specified in the request.</p>
<p class="toc_element">
<code><a href="#deleteEntitiesWithConditions">deleteEntitiesWithConditions(entityType, conditions=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes entities based on conditions specified in the request and not on entity id.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a single entity row matching the entity type and entity id specified in the request.</p>
<p class="toc_element">
<code><a href="#list">list(parent, conditions=None, pageSize=None, pageToken=None, sortBy=None, sortOrder=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system.</p>
<p class="toc_element">
<code><a href="#updateEntitiesWithConditions">updateEntitiesWithConditions(entityType, body=None, conditions=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates entities based on conditions specified in the request and not on entity id.</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="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a new entity row of the specified entity type in the external system. The field values for creating the row are contained in the body of the request. The response message contains a `Entity` message object returned as a response by the external system.
Args:
parent: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
body: object, The request body.
The object takes the form of:
{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
"fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
"a_key": "",
},
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
"fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
"a_key": "",
},
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an existing entity row matching the entity type and entity id specified in the request.
Args:
name: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="deleteEntitiesWithConditions">deleteEntitiesWithConditions(entityType, conditions=None, x__xgafv=None)</code>
<pre>Deletes entities based on conditions specified in the request and not on entity id.
Args:
entityType: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
conditions: string, Required. Conditions to be used when deleting entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a single entity row matching the entity type and entity id specified in the request.
Args:
name: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
"fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
"a_key": "",
},
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, conditions=None, pageSize=None, pageToken=None, sortBy=None, sortOrder=None, x__xgafv=None)</code>
<pre>Lists entity rows of a particular entity type contained in the request. Note: 1. Currently, only max of one 'sort_by' column is supported. 2. If no 'sort_by' column is provided, the primary key of the table is used. If zero or more than one primary key is available, we default to the unpaginated list entities logic which only returns the first page. 3. The values of the 'sort_by' columns must uniquely identify an entity row, otherwise undefined behaviors may be observed during pagination. 4. Since transactions are not supported, any updates, inserts or deletes during pagination can lead to stale data being returned or other unexpected behaviors.
Args:
parent: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
conditions: string, Conditions to be used when listing entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported.
pageSize: integer, Number of entity rows to return. Defaults page size = 25. Max page size = 200.
pageToken: string, Page token value if available from a previous request.
sortBy: string, List of 'sort_by' columns to use when returning the results. (repeated)
sortOrder: string, List of 'sort_order' columns to use when returning the results. (repeated)
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 EntityService.ListEntities
"entities": [ # List containing entity rows.
{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
"fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
"a_key": "",
},
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
},
],
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"nextPageToken": "A String", # Next page token if more records are available.
}</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>
<div class="method">
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<pre>Updates an existing entity row matching the entity type and entity id specified in the request. The fields in the entity row that need to be modified are contained in the body of the request. All unspecified fields are left unchanged. The response message contains a `Entity` message object returned as a response by the external system.
Args:
name: string, Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id} (required)
body: object, The request body.
The object takes the form of:
{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
"fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
"a_key": "",
},
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
"fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
"a_key": "",
},
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}</pre>
</div>
<div class="method">
<code class="details" id="updateEntitiesWithConditions">updateEntitiesWithConditions(entityType, body=None, conditions=None, x__xgafv=None)</code>
<pre>Updates entities based on conditions specified in the request and not on entity id.
Args:
entityType: string, Required. Resource name of the Entity Type. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type} (required)
body: object, The request body.
The object takes the form of:
{ # 'Entity row'/ 'Entity' refers to a single row of an entity type.
"fields": { # Fields of the entity. The key is name of the field and the value contains the applicable `google.protobuf.Value` entry for this field.
"a_key": "",
},
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"name": "A String", # Output only. Resource name of the Entity. Format: projects/{project}/locations/{location}/connections/{connection}/entityTypes/{type}/entities/{id}
}
conditions: string, Required. Conditions to be used when updating entities. From a proto standpoint, There are no restrictions on what can be passed using this field. The connector documentation should have information about what format of filters/conditions are supported. Note: If this conditions field is left empty, an exception is thrown. We don't want to consider 'empty conditions' to be a match-all case. Connector developers can determine and document what a match-all case constraint would be.
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 EntityService.UpdateEntitiesWithConditions
"metadata": { # Metadata like service latency, etc.
"a_key": {
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
},
"response": { # Response returned by the external system.
"a_key": "", # Properties of the object.
},
}</pre>
</div>
</body></html>
|
