Cloud Translation API v3 - Package cloud.google.com/go/translate/apiv3 (v1.12.6)

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

Integrates text translation into your website or application.

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

• Authentication and Authorization
• Timeouts and Cancellation
• Testing against Client Libraries
• Debugging Client Libraries
• Inspecting errors

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/translate/apiv3@latest
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := translate.NewTranslationClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client, mentioned above.

req := &translatepb.AdaptiveMtTranslateRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/translate/apiv3/translatepb#AdaptiveMtTranslateRequest.
}
resp, err := c.AdaptiveMtTranslate(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewTranslationClient 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.

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

AdaptiveMtDatasetIterator manages a stream of *translatepb.AdaptiveMtDataset.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

AdaptiveMtFileIterator manages a stream of *translatepb.AdaptiveMtFile.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

AdaptiveMtSentenceIterator manages a stream of *translatepb.AdaptiveMtSentence.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

BatchTranslateDocumentOperation manages a long-running operation from BatchTranslateDocument.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

BatchTranslateTextOperation manages a long-running operation from BatchTranslateText.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

CreateDatasetOperation manages a long-running operation from CreateDataset.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

CreateGlossaryOperation manages a long-running operation from CreateGlossary.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

CreateModelOperation manages a long-running operation from CreateModel.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

DatasetIterator manages a stream of *translatepb.Dataset.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

DeleteDatasetOperation manages a long-running operation from DeleteDataset.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

DeleteGlossaryOperation manages a long-running operation from DeleteGlossary.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

DeleteModelOperation manages a long-running operation from DeleteModel.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

ExampleIterator manages a stream of *translatepb.Example.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

ExportDataOperation manages a long-running operation from ExportData.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

GlossaryEntryIterator manages a stream of *translatepb.GlossaryEntry.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

GlossaryIterator manages a stream of *translatepb.Glossary.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

ImportDataOperation manages a long-running operation from ImportData.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

LocationIterator manages a stream of *locationpb.Location.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

ModelIterator manages a stream of *translatepb.Model.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

OperationIterator manages a stream of *longrunningpb.Operation.

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

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.

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

TranslationCallOptions contains the retry settings for each method of TranslationClient.

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.

Provides natural language translation operations.

NewTranslationClient creates a new translation service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Provides natural language translation operations.

NewTranslationRESTClient creates a new translation service rest client.

Provides natural language translation operations.

AdaptiveMtTranslate translate text using Adaptive MT.

BatchTranslateDocument translates a large volume of document 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.