Cloud Translation API . projects . locations . glossaries . glossaryEntries

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a glossary entry.

delete(name, x__xgafv=None)

Deletes a single entry from the glossary

get(name, x__xgafv=None)

Gets a single glossary entry by the given id.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

List the entries for the glossary.

list_next()

Retrieves the next page of results.

patch(name, body=None, x__xgafv=None)

Updates a glossary entry.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
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", # Identifier. 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", # Identifier. 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.
      },
    ],
  },
}
delete(name, x__xgafv=None)
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); }
}
get(name, x__xgafv=None)
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", # Identifier. 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.
      },
    ],
  },
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
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", # Identifier. 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.
}
list_next()
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.
        
patch(name, body=None, x__xgafv=None)
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.
  "description": "A String", # Describes the glossary entry.
  "name": "A String", # Identifier. 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", # Identifier. 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.
      },
    ],
  },
}