go: cloud.google.com/go/translate/apiv3 Index | Examples | Files

package translate

import "cloud.google.com/go/translate/apiv3"

Index

Examples

Package Files

doc.go translation_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

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

type BatchTranslateTextOperation Uses

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

BatchTranslateTextOperation manages a long-running operation from BatchTranslateText.

func (*BatchTranslateTextOperation) Done Uses

func (op *BatchTranslateTextOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*BatchTranslateTextOperation) Metadata Uses

func (op *BatchTranslateTextOperation) Metadata() (*translatepb.BatchTranslateMetadata, error)

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 Uses

func (op *BatchTranslateTextOperation) 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 (*BatchTranslateTextOperation) Poll Uses

func (op *BatchTranslateTextOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*translatepb.BatchTranslateResponse, error)

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 Uses

func (op *BatchTranslateTextOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*translatepb.BatchTranslateResponse, error)

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 Uses

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

CreateGlossaryOperation manages a long-running operation from CreateGlossary.

func (*CreateGlossaryOperation) Done Uses

func (op *CreateGlossaryOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*CreateGlossaryOperation) Metadata Uses

func (op *CreateGlossaryOperation) Metadata() (*translatepb.CreateGlossaryMetadata, error)

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 Uses

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 Uses

func (op *CreateGlossaryOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*translatepb.Glossary, error)

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 Uses

func (op *CreateGlossaryOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*translatepb.Glossary, error)

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 Uses

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

DeleteGlossaryOperation manages a long-running operation from DeleteGlossary.

func (*DeleteGlossaryOperation) Done Uses

func (op *DeleteGlossaryOperation) Done() bool

Done reports whether the long-running operation has completed.

func (*DeleteGlossaryOperation) Metadata Uses

func (op *DeleteGlossaryOperation) Metadata() (*translatepb.DeleteGlossaryMetadata, error)

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 Uses

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 Uses

func (op *DeleteGlossaryOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*translatepb.DeleteGlossaryResponse, error)

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 Uses

func (op *DeleteGlossaryOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*translatepb.DeleteGlossaryResponse, error)

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 Uses

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 Uses

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 Uses

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

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

type TranslationCallOptions Uses

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 Uses

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 Uses

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

NewTranslationClient creates a new translation service client.

Provides natural language translation operations.

Code:

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*TranslationClient) BatchTranslateText Uses

func (c *TranslationClient) BatchTranslateText(ctx context.Context, req *translatepb.BatchTranslateTextRequest, opts ...gax.CallOption) (*BatchTranslateTextOperation, error)

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.

Code:

// import translatepb "google.golang.org/genproto/googleapis/cloud/translate/v3"

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &translatepb.BatchTranslateTextRequest{
    // TODO: Fill request struct fields.
}
op, err := c.BatchTranslateText(ctx, req)
if err != nil {
    // TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*TranslationClient) BatchTranslateTextOperation Uses

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 Uses

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 Uses

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

Connection returns the client's connection to the API service.

func (*TranslationClient) CreateGlossary Uses

func (c *TranslationClient) CreateGlossary(ctx context.Context, req *translatepb.CreateGlossaryRequest, opts ...gax.CallOption) (*CreateGlossaryOperation, error)

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

Code:

// import translatepb "google.golang.org/genproto/googleapis/cloud/translate/v3"

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &translatepb.CreateGlossaryRequest{
    // TODO: Fill request struct fields.
}
op, err := c.CreateGlossary(ctx, req)
if err != nil {
    // TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*TranslationClient) CreateGlossaryOperation Uses

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 Uses

func (c *TranslationClient) DeleteGlossary(ctx context.Context, req *translatepb.DeleteGlossaryRequest, opts ...gax.CallOption) (*DeleteGlossaryOperation, error)

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

Code:

// import translatepb "google.golang.org/genproto/googleapis/cloud/translate/v3"

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &translatepb.DeleteGlossaryRequest{
    // TODO: Fill request struct fields.
}
op, err := c.DeleteGlossary(ctx, req)
if err != nil {
    // TODO: Handle error.
}

resp, err := op.Wait(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*TranslationClient) DeleteGlossaryOperation Uses

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 Uses

func (c *TranslationClient) DetectLanguage(ctx context.Context, req *translatepb.DetectLanguageRequest, opts ...gax.CallOption) (*translatepb.DetectLanguageResponse, error)

DetectLanguage detects the language of text within a request.

Code:

// import translatepb "google.golang.org/genproto/googleapis/cloud/translate/v3"

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &translatepb.DetectLanguageRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.DetectLanguage(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*TranslationClient) GetGlossary Uses

func (c *TranslationClient) GetGlossary(ctx context.Context, req *translatepb.GetGlossaryRequest, opts ...gax.CallOption) (*translatepb.Glossary, error)

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

Code:

// import translatepb "google.golang.org/genproto/googleapis/cloud/translate/v3"

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &translatepb.GetGlossaryRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetGlossary(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*TranslationClient) GetSupportedLanguages Uses

func (c *TranslationClient) GetSupportedLanguages(ctx context.Context, req *translatepb.GetSupportedLanguagesRequest, opts ...gax.CallOption) (*translatepb.SupportedLanguages, error)

GetSupportedLanguages returns a list of supported languages for translation.

Code:

// import translatepb "google.golang.org/genproto/googleapis/cloud/translate/v3"

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &translatepb.GetSupportedLanguagesRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.GetSupportedLanguages(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*TranslationClient) ListGlossaries Uses

func (c *TranslationClient) ListGlossaries(ctx context.Context, req *translatepb.ListGlossariesRequest, opts ...gax.CallOption) *GlossaryIterator

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

Code:

// import translatepb "google.golang.org/genproto/googleapis/cloud/translate/v3"
// import "google.golang.org/api/iterator"

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &translatepb.ListGlossariesRequest{
    // TODO: Fill request struct fields.
}
it := c.ListGlossaries(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*TranslationClient) TranslateText Uses

func (c *TranslationClient) TranslateText(ctx context.Context, req *translatepb.TranslateTextRequest, opts ...gax.CallOption) (*translatepb.TranslateTextResponse, error)

TranslateText translates input text and returns translated text.

Code:

// import translatepb "google.golang.org/genproto/googleapis/cloud/translate/v3"

ctx := context.Background()
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &translatepb.TranslateTextRequest{
    // TODO: Fill request struct fields.
}
resp, err := c.TranslateText(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Package translate imports 20 packages (graph). Updated 2019-12-07. Refresh now. Tools for package owners.