Blame - docs/dyn/translate_v3beta1.projects.locations.glossaries.html - platform/external/python/google-api-python-client

<h1><a href="translate_v3beta1.html">Cloud Translation API</a> . <a href="translate_v3beta1.projects.html">projects</a> . <a href="translate_v3beta1.projects.locations.html">locations</a> . <a href="translate_v3beta1.projects.locations.glossaries.html">glossaries</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Creates a glossary and returns the long-running operation. Returns</p>

80

81

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

82

<p class="firstline">Deletes a glossary, or cancels glossary construction</p>

83

84

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Gets a glossary. Returns NOT_FOUND, if the glossary doesn't</p>

86

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

87

<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

88

<p class="firstline">Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't</p>

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

<h3>Method Details</h3>

93

94

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

95

<pre>Creates a glossary and returns the long-running operation. Returns

96

NOT_FOUND, if the project doesn't exist.

97

98

Args:

99

parent: string, Required. The project name. (required)

100

body: object, The request body.

101

The object takes the form of:

102

103

{ # Represents a glossary built from user provided data.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

104

"name": "A String", # Required. The resource name of the glossary. Glossary names have the form

105

# `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

106

"entryCount": 42, # Output only. The number of entries defined in the glossary.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

107

"languagePair": { # Used with unidirectional glossaries. # Used with unidirectional glossaries.

108

"sourceLanguageCode": "A String", # Required. The BCP-47 language code of the input text, for example,

109

# "en-US". Expected to be an exact match for GlossaryTerm.language_code.

110

"targetLanguageCode": "A String", # Required. The BCP-47 language code for translation output, for example,

111

# "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.

112

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

113

"inputConfig": { # Input configuration for glossaries. # Required. Provides examples to build the glossary from.

114

# Total glossary must not exceed 10M Unicode codepoints.

115

"gcsSource": { # The Google Cloud Storage location for the input content. # Required. Google Cloud Storage location of glossary data.

116

# File format is determined based on the filename extension. API returns

117

# [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file

118

# formats. Wildcards are not allowed. This must be a single file in one of

119

# the following formats:

120

#

121

# For unidirectional glossaries:

122

#

123

# - TSV/CSV (`.tsv`/`.csv`): 2 column file, tab- or comma-separated.

124

# The first column is source text. The second column is target text.

125

# The file must not contain headers. That is, the first row is data, not

126

# column names.

127

#

128

# - TMX (`.tmx`): TMX file with parallel data defining source/target term

129

# pairs.

130

#

131

# For equivalent term sets glossaries:

132

#

133

# - CSV (`.csv`): Multi-column CSV file defining equivalent glossary terms

134

# in multiple languages. The format is defined for Google Translation

135

# Toolkit and documented in [Use a

136

# glossary](https://support.google.com/translatortoolkit/answer/6306379?hl=en).

137

"inputUri": "A String", # Required. Source data URI. For example, `gs://my_bucket/my_object`.

138

},

139

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

140

"languageCodesSet": { # Used with equivalent term set glossaries. # Used with equivalent term set glossaries.

141

"languageCodes": [ # The BCP-47 language code(s) for terms defined in the glossary.

142

# All entries are unique. The list contains at least two entries.

143

# Expected to be an exact match for GlossaryTerm.language_code.

144

"A String",

145

],

146

},

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

147

"submitTime": "A String", # Output only. When CreateGlossary was called.

148

"endTime": "A String", # Output only. When the glossary creation was finished.

149

}

150

151

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

158

159

{ # This resource represents a long-running operation that is the result of a

160

# network API call.

161

"response": { # The normal response of the operation in case of success. If the original

162

# method returns no data on success, such as `Delete`, the response is

163

# `google.protobuf.Empty`. If the original method is standard

164

# `Get`/`Create`/`Update`, the response should be the resource. For other

165

# methods, the response should have the type `XxxResponse`, where `Xxx`

166

# is the original method name. For example, if the original method name

167

# is `TakeSnapshot()`, the inferred response type is

168

# `TakeSnapshotResponse`.

169

"a_key": "", # Properties of the object. Contains field @type with type URL.

170

},

171

"name": "A String", # The server-assigned name, which is only unique within the same service that

172

# originally returns it. If you use the default HTTP mapping, the

173

# `name` should be a resource name ending with `operations/{unique_id}`.

174

"done": True or False, # If the value is `false`, it means the operation is still in progress.

175

# If `true`, the operation is completed, and either `error` or `response` is

176

# available.

177

"metadata": { # Service-specific metadata associated with the operation. It typically

178

# contains progress information and common metadata such as create time.

179

# Some services might not provide such metadata. Any method that returns a

180

# long-running operation should document the metadata type, if any.

181

"a_key": "", # Properties of the object. Contains field @type with type URL.

182

},

183

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

184

# different programming environments, including REST APIs and RPC APIs. It is

185

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

186

# three pieces of data: error code, error message, and error details.

187

#

188

# You can find out more about this error model and how to work with it in the

189

# [API Design Guide](https://cloud.google.com/apis/design/errors).

190

"details": [ # A list of messages that carry the error details. There is a common set of

191

# message types for APIs to use.

192

{

193

"a_key": "", # Properties of the object. Contains field @type with type URL.

194

},

195

],

196

"message": "A String", # A developer-facing error message, which should be in English. Any

197

# user-facing error message should be localized and sent in the

198

# google.rpc.Status.details field, or localized by the client.

199

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

200

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

205

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

206

<pre>Deletes a glossary, or cancels glossary construction

207

if the glossary isn't created yet.

208

Returns NOT_FOUND, if the glossary doesn't exist.

209

210

Args:

211

name: string, Required. The name of the glossary to delete. (required)

212

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

219

220

{ # This resource represents a long-running operation that is the result of a

221

# network API call.

222

"response": { # The normal response of the operation in case of success. If the original

223

# method returns no data on success, such as `Delete`, the response is

224

# `google.protobuf.Empty`. If the original method is standard

225

# `Get`/`Create`/`Update`, the response should be the resource. For other

226

# methods, the response should have the type `XxxResponse`, where `Xxx`

227

# is the original method name. For example, if the original method name

228

# is `TakeSnapshot()`, the inferred response type is

229

# `TakeSnapshotResponse`.

230

"a_key": "", # Properties of the object. Contains field @type with type URL.

231

},

232

"name": "A String", # The server-assigned name, which is only unique within the same service that

233

# originally returns it. If you use the default HTTP mapping, the

234

# `name` should be a resource name ending with `operations/{unique_id}`.

235

"done": True or False, # If the value is `false`, it means the operation is still in progress.

236

# If `true`, the operation is completed, and either `error` or `response` is

237

# available.

238

"metadata": { # Service-specific metadata associated with the operation. It typically

239

# contains progress information and common metadata such as create time.

240

# Some services might not provide such metadata. Any method that returns a

241

# long-running operation should document the metadata type, if any.

242

"a_key": "", # Properties of the object. Contains field @type with type URL.

243

},

244

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

245

# different programming environments, including REST APIs and RPC APIs. It is

246

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

247

# three pieces of data: error code, error message, and error details.

248

#

249

# You can find out more about this error model and how to work with it in the

250

# [API Design Guide](https://cloud.google.com/apis/design/errors).

251

"details": [ # A list of messages that carry the error details. There is a common set of

252

# message types for APIs to use.

253

{

254

"a_key": "", # Properties of the object. Contains field @type with type URL.

255

},

256

],

257

"message": "A String", # A developer-facing error message, which should be in English. Any

258

# user-facing error message should be localized and sent in the

259

# google.rpc.Status.details field, or localized by the client.

260

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

},

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

267

<pre>Gets a glossary. Returns NOT_FOUND, if the glossary doesn't

exist.

Args:

name: string, Required. The name of the glossary to retrieve. (required)

272

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

279

280

{ # Represents a glossary built from user provided data.

281

"name": "A String", # Required. The resource name of the glossary. Glossary names have the form

282

# `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`.

283

"entryCount": 42, # Output only. The number of entries defined in the glossary.

284

"languagePair": { # Used with unidirectional glossaries. # Used with unidirectional glossaries.

285

"sourceLanguageCode": "A String", # Required. The BCP-47 language code of the input text, for example,

286

# "en-US". Expected to be an exact match for GlossaryTerm.language_code.

287

"targetLanguageCode": "A String", # Required. The BCP-47 language code for translation output, for example,

288

# "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.

289

},

290

"inputConfig": { # Input configuration for glossaries. # Required. Provides examples to build the glossary from.

291

# Total glossary must not exceed 10M Unicode codepoints.

292

"gcsSource": { # The Google Cloud Storage location for the input content. # Required. Google Cloud Storage location of glossary data.

293

# File format is determined based on the filename extension. API returns

294

# [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file

295

# formats. Wildcards are not allowed. This must be a single file in one of

296

# the following formats:

297

#

298

# For unidirectional glossaries:

299

#

300

# - TSV/CSV (`.tsv`/`.csv`): 2 column file, tab- or comma-separated.

301

# The first column is source text. The second column is target text.

302

# The file must not contain headers. That is, the first row is data, not

303

# column names.

304

#

305

# - TMX (`.tmx`): TMX file with parallel data defining source/target term

306

# pairs.

307

#

308

# For equivalent term sets glossaries:

309

#

310

# - CSV (`.csv`): Multi-column CSV file defining equivalent glossary terms

311

# in multiple languages. The format is defined for Google Translation

312

# Toolkit and documented in [Use a

313

# glossary](https://support.google.com/translatortoolkit/answer/6306379?hl=en).

314

"inputUri": "A String", # Required. Source data URI. For example, `gs://my_bucket/my_object`.

315

},

316

},

317

"languageCodesSet": { # Used with equivalent term set glossaries. # Used with equivalent term set glossaries.

318

"languageCodes": [ # The BCP-47 language code(s) for terms defined in the glossary.

319

# All entries are unique. The list contains at least two entries.

320

# Expected to be an exact match for GlossaryTerm.language_code.

"A String",

],

},

"submitTime": "A String", # Output only. When CreateGlossary was called.

325

"endTime": "A String", # Output only. When the glossary creation was finished.

}</pre>

</div>

<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

331

<pre>Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't

exist.

Args:

parent: string, Required. The name of the project from which to list all of the glossaries. (required)

336

filter: string, Optional. Filter specifying constraints of a list operation.

337

Filtering is not supported yet, and the parameter currently has no effect.

338

If missing, no filtering is performed.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

339

pageSize: integer, Optional. Requested page size. The server may return fewer glossaries than

340

requested. If unspecified, the server picks an appropriate default.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

341

pageToken: string, Optional. A token identifying a page of results the server should return.

342

Typically, this is the value of [ListGlossariesResponse.next_page_token]

343

returned from the previous call to `ListGlossaries` method.

344

The first page is returned if `page_token`is empty or missing.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

345

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

352

353

{ # Response message for ListGlossaries.

354

"glossaries": [ # The list of glossaries for a project.

355

{ # Represents a glossary built from user provided data.

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

356

"name": "A String", # Required. The resource name of the glossary. Glossary names have the form

357

# `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`.

358

"entryCount": 42, # Output only. The number of entries defined in the glossary.

359

"languagePair": { # Used with unidirectional glossaries. # Used with unidirectional glossaries.

360

"sourceLanguageCode": "A String", # Required. The BCP-47 language code of the input text, for example,

361

# "en-US". Expected to be an exact match for GlossaryTerm.language_code.

362

"targetLanguageCode": "A String", # Required. The BCP-47 language code for translation output, for example,

363

# "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

364

},

Bu Sun Kim

d059ad8

2020-07-22 17:02:09 -0700

[diff] [blame^]

365

"inputConfig": { # Input configuration for glossaries. # Required. Provides examples to build the glossary from.

366

# Total glossary must not exceed 10M Unicode codepoints.

367

"gcsSource": { # The Google Cloud Storage location for the input content. # Required. Google Cloud Storage location of glossary data.

368

# File format is determined based on the filename extension. API returns

369

# [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file

370

# formats. Wildcards are not allowed. This must be a single file in one of

371

# the following formats:

372

#

373

# For unidirectional glossaries:

374

#

375

# - TSV/CSV (`.tsv`/`.csv`): 2 column file, tab- or comma-separated.

376

# The first column is source text. The second column is target text.

377

# The file must not contain headers. That is, the first row is data, not

378

# column names.

379

#

380

# - TMX (`.tmx`): TMX file with parallel data defining source/target term

381

# pairs.

382

#

383

# For equivalent term sets glossaries:

384

#

385

# - CSV (`.csv`): Multi-column CSV file defining equivalent glossary terms

386

# in multiple languages. The format is defined for Google Translation

387

# Toolkit and documented in [Use a

388

# glossary](https://support.google.com/translatortoolkit/answer/6306379?hl=en).

389

"inputUri": "A String", # Required. Source data URI. For example, `gs://my_bucket/my_object`.

390

},

391

},

392

"languageCodesSet": { # Used with equivalent term set glossaries. # Used with equivalent term set glossaries.

393

"languageCodes": [ # The BCP-47 language code(s) for terms defined in the glossary.

394

# All entries are unique. The list contains at least two entries.

395

# Expected to be an exact match for GlossaryTerm.language_code.

"A String",

],

},

"submitTime": "A String", # Output only. When CreateGlossary was called.

400

"endTime": "A String", # Output only. When the glossary creation was finished.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

401

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame]

402

],

403

"nextPageToken": "A String", # A token to retrieve a page of results. Pass this value in the

404

# [ListGlossariesRequest.page_token] field in the subsequent call to

405

# `ListGlossaries` method to retrieve the next page of results.

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

411

<pre>Retrieves the next page of results.

412

413

Args:

414

previous_request: The request for the previous page. (required)

415

previous_response: The response from the request for the previous page. (required)

416

417

Returns:

418

A request object that you can call 'execute()' on to request the next

419

page. Returns None if there are no more items in the collection.

</pre>

</div>

</body></html>