Class ProductSearchSettings (3.51.0)

Version latest

• 3.51.0 (latest)
• 3.50.0
• 3.49.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.3
• 2.1.4
• 2.0.29

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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 RetrySettings of createProductSet:

 // 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()
             .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());
 ProductSearchSettings productSearchSettings = productSearchSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide 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 importProductSets:

 // 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();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 productSearchSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > ProductSearchSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ProductSearchStubSettings stub)

public static final ProductSearchSettings create(ProductSearchStubSettings stub)

Parameter
Name	Description
stub	ProductSearchStubSettings

Returns
Type	Description
ProductSearchSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static ProductSearchSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
ProductSearchSettings.Builder

newBuilder(ClientContext clientContext)

public static ProductSearchSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
ProductSearchSettings.Builder

newHttpJsonBuilder()

public static ProductSearchSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
ProductSearchSettings.Builder

Constructors

ProductSearchSettings(ProductSearchSettings.Builder settingsBuilder)

protected ProductSearchSettings(ProductSearchSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	ProductSearchSettings.Builder

Methods

addProductToProductSetSettings()

public UnaryCallSettings<AddProductToProductSetRequest,Empty> addProductToProductSetSettings()

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

Returns
Type	Description
UnaryCallSettings<AddProductToProductSetRequest,Empty>

createProductSetSettings()

public UnaryCallSettings<CreateProductSetRequest,ProductSet> createProductSetSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateProductSetRequest,ProductSet>

createProductSettings()

public UnaryCallSettings<CreateProductRequest,Product> createProductSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateProductRequest,Product>

createReferenceImageSettings()

public UnaryCallSettings<CreateReferenceImageRequest,ReferenceImage> createReferenceImageSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateReferenceImageRequest,ReferenceImage>

deleteProductSetSettings()

public UnaryCallSettings<DeleteProductSetRequest,Empty> deleteProductSetSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteProductSetRequest,Empty>

deleteProductSettings()

public UnaryCallSettings<DeleteProductRequest,Empty> deleteProductSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteProductRequest,Empty>

deleteReferenceImageSettings()

public UnaryCallSettings<DeleteReferenceImageRequest,Empty> deleteReferenceImageSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteReferenceImageRequest,Empty>

getProductSetSettings()

public UnaryCallSettings<GetProductSetRequest,ProductSet> getProductSetSettings()

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

Returns
Type	Description
UnaryCallSettings<GetProductSetRequest,ProductSet>

getProductSettings()

public UnaryCallSettings<GetProductRequest,Product> getProductSettings()

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

Returns
Type	Description
UnaryCallSettings<GetProductRequest,Product>

getReferenceImageSettings()

public UnaryCallSettings<GetReferenceImageRequest,ReferenceImage> getReferenceImageSettings()

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

Returns
Type	Description
UnaryCallSettings<GetReferenceImageRequest,ReferenceImage>

importProductSetsOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<ImportProductSetsRequest,ImportProductSetsResponse,BatchOperationMetadata>

importProductSetsSettings()

public UnaryCallSettings<ImportProductSetsRequest,Operation> importProductSetsSettings()

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

Returns
Type	Description
UnaryCallSettings<ImportProductSetsRequest,Operation>

listProductSetsSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListProductSetsRequest,ListProductSetsResponse,ListProductSetsPagedResponse>

listProductsInProductSetSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListProductsInProductSetRequest,ListProductsInProductSetResponse,ListProductsInProductSetPagedResponse>

listProductsSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListProductsRequest,ListProductsResponse,ListProductsPagedResponse>

listReferenceImagesSettings()

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

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

Returns
Type	Description
PagedCallSettings<ListReferenceImagesRequest,ListReferenceImagesResponse,ListReferenceImagesPagedResponse>

purgeProductsOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<PurgeProductsRequest,Empty,BatchOperationMetadata>

purgeProductsSettings()

public UnaryCallSettings<PurgeProductsRequest,Operation> purgeProductsSettings()

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

Returns
Type	Description
UnaryCallSettings<PurgeProductsRequest,Operation>

removeProductFromProductSetSettings()

public UnaryCallSettings<RemoveProductFromProductSetRequest,Empty> removeProductFromProductSetSettings()

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

Returns
Type	Description
UnaryCallSettings<RemoveProductFromProductSetRequest,Empty>

toBuilder()

public ProductSearchSettings.Builder toBuilder()

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

Returns
Type	Description
ProductSearchSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateProductSetSettings()

public UnaryCallSettings<UpdateProductSetRequest,ProductSet> updateProductSetSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateProductSetRequest,ProductSet>

updateProductSettings()

public UnaryCallSettings<UpdateProductRequest,Product> updateProductSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateProductRequest,Product>