com.google.cloud.vision.v1p3beta1

Class ProductSearchSettings

java.lang.Object

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

com.google.cloud.vision.v1p3beta1.ProductSearchSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class ProductSearchSettings
extends com.google.api.gax.rpc.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 createProductSet to 30 seconds:

 // 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
 ProductSearchSettings.Builder productSearchSettingsBuilder = ProductSearchSettings.newBuilder();
 productSearchSettingsBuilder
     .createProductSetSettings()
     .setRetrySettings(
         productSearchSettingsBuilder
             .createProductSetSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 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
com.google.api.gax.rpc.UnaryCallSettings<AddProductToProductSetRequest,com.google.protobuf.Empty>	addProductToProductSetSettings() Returns the object with the settings used for calls to addProductToProductSet.
static ProductSearchSettings	create(ProductSearchStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateProductSetRequest,ProductSet>	createProductSetSettings() Returns the object with the settings used for calls to createProductSet.
com.google.api.gax.rpc.UnaryCallSettings<CreateProductRequest,Product>	createProductSettings() Returns the object with the settings used for calls to createProduct.
com.google.api.gax.rpc.UnaryCallSettings<CreateReferenceImageRequest,ReferenceImage>	createReferenceImageSettings() Returns the object with the settings used for calls to createReferenceImage.
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()
com.google.api.gax.rpc.UnaryCallSettings<DeleteProductSetRequest,com.google.protobuf.Empty>	deleteProductSetSettings() Returns the object with the settings used for calls to deleteProductSet.
com.google.api.gax.rpc.UnaryCallSettings<DeleteProductRequest,com.google.protobuf.Empty>	deleteProductSettings() Returns the object with the settings used for calls to deleteProduct.
com.google.api.gax.rpc.UnaryCallSettings<DeleteReferenceImageRequest,com.google.protobuf.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.
com.google.api.gax.rpc.UnaryCallSettings<GetProductSetRequest,ProductSet>	getProductSetSettings() Returns the object with the settings used for calls to getProductSet.
com.google.api.gax.rpc.UnaryCallSettings<GetProductRequest,Product>	getProductSettings() Returns the object with the settings used for calls to getProduct.
com.google.api.gax.rpc.UnaryCallSettings<GetReferenceImageRequest,ReferenceImage>	getReferenceImageSettings() Returns the object with the settings used for calls to getReferenceImage.
com.google.api.gax.rpc.OperationCallSettings<ImportProductSetsRequest,ImportProductSetsResponse,BatchOperationMetadata>	importProductSetsOperationSettings() Returns the object with the settings used for calls to importProductSets.
com.google.api.gax.rpc.UnaryCallSettings<ImportProductSetsRequest,com.google.longrunning.Operation>	importProductSetsSettings() Returns the object with the settings used for calls to importProductSets.
com.google.api.gax.rpc.PagedCallSettings<ListProductSetsRequest,ListProductSetsResponse,ProductSearchClient.ListProductSetsPagedResponse>	listProductSetsSettings() Returns the object with the settings used for calls to listProductSets.
com.google.api.gax.rpc.PagedCallSettings<ListProductsInProductSetRequest,ListProductsInProductSetResponse,ProductSearchClient.ListProductsInProductSetPagedResponse>	listProductsInProductSetSettings() Returns the object with the settings used for calls to listProductsInProductSet.
com.google.api.gax.rpc.PagedCallSettings<ListProductsRequest,ListProductsResponse,ProductSearchClient.ListProductsPagedResponse>	listProductsSettings() Returns the object with the settings used for calls to listProducts.
com.google.api.gax.rpc.PagedCallSettings<ListReferenceImagesRequest,ListReferenceImagesResponse,ProductSearchClient.ListReferenceImagesPagedResponse>	listReferenceImagesSettings() Returns the object with the settings used for calls to listReferenceImages.
static ProductSearchSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static ProductSearchSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static ProductSearchSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<RemoveProductFromProductSetRequest,com.google.protobuf.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.
com.google.api.gax.rpc.UnaryCallSettings<UpdateProductSetRequest,ProductSet>	updateProductSetSettings() Returns the object with the settings used for calls to updateProductSet.
com.google.api.gax.rpc.UnaryCallSettings<UpdateProductRequest,Product>	updateProductSettings() Returns the object with the settings used for calls to updateProduct.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, 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

createProductSetSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateProductSetRequest,ProductSet> createProductSetSettings()

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

listProductSetsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListProductSetsRequest,ListProductSetsResponse,ProductSearchClient.ListProductSetsPagedResponse> listProductSetsSettings()

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

getProductSetSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetProductSetRequest,ProductSet> getProductSetSettings()

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

updateProductSetSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateProductSetRequest,ProductSet> updateProductSetSettings()

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

deleteProductSetSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteProductSetRequest,com.google.protobuf.Empty> deleteProductSetSettings()

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

createProductSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateProductRequest,Product> createProductSettings()

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

listProductsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListProductsRequest,ListProductsResponse,ProductSearchClient.ListProductsPagedResponse> listProductsSettings()

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

getProductSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetProductRequest,Product> getProductSettings()

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

updateProductSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateProductRequest,Product> updateProductSettings()

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

deleteProductSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteProductRequest,com.google.protobuf.Empty> deleteProductSettings()

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

createReferenceImageSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateReferenceImageRequest,ReferenceImage> createReferenceImageSettings()

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

deleteReferenceImageSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteReferenceImageRequest,com.google.protobuf.Empty> deleteReferenceImageSettings()

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

listReferenceImagesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListReferenceImagesRequest,ListReferenceImagesResponse,ProductSearchClient.ListReferenceImagesPagedResponse> listReferenceImagesSettings()

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

getReferenceImageSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetReferenceImageRequest,ReferenceImage> getReferenceImageSettings()

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

addProductToProductSetSettings

public com.google.api.gax.rpc.UnaryCallSettings<AddProductToProductSetRequest,com.google.protobuf.Empty> addProductToProductSetSettings()

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

removeProductFromProductSetSettings

public com.google.api.gax.rpc.UnaryCallSettings<RemoveProductFromProductSetRequest,com.google.protobuf.Empty> removeProductFromProductSetSettings()

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

listProductsInProductSetSettings

public com.google.api.gax.rpc.PagedCallSettings<ListProductsInProductSetRequest,ListProductsInProductSetResponse,ProductSearchClient.ListProductsInProductSetPagedResponse> listProductsInProductSetSettings()

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

importProductSetsSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportProductSetsRequest,com.google.longrunning.Operation> importProductSetsSettings()

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

importProductSetsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ImportProductSetsRequest,ImportProductSetsResponse,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 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

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

newBuilder

public static ProductSearchSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static ProductSearchSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static ProductSearchSettings.Builder newBuilder(com.google.api.gax.rpc.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 com.google.api.gax.rpc.ClientSettings<ProductSearchSettings>