com.google.cloud.vision.v1p2beta1

Class ImageAnnotatorSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<ImageAnnotatorSettings>

com.google.cloud.vision.v1p2beta1.ImageAnnotatorSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class ImageAnnotatorSettings
extends com.google.api.gax.rpc.ClientSettings<ImageAnnotatorSettings>

Settings class to configure an instance of ImageAnnotatorClient.

The default instance has everything set to sensible defaults:

• The default service address (vision.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of batchAnnotateImages:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ImageAnnotatorSettings.Builder imageAnnotatorSettingsBuilder =
     ImageAnnotatorSettings.newBuilder();
 imageAnnotatorSettingsBuilder
     .batchAnnotateImagesSettings()
     .setRetrySettings(
         imageAnnotatorSettingsBuilder
             .batchAnnotateImagesSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 ImageAnnotatorSettings imageAnnotatorSettings = imageAnnotatorSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for asyncBatchAnnotateFiles:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ImageAnnotatorSettings.Builder imageAnnotatorSettingsBuilder =
     ImageAnnotatorSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 imageAnnotatorSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImageAnnotatorSettings.Builder Builder for ImageAnnotatorSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImageAnnotatorSettings(ImageAnnotatorSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<AsyncBatchAnnotateFilesRequest,AsyncBatchAnnotateFilesResponse,OperationMetadata>	asyncBatchAnnotateFilesOperationSettings() Returns the object with the settings used for calls to asyncBatchAnnotateFiles.
com.google.api.gax.rpc.UnaryCallSettings<AsyncBatchAnnotateFilesRequest,com.google.longrunning.Operation>	asyncBatchAnnotateFilesSettings() Returns the object with the settings used for calls to asyncBatchAnnotateFiles.
com.google.api.gax.rpc.UnaryCallSettings<BatchAnnotateImagesRequest,BatchAnnotateImagesResponse>	batchAnnotateImagesSettings() Returns the object with the settings used for calls to batchAnnotateImages.
static ImageAnnotatorSettings	create(ImageAnnotatorStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
static ImageAnnotatorSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static ImageAnnotatorSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static ImageAnnotatorSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
ImageAnnotatorSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageAnnotatorSettings

protected ImageAnnotatorSettings(ImageAnnotatorSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

batchAnnotateImagesSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchAnnotateImagesRequest,BatchAnnotateImagesResponse> batchAnnotateImagesSettings()

Returns the object with the settings used for calls to batchAnnotateImages.

asyncBatchAnnotateFilesSettings

public com.google.api.gax.rpc.UnaryCallSettings<AsyncBatchAnnotateFilesRequest,com.google.longrunning.Operation> asyncBatchAnnotateFilesSettings()

Returns the object with the settings used for calls to asyncBatchAnnotateFiles.

asyncBatchAnnotateFilesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<AsyncBatchAnnotateFilesRequest,AsyncBatchAnnotateFilesResponse,OperationMetadata> asyncBatchAnnotateFilesOperationSettings()

Returns the object with the settings used for calls to asyncBatchAnnotateFiles.

create

public static final ImageAnnotatorSettings create(ImageAnnotatorStubSettings stub)
                                           throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static ImageAnnotatorSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static ImageAnnotatorSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static ImageAnnotatorSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public ImageAnnotatorSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<ImageAnnotatorSettings>