Class ProductSearchStubSettings (3.7.0)

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

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ProductSearchStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static ProductSearchStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

newHttpJsonBuilder()

public static ProductSearchStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Constructors

ProductSearchStubSettings(ProductSearchStubSettings.Builder settingsBuilder)

protected ProductSearchStubSettings(ProductSearchStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderProductSearchStubSettings.Builder

Methods

addProductToProductSetSettings()

public UnaryCallSettings<AddProductToProductSetRequest,Empty> addProductToProductSetSettings()

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

Returns

createProductSetSettings()

public UnaryCallSettings<CreateProductSetRequest,ProductSet> createProductSetSettings()

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

Returns

createProductSettings()

public UnaryCallSettings<CreateProductRequest,Product> createProductSettings()

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

Returns

createReferenceImageSettings()

public UnaryCallSettings<CreateReferenceImageRequest,ReferenceImage> createReferenceImageSettings()

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

Returns

createStub()

public ProductSearchStub createStub()
Returns
TypeDescription
ProductSearchStub
Exceptions
TypeDescription
IOException

deleteProductSetSettings()

public UnaryCallSettings<DeleteProductSetRequest,Empty> deleteProductSetSettings()

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

Returns

deleteProductSettings()

public UnaryCallSettings<DeleteProductRequest,Empty> deleteProductSettings()

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

Returns

deleteReferenceImageSettings()

public UnaryCallSettings<DeleteReferenceImageRequest,Empty> deleteReferenceImageSettings()

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

Returns

getProductSetSettings()

public UnaryCallSettings<GetProductSetRequest,ProductSet> getProductSetSettings()

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

Returns

getProductSettings()

public UnaryCallSettings<GetProductRequest,Product> getProductSettings()

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

Returns

getReferenceImageSettings()

public UnaryCallSettings<GetReferenceImageRequest,ReferenceImage> getReferenceImageSettings()

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

Returns

importProductSetsOperationSettings()

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

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

Returns

importProductSetsSettings()

public UnaryCallSettings<ImportProductSetsRequest,Operation> importProductSetsSettings()

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

Returns

listProductSetsSettings()

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

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

Returns

listProductsInProductSetSettings()

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

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

Returns

listProductsSettings()

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

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

Returns

listReferenceImagesSettings()

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

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

Returns

purgeProductsOperationSettings()

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

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

Returns

purgeProductsSettings()

public UnaryCallSettings<PurgeProductsRequest,Operation> purgeProductsSettings()

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

Returns

removeProductFromProductSetSettings()

public UnaryCallSettings<RemoveProductFromProductSetRequest,Empty> removeProductFromProductSetSettings()

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

Returns

toBuilder()

public ProductSearchStubSettings.Builder toBuilder()

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

Returns Overrides

updateProductSetSettings()

public UnaryCallSettings<UpdateProductSetRequest,ProductSet> updateProductSetSettings()

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

Returns

updateProductSettings()

public UnaryCallSettings<UpdateProductRequest,Product> updateProductSettings()

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

Returns