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
|
<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.documents.html">documents</a> . <a href="contentwarehouse_v1.projects.locations.documents.documentLinks.html">documentLinks</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">Create a link between a source document and a target document.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Remove the link between the source and target documents.</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>Create a link between a source document and a target document.
Args:
parent: string, Required. Parent of the document-link to be created. parent of document-link should be a document. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DocumentLinkService.CreateDocumentLink.
"documentLink": { # A document-link between source and target document. # Required. Document links associated with the source documents (source_document_id).
"createTime": "A String", # Output only. The time when the documentLink is created.
"description": "A String", # Description of this document-link.
"name": "A String", # Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
"sourceDocumentReference": { # References to the documents. # Document references of the source document.
"createTime": "A String", # Output only. The time when the document is created.
"deleteTime": "A String", # Output only. The time when the document is deleted.
"displayName": "A String", # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
"documentIsFolder": True or False, # The document type of the document being referenced.
"documentIsLegalHoldFolder": True or False, # Document is a folder with legal hold.
"documentIsRetentionFolder": True or False, # Document is a folder with retention policy.
"documentName": "A String", # Required. Name of the referenced document.
"snippet": "A String", # Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
"updateTime": "A String", # Output only. The time when the document is last updated.
},
"state": "A String", # The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.
"targetDocumentReference": { # References to the documents. # Document references of the target document.
"createTime": "A String", # Output only. The time when the document is created.
"deleteTime": "A String", # Output only. The time when the document is deleted.
"displayName": "A String", # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
"documentIsFolder": True or False, # The document type of the document being referenced.
"documentIsLegalHoldFolder": True or False, # Document is a folder with legal hold.
"documentIsRetentionFolder": True or False, # Document is a folder with retention policy.
"documentName": "A String", # Required. Name of the referenced document.
"snippet": "A String", # Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
"updateTime": "A String", # Output only. The time when the document is last updated.
},
"updateTime": "A String", # Output only. The time when the documentLink is last updated.
},
"requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the document creator, used to enforce access control for the service.
"userInfo": { # The user information. # Provides user unique identification and groups information.
"groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
"A String",
],
"id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A document-link between source and target document.
"createTime": "A String", # Output only. The time when the documentLink is created.
"description": "A String", # Description of this document-link.
"name": "A String", # Name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
"sourceDocumentReference": { # References to the documents. # Document references of the source document.
"createTime": "A String", # Output only. The time when the document is created.
"deleteTime": "A String", # Output only. The time when the document is deleted.
"displayName": "A String", # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
"documentIsFolder": True or False, # The document type of the document being referenced.
"documentIsLegalHoldFolder": True or False, # Document is a folder with legal hold.
"documentIsRetentionFolder": True or False, # Document is a folder with retention policy.
"documentName": "A String", # Required. Name of the referenced document.
"snippet": "A String", # Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
"updateTime": "A String", # Output only. The time when the document is last updated.
},
"state": "A String", # The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.
"targetDocumentReference": { # References to the documents. # Document references of the target document.
"createTime": "A String", # Output only. The time when the document is created.
"deleteTime": "A String", # Output only. The time when the document is deleted.
"displayName": "A String", # display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
"documentIsFolder": True or False, # The document type of the document being referenced.
"documentIsLegalHoldFolder": True or False, # Document is a folder with legal hold.
"documentIsRetentionFolder": True or False, # Document is a folder with retention policy.
"documentName": "A String", # Required. Name of the referenced document.
"snippet": "A String", # Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
"updateTime": "A String", # Output only. The time when the document is last updated.
},
"updateTime": "A String", # Output only. The time when the documentLink is last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, body=None, x__xgafv=None)</code>
<pre>Remove the link between the source and target documents.
Args:
name: string, Required. The name of the document-link to be deleted. Format: projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for DocumentLinkService.DeleteDocumentLink.
"requestMetadata": { # Meta information is used to improve the performance of the service. # The meta information collected about the document creator, used to enforce access control for the service.
"userInfo": { # The user information. # Provides user unique identification and groups information.
"groupIds": [ # The unique group identifications which the user is belong to. The format is "group:yyyy@example.com";
"A String",
],
"id": "A String", # A unique user identification string, as determined by the client. The maximum number of allowed characters is 255. Allowed characters include numbers 0 to 9, uppercase and lowercase letters, and restricted special symbols (:, @, +, -, _, ~) The format is "user:xxxx@example.com";
},
},
}
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>
</body></html>
|
