com.google.api.services.translate.v3

Class Translate.Projects.Locations.Glossaries

java.lang.Object

com.google.api.services.translate.v3.Translate.Projects.Locations.Glossaries

Enclosing class:

Translate.Projects.Locations

public class Translate.Projects.Locations.Glossaries
extends Object

The "glossaries" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Translate.Projects.Locations.Glossaries.Create
class	Translate.Projects.Locations.Glossaries.Delete
class	Translate.Projects.Locations.Glossaries.Get
class	Translate.Projects.Locations.Glossaries.GlossaryEntries The "glossaryEntries" collection of methods.
class	Translate.Projects.Locations.Glossaries.List
class	Translate.Projects.Locations.Glossaries.Patch

Constructor Summary

Constructors

Constructor and Description
Glossaries()

Method Summary

Modifier and Type	Method and Description
Translate.Projects.Locations.Glossaries.Create	create(String parent, Glossary content) Creates a glossary and returns the long-running operation.
Translate.Projects.Locations.Glossaries.Delete	delete(String name) Deletes a glossary, or cancels glossary construction if the glossary isn't created yet.
Translate.Projects.Locations.Glossaries.Get	get(String name) Gets a glossary.
Translate.Projects.Locations.Glossaries.GlossaryEntries	glossaryEntries() An accessor for creating requests from the GlossaryEntries collection.
Translate.Projects.Locations.Glossaries.List	list(String parent) Lists glossaries in a project.
Translate.Projects.Locations.Glossaries.Patch	patch(String name, Glossary content) Updates a glossary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Glossaries

public Glossaries()

Method Detail

create

public Translate.Projects.Locations.Glossaries.Create create(String parent,
                                                             Glossary content)
                                                      throws IOException

Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist. Create a request for the method "glossaries.create". This request holds the parameters needed by the translate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The project name.

content - the Glossary

Returns:

the request

Throws:

IOException

delete

public Translate.Projects.Locations.Glossaries.Delete delete(String name)
                                                      throws IOException

Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist. Create a request for the method "glossaries.delete". This request holds the parameters needed by the translate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the glossary to delete.

Returns:

the request

Throws:

IOException

get

public Translate.Projects.Locations.Glossaries.Get get(String name)
                                                throws IOException

Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist. Create a request for the method "glossaries.get". This request holds the parameters needed by the translate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The name of the glossary to retrieve.

Returns:

the request

Throws:

IOException

list

public Translate.Projects.Locations.Glossaries.List list(String parent)
                                                  throws IOException

Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. Create a request for the method "glossaries.list". This request holds the parameters needed by the translate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The name of the project from which to list all of the glossaries.

Returns:

the request

Throws:

IOException

patch

public Translate.Projects.Locations.Glossaries.Patch patch(String name,
                                                           Glossary content)
                                                    throws IOException

Updates a glossary. A LRO is used since the update can be async if the glossary's entry file is updated. Create a request for the method "glossaries.patch". This request holds the parameters needed by the translate server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. The resource name of the glossary. Glossary names have the form `projects/{project-number- or-id}/locations/{location-id}/glossaries/{glossary-id}`.

content - the Glossary

Returns:

the request

Throws:

IOException

glossaryEntries

public Translate.Projects.Locations.Glossaries.GlossaryEntries glossaryEntries()

An accessor for creating requests from the GlossaryEntries collection.

The typical use is:

    Translate translate = new Translate(...);
    Translate.GlossaryEntries.List request = translate.glossaryEntries().list(parameters ...)
 

Returns:

the resource collection