Class ProductSearchStubSettings (2.1.4)

public class ProductSearchStubSettings extends StubSettings<ProductSearchStubSettings>

Settings class to configure an instance of ProductSearchStub.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProductSearchStubSettings.Builder productSearchSettingsBuilder =
     ProductSearchStubSettings.newBuilder();
 productSearchSettingsBuilder
     .createProductSetSettings()
     .setRetrySettings(
         productSearchSettingsBuilder
             .createProductSetSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProductSearchStubSettings productSearchSettings = productSearchSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > ProductSearchStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

StubSettings.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

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 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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 ProductSearchStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
ProductSearchStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ProductSearchStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
ProductSearchStubSettings.Builder

Constructors

ProductSearchStubSettings(ProductSearchStubSettings.Builder settingsBuilder)

protected ProductSearchStubSettings(ProductSearchStubSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`ProductSearchStubSettings.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>

createStub()

public ProductSearchStub createStub()

Returns

Type	Description
ProductSearchStub

Exceptions

Type	Description
IOException

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>

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 ProductSearchStubSettings.Builder toBuilder()

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

Returns

Type	Description
ProductSearchStubSettings.Builder

Overrides

StubSettings<SettingsT>.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>