File: translate_v3.projects.locations.glossaries.glossaryEntries.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (347 lines) | stat: -rw-r--r-- 16,041 bytes parent folder | download | duplicates (2)
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
<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="translate_v3.html">Cloud Translation API</a> . <a href="translate_v3.projects.html">projects</a> . <a href="translate_v3.projects.locations.html">locations</a> . <a href="translate_v3.projects.locations.glossaries.html">glossaries</a> . <a href="translate_v3.projects.locations.glossaries.glossaryEntries.html">glossaryEntries</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 glossary entry.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single entry from the glossary</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a single glossary entry by the given id.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List the entries for the glossary.</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 a glossary entry.</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 glossary entry.

Args:
  parent: string, Required. The resource name of the glossary to create the entry under. (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a single entry in a glossary.
  &quot;description&quot;: &quot;A String&quot;, # Describes the glossary entry.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`
  &quot;termsPair&quot;: { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
    &quot;sourceTerm&quot;: { # Represents a single glossary term # The source term is the term that will get match in the text,
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
    &quot;targetTerm&quot;: { # Represents a single glossary term # The term that will replace the match source term.
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
  },
  &quot;termsSet&quot;: { # Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set. # Used for an equivalent term sets glossary.
    &quot;terms&quot;: [ # Each term in the set represents a term that can be replaced by the other terms.
      { # Represents a single glossary term
        &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
        &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
      },
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a single entry in a glossary.
  &quot;description&quot;: &quot;A String&quot;, # Describes the glossary entry.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`
  &quot;termsPair&quot;: { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
    &quot;sourceTerm&quot;: { # Represents a single glossary term # The source term is the term that will get match in the text,
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
    &quot;targetTerm&quot;: { # Represents a single glossary term # The term that will replace the match source term.
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
  },
  &quot;termsSet&quot;: { # Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set. # Used for an equivalent term sets glossary.
    &quot;terms&quot;: [ # Each term in the set represents a term that can be replaced by the other terms.
      { # Represents a single glossary term
        &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
        &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
      },
    ],
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes a single entry from the glossary

Args:
  name: string, Required. The resource name of the glossary entry 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 single glossary entry by the given id.

Args:
  name: string, Required. The resource name of the glossary entry to get (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a single entry in a glossary.
  &quot;description&quot;: &quot;A String&quot;, # Describes the glossary entry.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`
  &quot;termsPair&quot;: { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
    &quot;sourceTerm&quot;: { # Represents a single glossary term # The source term is the term that will get match in the text,
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
    &quot;targetTerm&quot;: { # Represents a single glossary term # The term that will replace the match source term.
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
  },
  &quot;termsSet&quot;: { # Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set. # Used for an equivalent term sets glossary.
    &quot;terms&quot;: [ # Each term in the set represents a term that can be replaced by the other terms.
      { # Represents a single glossary term
        &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
        &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
      },
    ],
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>List the entries for the glossary.

Args:
  parent: string, Required. The parent glossary resource name for listing the glossary&#x27;s entries. (required)
  pageSize: integer, Optional. Requested page size. The server may return fewer glossary entries than requested. If unspecified, the server picks an appropriate default.
  pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossaryEntriesResponse.next_page_token] returned from the previous call. The first page is returned if `page_token`is empty or missing.
  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 ListGlossaryEntries
  &quot;glossaryEntries&quot;: [ # Optional. The Glossary Entries
    { # Represents a single entry in a glossary.
      &quot;description&quot;: &quot;A String&quot;, # Describes the glossary entry.
      &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`
      &quot;termsPair&quot;: { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
        &quot;sourceTerm&quot;: { # Represents a single glossary term # The source term is the term that will get match in the text,
          &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
          &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
        },
        &quot;targetTerm&quot;: { # Represents a single glossary term # The term that will replace the match source term.
          &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
          &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
        },
      },
      &quot;termsSet&quot;: { # Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set. # Used for an equivalent term sets glossary.
        &quot;terms&quot;: [ # Each term in the set represents a term that can be replaced by the other terms.
          { # Represents a single glossary term
            &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
            &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
          },
        ],
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Optional. A token to retrieve a page of results. Pass this value in the [ListGLossaryEntriesRequest.page_token] field in the subsequent calls.
}</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 &#x27;execute()&#x27; 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 a glossary entry.

Args:
  name: string, Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*` (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a single entry in a glossary.
  &quot;description&quot;: &quot;A String&quot;, # Describes the glossary entry.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`
  &quot;termsPair&quot;: { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
    &quot;sourceTerm&quot;: { # Represents a single glossary term # The source term is the term that will get match in the text,
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
    &quot;targetTerm&quot;: { # Represents a single glossary term # The term that will replace the match source term.
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
  },
  &quot;termsSet&quot;: { # Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set. # Used for an equivalent term sets glossary.
    &quot;terms&quot;: [ # Each term in the set represents a term that can be replaced by the other terms.
      { # Represents a single glossary term
        &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
        &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
      },
    ],
  },
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a single entry in a glossary.
  &quot;description&quot;: &quot;A String&quot;, # Describes the glossary entry.
  &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the entry. Format: `projects/*/locations/*/glossaries/*/glossaryEntries/*`
  &quot;termsPair&quot;: { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
    &quot;sourceTerm&quot;: { # Represents a single glossary term # The source term is the term that will get match in the text,
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
    &quot;targetTerm&quot;: { # Represents a single glossary term # The term that will replace the match source term.
      &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
      &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
    },
  },
  &quot;termsSet&quot;: { # Represents a single entry for an equivalent term set glossary. This is used for equivalent term sets where each term can be replaced by the other terms in the set. # Used for an equivalent term sets glossary.
    &quot;terms&quot;: [ # Each term in the set represents a term that can be replaced by the other terms.
      { # Represents a single glossary term
        &quot;languageCode&quot;: &quot;A String&quot;, # The language for this glossary term.
        &quot;text&quot;: &quot;A String&quot;, # The text for the glossary term.
      },
    ],
  },
}</pre>
</div>

</body></html>