| <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. | |
| "description": "A String", # Describes the glossary entry. | |
| "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" | |
| "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. | |
| "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| "targetTerm": { # Represents a single glossary term # The term that will replace the match source term. | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| }, | |
| "termsSet": { # 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. | |
| "terms": [ # Each term in the set represents a term that can be replaced by the other terms. | |
| { # Represents a single glossary term | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # 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. | |
| "description": "A String", # Describes the glossary entry. | |
| "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" | |
| "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. | |
| "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| "targetTerm": { # Represents a single glossary term # The term that will replace the match source term. | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| }, | |
| "termsSet": { # 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. | |
| "terms": [ # Each term in the set represents a term that can be replaced by the other terms. | |
| { # Represents a single glossary term | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # 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. | |
| "description": "A String", # Describes the glossary entry. | |
| "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" | |
| "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. | |
| "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| "targetTerm": { # Represents a single glossary term # The term that will replace the match source term. | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| }, | |
| "termsSet": { # 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. | |
| "terms": [ # Each term in the set represents a term that can be replaced by the other terms. | |
| { # Represents a single glossary term | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # 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'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 | |
| "glossaryEntries": [ # Optional. The Glossary Entries | |
| { # Represents a single entry in a glossary. | |
| "description": "A String", # Describes the glossary entry. | |
| "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" | |
| "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. | |
| "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| "targetTerm": { # Represents a single glossary term # The term that will replace the match source term. | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| }, | |
| "termsSet": { # 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. | |
| "terms": [ # Each term in the set represents a term that can be replaced by the other terms. | |
| { # Represents a single glossary term | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| ], | |
| }, | |
| }, | |
| ], | |
| "nextPageToken": "A String", # 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 'execute()' 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, Required. 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. | |
| "description": "A String", # Describes the glossary entry. | |
| "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" | |
| "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. | |
| "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| "targetTerm": { # Represents a single glossary term # The term that will replace the match source term. | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| }, | |
| "termsSet": { # 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. | |
| "terms": [ # Each term in the set represents a term that can be replaced by the other terms. | |
| { # Represents a single glossary term | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # 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. | |
| "description": "A String", # Describes the glossary entry. | |
| "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" | |
| "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. | |
| "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| "targetTerm": { # Represents a single glossary term # The term that will replace the match source term. | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| }, | |
| "termsSet": { # 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. | |
| "terms": [ # Each term in the set represents a term that can be replaced by the other terms. | |
| { # Represents a single glossary term | |
| "languageCode": "A String", # The language for this glossary term. | |
| "text": "A String", # The text for the glossary term. | |
| }, | |
| ], | |
| }, | |
| }</pre> | |
| </div> | |
| </body></html> |