1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<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></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 103 <pre>Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist. 104 105Args: 106 parent: string, Required. The project name. (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # Represents a glossary built from user provided data. 111 "endTime": "A String", # Output only. When the glossary creation was finished. 112 "entryCount": 42, # Output only. The number of entries defined in the glossary. 113 "inputConfig": { # Input configuration for glossaries. # Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints. 114 "gcsSource": { # The Google Cloud Storage location for the input content. # Required. Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (`.tsv`/`.csv`): 2 column file, tab- or comma-separated. The first column is source text. The second column is target text. The file must not contain headers. That is, the first row is data, not column names. - TMX (`.tmx`): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (`.csv`): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - [glossaries](https://cloud.google.com/translate/docs/advanced/glossary). 115 "inputUri": "A String", # Required. Source data URI. For example, `gs://my_bucket/my_object`. 116 }, 117 }, 118 "languageCodesSet": { # Used with equivalent term set glossaries. # Used with equivalent term set glossaries. 119 "languageCodes": [ # The BCP-47 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code. 120 "A String", 121 ], 122 }, 123 "languagePair": { # Used with unidirectional glossaries. # Used with unidirectional glossaries. 124 "sourceLanguageCode": "A String", # Required. The BCP-47 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code. 125 "targetLanguageCode": "A String", # Required. The BCP-47 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. 126 }, 127 "name": "A String", # Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`. 128 "submitTime": "A String", # Output only. When CreateGlossary was called. 129} 130 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { # This resource represents a long-running operation that is the result of a network API call. 140 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 141 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 142 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 143 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 144 { 145 "a_key": "", # Properties of the object. Contains field @type with type URL. 146 }, 147 ], 148 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 149 }, 150 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 151 "a_key": "", # Properties of the object. Contains field @type with type URL. 152 }, 153 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 154 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 155 "a_key": "", # Properties of the object. Contains field @type with type URL. 156 }, 157}</pre> 158</div> 159 160<div class="method"> 161 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 162 <pre>Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist. 163 164Args: 165 name: string, Required. The name of the glossary to delete. (required) 166 x__xgafv: string, V1 error format. 167 Allowed values 168 1 - v1 error format 169 2 - v2 error format 170 171Returns: 172 An object of the form: 173 174 { # This resource represents a long-running operation that is the result of a network API call. 175 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 176 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 177 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 178 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 179 { 180 "a_key": "", # Properties of the object. Contains field @type with type URL. 181 }, 182 ], 183 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 184 }, 185 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 186 "a_key": "", # Properties of the object. Contains field @type with type URL. 187 }, 188 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 189 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 190 "a_key": "", # Properties of the object. Contains field @type with type URL. 191 }, 192}</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="get">get(name, x__xgafv=None)</code> 197 <pre>Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist. 198 199Args: 200 name: string, Required. The name of the glossary to retrieve. (required) 201 x__xgafv: string, V1 error format. 202 Allowed values 203 1 - v1 error format 204 2 - v2 error format 205 206Returns: 207 An object of the form: 208 209 { # Represents a glossary built from user provided data. 210 "endTime": "A String", # Output only. When the glossary creation was finished. 211 "entryCount": 42, # Output only. The number of entries defined in the glossary. 212 "inputConfig": { # Input configuration for glossaries. # Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints. 213 "gcsSource": { # The Google Cloud Storage location for the input content. # Required. Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (`.tsv`/`.csv`): 2 column file, tab- or comma-separated. The first column is source text. The second column is target text. The file must not contain headers. That is, the first row is data, not column names. - TMX (`.tmx`): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (`.csv`): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - [glossaries](https://cloud.google.com/translate/docs/advanced/glossary). 214 "inputUri": "A String", # Required. Source data URI. For example, `gs://my_bucket/my_object`. 215 }, 216 }, 217 "languageCodesSet": { # Used with equivalent term set glossaries. # Used with equivalent term set glossaries. 218 "languageCodes": [ # The BCP-47 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code. 219 "A String", 220 ], 221 }, 222 "languagePair": { # Used with unidirectional glossaries. # Used with unidirectional glossaries. 223 "sourceLanguageCode": "A String", # Required. The BCP-47 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code. 224 "targetLanguageCode": "A String", # Required. The BCP-47 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. 225 }, 226 "name": "A String", # Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`. 227 "submitTime": "A String", # Output only. When CreateGlossary was called. 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 233 <pre>Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. 234 235Args: 236 parent: string, Required. The name of the project from which to list all of the glossaries. (required) 237 filter: string, Optional. Filter specifying constraints of a list operation. Specify the constraint by the format of "key=value", where key must be "src" or "tgt", and the value must be a valid language code. For multiple restrictions, concatenate them by "AND" (uppercase only), such as: "src=en-US AND tgt=zh-CN". Notice that the exact match is used here, which means using 'en-US' and 'en' can lead to different results, which depends on the language code you used when you create the glossary. For the unidirectional glossaries, the "src" and "tgt" add restrictions on the source and target language code separately. For the equivalent term set glossaries, the "src" and/or "tgt" add restrictions on the term set. For example: "src=en-US AND tgt=zh-CN" will only pick the unidirectional glossaries which exactly match the source language code as "en-US" and the target language code "zh-CN", but all equivalent term set glossaries which contain "en-US" and "zh-CN" in their language set will be picked. If missing, no filtering is performed. 238 pageSize: integer, Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default. 239 pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing. 240 x__xgafv: string, V1 error format. 241 Allowed values 242 1 - v1 error format 243 2 - v2 error format 244 245Returns: 246 An object of the form: 247 248 { # Response message for ListGlossaries. 249 "glossaries": [ # The list of glossaries for a project. 250 { # Represents a glossary built from user provided data. 251 "endTime": "A String", # Output only. When the glossary creation was finished. 252 "entryCount": 42, # Output only. The number of entries defined in the glossary. 253 "inputConfig": { # Input configuration for glossaries. # Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints. 254 "gcsSource": { # The Google Cloud Storage location for the input content. # Required. Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (`.tsv`/`.csv`): 2 column file, tab- or comma-separated. The first column is source text. The second column is target text. The file must not contain headers. That is, the first row is data, not column names. - TMX (`.tmx`): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (`.csv`): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - [glossaries](https://cloud.google.com/translate/docs/advanced/glossary). 255 "inputUri": "A String", # Required. Source data URI. For example, `gs://my_bucket/my_object`. 256 }, 257 }, 258 "languageCodesSet": { # Used with equivalent term set glossaries. # Used with equivalent term set glossaries. 259 "languageCodes": [ # The BCP-47 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code. 260 "A String", 261 ], 262 }, 263 "languagePair": { # Used with unidirectional glossaries. # Used with unidirectional glossaries. 264 "sourceLanguageCode": "A String", # Required. The BCP-47 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code. 265 "targetLanguageCode": "A String", # Required. The BCP-47 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. 266 }, 267 "name": "A String", # Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`. 268 "submitTime": "A String", # Output only. When CreateGlossary was called. 269 }, 270 ], 271 "nextPageToken": "A String", # A token to retrieve a page of results. Pass this value in the [ListGlossariesRequest.page_token] field in the subsequent call to `ListGlossaries` method to retrieve the next page of results. 272}</pre> 273</div> 274 275<div class="method"> 276 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 277 <pre>Retrieves the next page of results. 278 279Args: 280 previous_request: The request for the previous page. (required) 281 previous_response: The response from the request for the previous page. (required) 282 283Returns: 284 A request object that you can call 'execute()' on to request the next 285 page. Returns None if there are no more items in the collection. 286 </pre> 287</div> 288 289</body></html>