ProductSearchSettings (Google Cloud Vision Parent 3.1.3 API)

java.lang.Object
- com.google.api.gax.rpc.ClientSettings<ProductSearchSettings>
- - com.google.cloud.vision.v1p4beta1.ProductSearchSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
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 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.

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)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnaryCallSettings<AddProductToProductSetRequest,Empty>`	`addProductToProductSetSettings()` Returns the object with the settings used for calls to addProductToProductSet.
`static ProductSearchSettings`	`create(ProductSearchStubSettings stub)`
`UnaryCallSettings<CreateProductSetRequest,ProductSet>`	`createProductSetSettings()` Returns the object with the settings used for calls to createProductSet.
`UnaryCallSettings<CreateProductRequest,Product>`	`createProductSettings()` Returns the object with the settings used for calls to createProduct.
`UnaryCallSettings<CreateReferenceImageRequest,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 gRPC ChannelProvider for this service.
`static InstantiatingHttpJsonChannelProvider.Builder`	`defaultHttpJsonTransportProviderBuilder()` Returns a builder for the default REST ChannelProvider for this service.
`static TransportChannelProvider`	`defaultTransportChannelProvider()`
`UnaryCallSettings<DeleteProductSetRequest,Empty>`	`deleteProductSetSettings()` Returns the object with the settings used for calls to deleteProductSet.
`UnaryCallSettings<DeleteProductRequest,Empty>`	`deleteProductSettings()` Returns the object with the settings used for calls to deleteProduct.
`UnaryCallSettings<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<GetProductSetRequest,ProductSet>`	`getProductSetSettings()` Returns the object with the settings used for calls to getProductSet.
`UnaryCallSettings<GetProductRequest,Product>`	`getProductSettings()` Returns the object with the settings used for calls to getProduct.
`UnaryCallSettings<GetReferenceImageRequest,ReferenceImage>`	`getReferenceImageSettings()` Returns the object with the settings used for calls to getReferenceImage.
`OperationCallSettings<ImportProductSetsRequest,ImportProductSetsResponse,BatchOperationMetadata>`	`importProductSetsOperationSettings()` Returns the object with the settings used for calls to importProductSets.
`UnaryCallSettings<ImportProductSetsRequest,Operation>`	`importProductSetsSettings()` Returns the object with the settings used for calls to importProductSets.
`PagedCallSettings<ListProductSetsRequest,ListProductSetsResponse,ProductSearchClient.ListProductSetsPagedResponse>`	`listProductSetsSettings()` Returns the object with the settings used for calls to listProductSets.
`PagedCallSettings<ListProductsInProductSetRequest,ListProductsInProductSetResponse,ProductSearchClient.ListProductsInProductSetPagedResponse>`	`listProductsInProductSetSettings()` Returns the object with the settings used for calls to listProductsInProductSet.
`PagedCallSettings<ListProductsRequest,ListProductsResponse,ProductSearchClient.ListProductsPagedResponse>`	`listProductsSettings()` Returns the object with the settings used for calls to listProducts.
`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(ClientContext clientContext)` Returns a new builder for this class.
`static ProductSearchSettings.Builder`	`newHttpJsonBuilder()` Returns a new REST builder for this class.
`OperationCallSettings<PurgeProductsRequest,Empty,BatchOperationMetadata>`	`purgeProductsOperationSettings()` Returns the object with the settings used for calls to purgeProducts.
`UnaryCallSettings<PurgeProductsRequest,Operation>`	`purgeProductsSettings()` Returns the object with the settings used for calls to purgeProducts.
`UnaryCallSettings<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<UpdateProductSetRequest,ProductSet>`	`updateProductSetSettings()` Returns the object with the settings used for calls to updateProductSet.
`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, 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 UnaryCallSettings<CreateProductSetRequest,ProductSet> createProductSetSettings()
```
Returns the object with the settings used for calls to createProductSet.

listProductSetsSettings

public PagedCallSettings<ListProductSetsRequest,ListProductSetsResponse,ProductSearchClient.ListProductSetsPagedResponse> listProductSetsSettings()

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

getProductSetSettings
```
public UnaryCallSettings<GetProductSetRequest,ProductSet> getProductSetSettings()
```
Returns the object with the settings used for calls to getProductSet.

updateProductSetSettings
```
public UnaryCallSettings<UpdateProductSetRequest,ProductSet> updateProductSetSettings()
```
Returns the object with the settings used for calls to updateProductSet.

deleteProductSetSettings
```
public UnaryCallSettings<DeleteProductSetRequest,Empty> deleteProductSetSettings()
```
Returns the object with the settings used for calls to deleteProductSet.

createProductSettings
```
public UnaryCallSettings<CreateProductRequest,Product> createProductSettings()
```
Returns the object with the settings used for calls to createProduct.

listProductsSettings

public PagedCallSettings<ListProductsRequest,ListProductsResponse,ProductSearchClient.ListProductsPagedResponse> listProductsSettings()

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

getProductSettings
```
public UnaryCallSettings<GetProductRequest,Product> getProductSettings()
```
Returns the object with the settings used for calls to getProduct.

updateProductSettings
```
public UnaryCallSettings<UpdateProductRequest,Product> updateProductSettings()
```
Returns the object with the settings used for calls to updateProduct.

deleteProductSettings
```
public UnaryCallSettings<DeleteProductRequest,Empty> deleteProductSettings()
```
Returns the object with the settings used for calls to deleteProduct.

createReferenceImageSettings
```
public UnaryCallSettings<CreateReferenceImageRequest,ReferenceImage> createReferenceImageSettings()
```
Returns the object with the settings used for calls to createReferenceImage.

deleteReferenceImageSettings
```
public UnaryCallSettings<DeleteReferenceImageRequest,Empty> deleteReferenceImageSettings()
```
Returns the object with the settings used for calls to deleteReferenceImage.

listReferenceImagesSettings

public PagedCallSettings<ListReferenceImagesRequest,ListReferenceImagesResponse,ProductSearchClient.ListReferenceImagesPagedResponse> listReferenceImagesSettings()

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

getReferenceImageSettings
```
public UnaryCallSettings<GetReferenceImageRequest,ReferenceImage> getReferenceImageSettings()
```
Returns the object with the settings used for calls to getReferenceImage.

addProductToProductSetSettings
```
public UnaryCallSettings<AddProductToProductSetRequest,Empty> addProductToProductSetSettings()
```
Returns the object with the settings used for calls to addProductToProductSet.

removeProductFromProductSetSettings
```
public UnaryCallSettings<RemoveProductFromProductSetRequest,Empty> removeProductFromProductSetSettings()
```
Returns the object with the settings used for calls to removeProductFromProductSet.

listProductsInProductSetSettings

public PagedCallSettings<ListProductsInProductSetRequest,ListProductsInProductSetResponse,ProductSearchClient.ListProductsInProductSetPagedResponse> listProductsInProductSetSettings()

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

importProductSetsSettings
```
public UnaryCallSettings<ImportProductSetsRequest,Operation> importProductSetsSettings()
```
Returns the object with the settings used for calls to importProductSets.

importProductSetsOperationSettings

public OperationCallSettings<ImportProductSetsRequest,ImportProductSetsResponse,BatchOperationMetadata> importProductSetsOperationSettings()

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

purgeProductsSettings
```
public UnaryCallSettings<PurgeProductsRequest,Operation> purgeProductsSettings()
```
Returns the object with the settings used for calls to purgeProducts.

purgeProductsOperationSettings

public OperationCallSettings<PurgeProductsRequest,Empty,BatchOperationMetadata> purgeProductsOperationSettings()

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

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 gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 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(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>

Class ProductSearchSettings

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

ProductSearchSettings

Method Detail

createProductSetSettings

listProductSetsSettings

getProductSetSettings

updateProductSetSettings

deleteProductSetSettings

createProductSettings

listProductsSettings

getProductSettings

updateProductSettings

deleteProductSettings

createReferenceImageSettings

deleteReferenceImageSettings

listReferenceImagesSettings

getReferenceImageSettings

addProductToProductSetSettings

removeProductFromProductSetSettings

listProductsInProductSetSettings

importProductSetsSettings

importProductSetsOperationSettings

purgeProductsSettings

purgeProductsOperationSettings

create

defaultExecutorProviderBuilder

getDefaultEndpoint

getDefaultServiceScopes

defaultCredentialsProviderBuilder

defaultGrpcTransportProviderBuilder

defaultHttpJsonTransportProviderBuilder

defaultTransportChannelProvider

defaultApiClientHeaderProviderBuilder

newBuilder

newHttpJsonBuilder

newBuilder

toBuilder