Class RemoteTranslateHelper (2.80.0)

public class RemoteTranslateHelper

Utility to create a remote translate configuration for testing. Translate options can be obtained via the #getOptions() ()} method. Returned options have custom TranslateOptions#getRetrySettings(): RetrySettings#getMaxAttempts() is 10, RetrySettings#getMaxRetryDelay() is 30000, RetrySettings#getTotalTimeout() is 120000 and RetrySettings#getInitialRetryDelay() is 250. HttpTransportOptions#getConnectTimeout() and HttpTransportOptions#getReadTimeout() are both both set to 60000.

Inheritance

java.lang.Object > RemoteTranslateHelper

Static Methods

create()

public static RemoteTranslateHelper create()

Creates a RemoteTranslateHelper object using default project id and authentication credentials.

Returns
Type Description
RemoteTranslateHelper

create(String apiKey) (deprecated)

public static RemoteTranslateHelper create(String apiKey)

Creates a RemoteTranslateHelper object for the given API key.

Parameter
Name Description
apiKey String

API key used to issue requests to Google Translation.

Returns
Type Description
RemoteTranslateHelper

create(String projectId, GoogleCredentials credentials)

public static RemoteTranslateHelper create(String projectId, GoogleCredentials credentials)

Creates a RemoteTranslateHelper object for the given project id and JSON key input stream.

Parameters
Name Description
projectId String

id of the project to be used for running the tests

credentials com.google.auth.oauth2.GoogleCredentials

GoogleCredential to set to TranslateOptions

Returns
Type Description
RemoteTranslateHelper

A RemoteTranslateHelper object for the provided options

create(String projectId, InputStream keyStream)

public static RemoteTranslateHelper create(String projectId, InputStream keyStream)

This method is obsolete because of a potential security risk. Use the #create(String, GoogleCredentials) method instead.

If you know that you will be loading credential configurations of a specific type, it is recommended to use a credential-type-specific fromStream() method. This will ensure that an unexpected credential type with potential for malicious intent is not loaded unintentionally. You might still have to do validation for certain credential types. Please follow the recommendation for that method.

If you are loading your credential configuration from an untrusted source and have not mitigated the risks (e.g. by validating the configuration yourself), make these changes as soon as possible to prevent security risks to your environment.

Regardless of the method used, it is always your responsibility to validate configurations received from external sources.

See the {@link documentation} for more details.

Creates a RemoteTranslateHelper object for the given project id and JSON key input stream.

Parameters
Name Description
projectId String

id of the project to be used for running the tests

keyStream InputStream

input stream for a JSON key

Returns
Type Description
RemoteTranslateHelper

A RemoteTranslateHelper object for the provided options

Exceptions
Type Description
RemoteTranslateHelper.TranslateHelperException

if keyStream is not a valid JSON key stream

Methods

getOptions()

public TranslateOptions getOptions()

Returns a TranslateOptions object to be used for testing.

Returns
Type Description
TranslateOptions