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

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

[diff] [blame]

87

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

Bu Sun Kim

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

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

[diff] [blame]

104

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

105

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

106

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

107

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

108

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

109

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

110

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

111

"A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

112

],

113

},

Bu Sun Kim

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

[diff] [blame]

114

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

115

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

116

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

117

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

118

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

119

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

120

},

Bu Sun Kim

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

[diff] [blame]

121

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

122

# Total glossary must not exceed 10M Unicode codepoints.

123

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

124

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

125

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

126

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

127

# the following formats:

128

#

129

# For unidirectional glossaries:

130

#

131

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

132

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

133

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

134

# column names.

135

#

136

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

137

# pairs.

138

#

139

# For equivalent term sets glossaries:

140

#

141

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

142

# in multiple languages. See documentation for more information -

143

# [glossaries](https://cloud.google.com/translate/docs/advanced/glossary).

Bu Sun Kim

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

[diff] [blame]

144

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

145

},

146

},

Bu Sun Kim

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

[diff] [blame]

147

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

148

}

149

150

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

157

158

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

159

# network API call.

160

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

161

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

162

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

163

"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.

164

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

165

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

166

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

167

#

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

# message types for APIs to use.

176

{

177

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

178

},

Bu Sun Kim

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

[diff] [blame]

179

],

180

},

Bu Sun Kim

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

[diff] [blame]

181

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

182

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

183

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

184

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

185

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

186

},

187

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

188

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

189

# available.

190

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

191

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

192

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

193

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

194

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

195

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

196

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

197

# `TakeSnapshotResponse`.

198

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

199

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

204

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

205

<pre>Deletes a glossary, or cancels glossary construction

206

if the glossary isn't created yet.

207

Returns NOT_FOUND, if the glossary doesn't exist.

208

209

Args:

210

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

211

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

218

219

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

220

# network API call.

221

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

222

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

223

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

224

"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.

225

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

226

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

227

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

228

#

229

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

230

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

231

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

232

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

233

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

234

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

235

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

236

# message types for APIs to use.

237

{

238

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

},

],

},

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

243

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

244

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

245

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

246

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

247

},

248

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

249

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

250

# available.

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

# `TakeSnapshotResponse`.

259

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

},

}</pre>

</div>

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

266

<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)

271

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

278

279

{ # Represents a glossary built from user provided data.

280

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

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

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

284

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

285

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

286

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

"A String",

],

},

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

291

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

292

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

293

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

294

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

295

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

296

},

297

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

298

# Total glossary must not exceed 10M Unicode codepoints.

299

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

300

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

301

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

302

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

303

# the following formats:

304

#

305

# For unidirectional glossaries:

306

#

307

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

308

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

309

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

310

# column names.

311

#

312

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

313

# pairs.

314

#

315

# For equivalent term sets glossaries:

316

#

317

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

318

# in multiple languages. See documentation for more information -

319

# [glossaries](https://cloud.google.com/translate/docs/advanced/glossary).

320

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

321

},

322

},

323

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

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

329

<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)

Bu Sun Kim

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

[diff] [blame]

334

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

335

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

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

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

[diff] [blame]

339

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

340

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

341

returned from the previous call to `ListGlossaries` method.

342

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

Bu Sun Kim

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

[diff] [blame]

343

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

350

351

{ # Response message for ListGlossaries.

Bu Sun Kim

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

[diff] [blame]

352

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

353

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

354

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

Bu Sun Kim

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

[diff] [blame]

355

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

356

{ # Represents a glossary built from user provided data.

357

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

358

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

359

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

360

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

361

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

362

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

363

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

"A String",

],

},

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

368

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

369

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

370

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

371

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

372

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

373

},

374

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

375

# Total glossary must not exceed 10M Unicode codepoints.

376

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

377

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

378

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

379

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

380

# the following formats:

381

#

382

# For unidirectional glossaries:

383

#

384

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

385

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

386

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

387

# column names.

388

#

389

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

390

# pairs.

391

#

392

# For equivalent term sets glossaries:

393

#

394

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

395

# in multiple languages. See documentation for more information -

396

# [glossaries](https://cloud.google.com/translate/docs/advanced/glossary).

397

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

398

},

399

},

400

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

401

},

402

],

Bu Sun Kim