Documentation

Overview

Package translate is an auto-generated package for the Cloud Translation API.

Integrates text translation into your website or application.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

    DefaultAuthScopes reports the default set of authentication scopes to use with this package.

    Types

    type BatchTranslateTextOperation

    type BatchTranslateTextOperation struct {
    	// contains filtered or unexported fields
    }

      BatchTranslateTextOperation manages a long-running operation from BatchTranslateText.

      func (*BatchTranslateTextOperation) Done

      func (op *BatchTranslateTextOperation) Done() bool

        Done reports whether the long-running operation has completed.

        func (*BatchTranslateTextOperation) Metadata

          Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

          func (*BatchTranslateTextOperation) Name

            Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

            func (*BatchTranslateTextOperation) Poll

              Poll fetches the latest state of the long-running operation.

              Poll also fetches the latest metadata, which can be retrieved by Metadata.

              If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

              func (*BatchTranslateTextOperation) Wait

                Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

                See documentation of Poll for error-handling information.

                type CreateGlossaryOperation

                type CreateGlossaryOperation struct {
                	// contains filtered or unexported fields
                }

                  CreateGlossaryOperation manages a long-running operation from CreateGlossary.

                  func (*CreateGlossaryOperation) Done

                  func (op *CreateGlossaryOperation) Done() bool

                    Done reports whether the long-running operation has completed.

                    func (*CreateGlossaryOperation) Metadata

                      Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

                      func (*CreateGlossaryOperation) Name

                      func (op *CreateGlossaryOperation) Name() string

                        Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

                        func (*CreateGlossaryOperation) Poll

                          Poll fetches the latest state of the long-running operation.

                          Poll also fetches the latest metadata, which can be retrieved by Metadata.

                          If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

                          func (*CreateGlossaryOperation) Wait

                            Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

                            See documentation of Poll for error-handling information.

                            type DeleteGlossaryOperation

                            type DeleteGlossaryOperation struct {
                            	// contains filtered or unexported fields
                            }

                              DeleteGlossaryOperation manages a long-running operation from DeleteGlossary.

                              func (*DeleteGlossaryOperation) Done

                              func (op *DeleteGlossaryOperation) Done() bool

                                Done reports whether the long-running operation has completed.

                                func (*DeleteGlossaryOperation) Metadata

                                  Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.

                                  func (*DeleteGlossaryOperation) Name

                                  func (op *DeleteGlossaryOperation) Name() string

                                    Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.

                                    func (*DeleteGlossaryOperation) Poll

                                      Poll fetches the latest state of the long-running operation.

                                      Poll also fetches the latest metadata, which can be retrieved by Metadata.

                                      If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.

                                      func (*DeleteGlossaryOperation) Wait

                                        Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

                                        See documentation of Poll for error-handling information.

                                        type GlossaryIterator

                                        type GlossaryIterator struct {
                                        
                                        	// Response is the raw response for the current page.
                                        	// It must be cast to the RPC response type.
                                        	// Calling Next() or InternalFetch() updates this value.
                                        	Response interface{}
                                        
                                        	// InternalFetch is for use by the Google Cloud Libraries only.
                                        	// It is not part of the stable interface of this package.
                                        	//
                                        	// InternalFetch returns results from a single call to the underlying RPC.
                                        	// The number of results is no greater than pageSize.
                                        	// If there are no more results, nextPageToken is empty and err is nil.
                                        	InternalFetch func(pageSize int, pageToken string) (results []*translatepb.Glossary, nextPageToken string, err error)
                                        	// contains filtered or unexported fields
                                        }

                                          GlossaryIterator manages a stream of *translatepb.Glossary.

                                          func (*GlossaryIterator) Next

                                          func (it *GlossaryIterator) Next() (*translatepb.Glossary, error)

                                            Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

                                            func (*GlossaryIterator) PageInfo

                                            func (it *GlossaryIterator) PageInfo() *iterator.PageInfo

                                              PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

                                              type TranslationCallOptions

                                              type TranslationCallOptions struct {
                                              	TranslateText         []gax.CallOption
                                              	DetectLanguage        []gax.CallOption
                                              	GetSupportedLanguages []gax.CallOption
                                              	BatchTranslateText    []gax.CallOption
                                              	CreateGlossary        []gax.CallOption
                                              	ListGlossaries        []gax.CallOption
                                              	GetGlossary           []gax.CallOption
                                              	DeleteGlossary        []gax.CallOption
                                              }

                                                TranslationCallOptions contains the retry settings for each method of TranslationClient.

                                                type TranslationClient

                                                type TranslationClient struct {
                                                
                                                	// LROClient is used internally to handle longrunning operations.
                                                	// It is exposed so that its CallOptions can be modified if required.
                                                	// Users should not Close this client.
                                                	LROClient *lroauto.OperationsClient
                                                
                                                	// The call options for this service.
                                                	CallOptions *TranslationCallOptions
                                                	// contains filtered or unexported fields
                                                }

                                                  TranslationClient is a client for interacting with Cloud Translation API.

                                                  Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

                                                  func NewTranslationClient

                                                  func NewTranslationClient(ctx context.Context, opts ...option.ClientOption) (*TranslationClient, error)

                                                    NewTranslationClient creates a new translation service client.

                                                    Provides natural language translation operations.

                                                    Example
                                                    Output:
                                                    
                                                    

                                                    func (*TranslationClient) BatchTranslateText

                                                      BatchTranslateText translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it’s all or nothing) may still be available on the specified output location.

                                                      This call returns immediately and you can use google.longrunning.Operation.name (at http://google.longrunning.Operation.name) to poll the status of the call.

                                                      Example
                                                      Output:
                                                      
                                                      

                                                      func (*TranslationClient) BatchTranslateTextOperation

                                                      func (c *TranslationClient) BatchTranslateTextOperation(name string) *BatchTranslateTextOperation

                                                        BatchTranslateTextOperation returns a new BatchTranslateTextOperation from a given name. The name must be that of a previously created BatchTranslateTextOperation, possibly from a different process.

                                                        func (*TranslationClient) Close

                                                        func (c *TranslationClient) Close() error

                                                          Close closes the connection to the API service. The user should invoke this when the client is no longer required.

                                                          func (*TranslationClient) Connection

                                                          func (c *TranslationClient) Connection() *grpc.ClientConn

                                                            Connection returns a connection to the API service.

                                                            Deprecated.

                                                            func (*TranslationClient) CreateGlossary

                                                              CreateGlossary creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn’t exist.

                                                              Example
                                                              Output:
                                                              
                                                              

                                                              func (*TranslationClient) CreateGlossaryOperation

                                                              func (c *TranslationClient) CreateGlossaryOperation(name string) *CreateGlossaryOperation

                                                                CreateGlossaryOperation returns a new CreateGlossaryOperation from a given name. The name must be that of a previously created CreateGlossaryOperation, possibly from a different process.

                                                                func (*TranslationClient) DeleteGlossary

                                                                  DeleteGlossary deletes a glossary, or cancels glossary construction if the glossary isn’t created yet. Returns NOT_FOUND, if the glossary doesn’t exist.

                                                                  Example
                                                                  Output:
                                                                  
                                                                  

                                                                  func (*TranslationClient) DeleteGlossaryOperation

                                                                  func (c *TranslationClient) DeleteGlossaryOperation(name string) *DeleteGlossaryOperation

                                                                    DeleteGlossaryOperation returns a new DeleteGlossaryOperation from a given name. The name must be that of a previously created DeleteGlossaryOperation, possibly from a different process.

                                                                    func (*TranslationClient) DetectLanguage

                                                                      DetectLanguage detects the language of text within a request.

                                                                      Example
                                                                      Output:
                                                                      
                                                                      

                                                                      func (*TranslationClient) GetGlossary

                                                                        GetGlossary gets a glossary. Returns NOT_FOUND, if the glossary doesn’t exist.

                                                                        Example
                                                                        Output:
                                                                        
                                                                        

                                                                        func (*TranslationClient) GetSupportedLanguages

                                                                          GetSupportedLanguages returns a list of supported languages for translation.

                                                                          Example
                                                                          Output:
                                                                          
                                                                          

                                                                          func (*TranslationClient) ListGlossaries

                                                                            ListGlossaries lists glossaries in a project. Returns NOT_FOUND, if the project doesn’t exist.

                                                                            Example
                                                                            Output:
                                                                            
                                                                            

                                                                            func (*TranslationClient) TranslateText

                                                                              TranslateText translates input text and returns translated text.

                                                                              Example
                                                                              Output: