com.google.cloud.vision.v1

Class ProductSearchSettings

java.lang.Object

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

com.google.cloud.vision.v1.ProductSearchSettings

@Generated(value="by gapic-generator")
public class ProductSearchSettings
extends ClientSettings<ProductSearchSettings>

Settings class to configure an instance of ProductSearchClient.

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 total timeout of createProduct to 30 seconds:

 
 ProductSearchSettings.Builder productSearchSettingsBuilder =
     ProductSearchSettings.newBuilder();
 productSearchSettingsBuilder.createProductSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 ProductSearchSettings productSearchSettings = productSearchSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<com.google.cloud.vision.v1.AddProductToProductSetRequest,Empty>	addProductToProductSetSettings() Returns the object with the settings used for calls to addProductToProductSet.
static ProductSearchSettings	create(ProductSearchStubSettings stub)
UnaryCallSettings<com.google.cloud.vision.v1.CreateProductSetRequest,com.google.cloud.vision.v1.ProductSet>	createProductSetSettings() Returns the object with the settings used for calls to createProductSet.
UnaryCallSettings<com.google.cloud.vision.v1.CreateProductRequest,com.google.cloud.vision.v1.Product>	createProductSettings() Returns the object with the settings used for calls to createProduct.
UnaryCallSettings<com.google.cloud.vision.v1.CreateReferenceImageRequest,com.google.cloud.vision.v1.ReferenceImage>	createReferenceImageSettings() Returns the object with the settings used for calls to createReferenceImage.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.cloud.vision.v1.DeleteProductSetRequest,Empty>	deleteProductSetSettings() Returns the object with the settings used for calls to deleteProductSet.
UnaryCallSettings<com.google.cloud.vision.v1.DeleteProductRequest,Empty>	deleteProductSettings() Returns the object with the settings used for calls to deleteProduct.
UnaryCallSettings<com.google.cloud.vision.v1.DeleteReferenceImageRequest,Empty>	deleteReferenceImageSettings() Returns the object with the settings used for calls to deleteReferenceImage.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.cloud.vision.v1.GetProductSetRequest,com.google.cloud.vision.v1.ProductSet>	getProductSetSettings() Returns the object with the settings used for calls to getProductSet.
UnaryCallSettings<com.google.cloud.vision.v1.GetProductRequest,com.google.cloud.vision.v1.Product>	getProductSettings() Returns the object with the settings used for calls to getProduct.
UnaryCallSettings<com.google.cloud.vision.v1.GetReferenceImageRequest,com.google.cloud.vision.v1.ReferenceImage>	getReferenceImageSettings() Returns the object with the settings used for calls to getReferenceImage.
OperationCallSettings<com.google.cloud.vision.v1.ImportProductSetsRequest,com.google.cloud.vision.v1.ImportProductSetsResponse,com.google.cloud.vision.v1.BatchOperationMetadata>	importProductSetsOperationSettings() Returns the object with the settings used for calls to importProductSets.
UnaryCallSettings<com.google.cloud.vision.v1.ImportProductSetsRequest,Operation>	importProductSetsSettings() Returns the object with the settings used for calls to importProductSets.
PagedCallSettings<com.google.cloud.vision.v1.ListProductSetsRequest,com.google.cloud.vision.v1.ListProductSetsResponse,ProductSearchClient.ListProductSetsPagedResponse>	listProductSetsSettings() Returns the object with the settings used for calls to listProductSets.
PagedCallSettings<com.google.cloud.vision.v1.ListProductsInProductSetRequest,com.google.cloud.vision.v1.ListProductsInProductSetResponse,ProductSearchClient.ListProductsInProductSetPagedResponse>	listProductsInProductSetSettings() Returns the object with the settings used for calls to listProductsInProductSet.
PagedCallSettings<com.google.cloud.vision.v1.ListProductsRequest,com.google.cloud.vision.v1.ListProductsResponse,ProductSearchClient.ListProductsPagedResponse>	listProductsSettings() Returns the object with the settings used for calls to listProducts.
PagedCallSettings<com.google.cloud.vision.v1.ListReferenceImagesRequest,com.google.cloud.vision.v1.ListReferenceImagesResponse,ProductSearchClient.ListReferenceImagesPagedResponse>	listReferenceImagesSettings() Returns the object with the settings used for calls to listReferenceImages.
static ProductSearchSettings.Builder	newBuilder() Returns a new builder for this class.
static ProductSearchSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<com.google.cloud.vision.v1.RemoveProductFromProductSetRequest,Empty>	removeProductFromProductSetSettings() Returns the object with the settings used for calls to removeProductFromProductSet.
ProductSearchSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.cloud.vision.v1.UpdateProductSetRequest,com.google.cloud.vision.v1.ProductSet>	updateProductSetSettings() Returns the object with the settings used for calls to updateProductSet.
UnaryCallSettings<com.google.cloud.vision.v1.UpdateProductRequest,com.google.cloud.vision.v1.Product>	updateProductSettings() Returns the object with the settings used for calls to updateProduct.

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

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductSearchSettings

protected ProductSearchSettings(ProductSearchSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

createProductSettings

public UnaryCallSettings<com.google.cloud.vision.v1.CreateProductRequest,com.google.cloud.vision.v1.Product> createProductSettings()

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

listProductsSettings

public PagedCallSettings<com.google.cloud.vision.v1.ListProductsRequest,com.google.cloud.vision.v1.ListProductsResponse,ProductSearchClient.ListProductsPagedResponse> listProductsSettings()

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

getProductSettings

public UnaryCallSettings<com.google.cloud.vision.v1.GetProductRequest,com.google.cloud.vision.v1.Product> getProductSettings()

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

updateProductSettings

public UnaryCallSettings<com.google.cloud.vision.v1.UpdateProductRequest,com.google.cloud.vision.v1.Product> updateProductSettings()

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

deleteProductSettings

public UnaryCallSettings<com.google.cloud.vision.v1.DeleteProductRequest,Empty> deleteProductSettings()

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

listReferenceImagesSettings

public PagedCallSettings<com.google.cloud.vision.v1.ListReferenceImagesRequest,com.google.cloud.vision.v1.ListReferenceImagesResponse,ProductSearchClient.ListReferenceImagesPagedResponse> listReferenceImagesSettings()

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

getReferenceImageSettings

public UnaryCallSettings<com.google.cloud.vision.v1.GetReferenceImageRequest,com.google.cloud.vision.v1.ReferenceImage> getReferenceImageSettings()

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

deleteReferenceImageSettings

public UnaryCallSettings<com.google.cloud.vision.v1.DeleteReferenceImageRequest,Empty> deleteReferenceImageSettings()

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

createReferenceImageSettings

public UnaryCallSettings<com.google.cloud.vision.v1.CreateReferenceImageRequest,com.google.cloud.vision.v1.ReferenceImage> createReferenceImageSettings()

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

createProductSetSettings

public UnaryCallSettings<com.google.cloud.vision.v1.CreateProductSetRequest,com.google.cloud.vision.v1.ProductSet> createProductSetSettings()

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

listProductSetsSettings

public PagedCallSettings<com.google.cloud.vision.v1.ListProductSetsRequest,com.google.cloud.vision.v1.ListProductSetsResponse,ProductSearchClient.ListProductSetsPagedResponse> listProductSetsSettings()

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

getProductSetSettings

public UnaryCallSettings<com.google.cloud.vision.v1.GetProductSetRequest,com.google.cloud.vision.v1.ProductSet> getProductSetSettings()

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

updateProductSetSettings

public UnaryCallSettings<com.google.cloud.vision.v1.UpdateProductSetRequest,com.google.cloud.vision.v1.ProductSet> updateProductSetSettings()

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

deleteProductSetSettings

public UnaryCallSettings<com.google.cloud.vision.v1.DeleteProductSetRequest,Empty> deleteProductSetSettings()

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

addProductToProductSetSettings

public UnaryCallSettings<com.google.cloud.vision.v1.AddProductToProductSetRequest,Empty> addProductToProductSetSettings()

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

removeProductFromProductSetSettings

public UnaryCallSettings<com.google.cloud.vision.v1.RemoveProductFromProductSetRequest,Empty> removeProductFromProductSetSettings()

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

listProductsInProductSetSettings

public PagedCallSettings<com.google.cloud.vision.v1.ListProductsInProductSetRequest,com.google.cloud.vision.v1.ListProductsInProductSetResponse,ProductSearchClient.ListProductsInProductSetPagedResponse> listProductsInProductSetSettings()

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

importProductSetsSettings

public UnaryCallSettings<com.google.cloud.vision.v1.ImportProductSetsRequest,Operation> importProductSetsSettings()

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

importProductSetsOperationSettings

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public OperationCallSettings<com.google.cloud.vision.v1.ImportProductSetsRequest,com.google.cloud.vision.v1.ImportProductSetsResponse,com.google.cloud.vision.v1.BatchOperationMetadata> importProductSetsOperationSettings()

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

create

public static final ProductSearchSettings create(ProductSearchStubSettings stub)
                                          throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static 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 GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static ProductSearchSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static ProductSearchSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public ProductSearchSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<ProductSearchSettings>