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
|
<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="contentwarehouse_v1.html">Document AI Warehouse API</a> . <a href="contentwarehouse_v1.projects.html">projects</a> . <a href="contentwarehouse_v1.projects.locations.html">locations</a> . <a href="contentwarehouse_v1.projects.locations.links.html">links</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 link.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a link between a collection and a document.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a link.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, linksId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the link using provided UpdateLinkRequest.</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 link.
Args:
parent: string, Required. The parent name. (required)
body: object, The request body.
The object takes the form of:
{ # Defines the structure for content warehouse link proto.
"attributes": { # Other link attributes.
"a_key": "", # Properties of the object.
},
"collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
"createTime": "A String", # Output only. The create timestamp.
"creator": "A String", # Output only. Indicates who created this link.
"documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
"name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines the structure for content warehouse link proto.
"attributes": { # Other link attributes.
"a_key": "", # Properties of the object.
},
"collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
"createTime": "A String", # Output only. The create timestamp.
"creator": "A String", # Output only. Indicates who created this link.
"documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
"name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a link between a collection and a document.
Args:
name: string, Required. The name of the link to delete. (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="get">get(name, x__xgafv=None)</code>
<pre>Gets a link.
Args:
name: string, Required. The name of the link to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines the structure for content warehouse link proto.
"attributes": { # Other link attributes.
"a_key": "", # Properties of the object.
},
"collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
"createTime": "A String", # Output only. The create timestamp.
"creator": "A String", # Output only. Indicates who created this link.
"documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
"name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, linksId, body=None, x__xgafv=None)</code>
<pre>Updates the link using provided UpdateLinkRequest.
Args:
name: string, The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link. (required)
linksId: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{ # Defines the structure for content warehouse link proto.
"attributes": { # Other link attributes.
"a_key": "", # Properties of the object.
},
"collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
"createTime": "A String", # Output only. The create timestamp.
"creator": "A String", # Output only. Indicates who created this link.
"documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
"name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Defines the structure for content warehouse link proto.
"attributes": { # Other link attributes.
"a_key": "", # Properties of the object.
},
"collectionId": "A String", # The collection the link connects to. Should have the same project and location with the link.
"createTime": "A String", # Output only. The create timestamp.
"creator": "A String", # Output only. Indicates who created this link.
"documentId": "A String", # The document the link connects to. Should have the same project and location with the link.
"name": "A String", # The resource name of the link. Format: projects/{project_number}/locations/{location}/links/{link}. The name is ignored when creating a link.
}</pre>
</div>
</body></html>
|
