Class WarehouseSettings (0.15.0)

public class WarehouseSettings extends ClientSettings<WarehouseSettings>

Settings class to configure an instance of WarehouseClient.

The default instance has everything set to sensible defaults:

  • The default service address (visionai.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 createAsset:


 // 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
 WarehouseSettings.Builder warehouseSettingsBuilder = WarehouseSettings.newBuilder();
 warehouseSettingsBuilder
     .createAssetSettings()
     .setRetrySettings(
         warehouseSettingsBuilder
             .createAssetSettings()
             .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());
 WarehouseSettings warehouseSettings = warehouseSettingsBuilder.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 deleteAsset:


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

Inheritance

java.lang.Object > ClientSettings > WarehouseSettings

Static Methods

create(WarehouseStubSettings stub)

public static final WarehouseSettings create(WarehouseStubSettings stub)
Parameter
Name Description
stub WarehouseStubSettings
Returns
Type Description
WarehouseSettings
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()

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 WarehouseSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
WarehouseSettings.Builder

newBuilder(ClientContext clientContext)

public static WarehouseSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
WarehouseSettings.Builder

newHttpJsonBuilder()

public static WarehouseSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
WarehouseSettings.Builder

Constructors

WarehouseSettings(WarehouseSettings.Builder settingsBuilder)

protected WarehouseSettings(WarehouseSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder WarehouseSettings.Builder

Methods

addCollectionItemSettings()

public UnaryCallSettings<AddCollectionItemRequest,AddCollectionItemResponse> addCollectionItemSettings()

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

analyzeAssetOperationSettings()

public OperationCallSettings<AnalyzeAssetRequest,AnalyzeAssetResponse,AnalyzeAssetMetadata> analyzeAssetOperationSettings()

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

analyzeAssetSettings()

public UnaryCallSettings<AnalyzeAssetRequest,Operation> analyzeAssetSettings()

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

Returns
Type Description
UnaryCallSettings<AnalyzeAssetRequest,Operation>

analyzeCorpusOperationSettings()

public OperationCallSettings<AnalyzeCorpusRequest,AnalyzeCorpusResponse,AnalyzeCorpusMetadata> analyzeCorpusOperationSettings()

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

analyzeCorpusSettings()

public UnaryCallSettings<AnalyzeCorpusRequest,Operation> analyzeCorpusSettings()

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

clipAssetSettings()

public UnaryCallSettings<ClipAssetRequest,ClipAssetResponse> clipAssetSettings()

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

createAnnotationSettings()

public UnaryCallSettings<CreateAnnotationRequest,Annotation> createAnnotationSettings()

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

createAssetSettings()

public UnaryCallSettings<CreateAssetRequest,Asset> createAssetSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAssetRequest,Asset>

createCollectionOperationSettings()

public OperationCallSettings<CreateCollectionRequest,Collection,CreateCollectionMetadata> createCollectionOperationSettings()

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

createCollectionSettings()

public UnaryCallSettings<CreateCollectionRequest,Operation> createCollectionSettings()

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

createCorpusOperationSettings()

public OperationCallSettings<CreateCorpusRequest,Corpus,CreateCorpusMetadata> createCorpusOperationSettings()

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

createCorpusSettings()

public UnaryCallSettings<CreateCorpusRequest,Operation> createCorpusSettings()

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

Returns
Type Description
UnaryCallSettings<CreateCorpusRequest,Operation>

createDataSchemaSettings()

public UnaryCallSettings<CreateDataSchemaRequest,DataSchema> createDataSchemaSettings()

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

createIndexEndpointOperationSettings()

public OperationCallSettings<CreateIndexEndpointRequest,IndexEndpoint,CreateIndexEndpointMetadata> createIndexEndpointOperationSettings()

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

createIndexEndpointSettings()

public UnaryCallSettings<CreateIndexEndpointRequest,Operation> createIndexEndpointSettings()

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

createIndexOperationSettings()

public OperationCallSettings<CreateIndexRequest,Index,CreateIndexMetadata> createIndexOperationSettings()

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

createIndexSettings()

public UnaryCallSettings<CreateIndexRequest,Operation> createIndexSettings()

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

Returns
Type Description
UnaryCallSettings<CreateIndexRequest,Operation>

createSearchConfigSettings()

public UnaryCallSettings<CreateSearchConfigRequest,SearchConfig> createSearchConfigSettings()

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

createSearchHypernymSettings()

public UnaryCallSettings<CreateSearchHypernymRequest,SearchHypernym> createSearchHypernymSettings()

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

deleteAnnotationSettings()

public UnaryCallSettings<DeleteAnnotationRequest,Empty> deleteAnnotationSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAnnotationRequest,Empty>

deleteAssetOperationSettings()

public OperationCallSettings<DeleteAssetRequest,Empty,DeleteAssetMetadata> deleteAssetOperationSettings()

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

deleteAssetSettings()

public UnaryCallSettings<DeleteAssetRequest,Operation> deleteAssetSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAssetRequest,Operation>

deleteCollectionOperationSettings()

public OperationCallSettings<DeleteCollectionRequest,Empty,DeleteCollectionMetadata> deleteCollectionOperationSettings()

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

deleteCollectionSettings()

public UnaryCallSettings<DeleteCollectionRequest,Operation> deleteCollectionSettings()

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

deleteCorpusSettings()

public UnaryCallSettings<DeleteCorpusRequest,Empty> deleteCorpusSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteCorpusRequest,Empty>

deleteDataSchemaSettings()

public UnaryCallSettings<DeleteDataSchemaRequest,Empty> deleteDataSchemaSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDataSchemaRequest,Empty>

deleteIndexEndpointOperationSettings()

public OperationCallSettings<DeleteIndexEndpointRequest,Empty,DeleteIndexEndpointMetadata> deleteIndexEndpointOperationSettings()

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

deleteIndexEndpointSettings()

public UnaryCallSettings<DeleteIndexEndpointRequest,Operation> deleteIndexEndpointSettings()

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

deleteIndexOperationSettings()

public OperationCallSettings<DeleteIndexRequest,Empty,DeleteIndexMetadata> deleteIndexOperationSettings()

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

deleteIndexSettings()

public UnaryCallSettings<DeleteIndexRequest,Operation> deleteIndexSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteIndexRequest,Operation>

deleteSearchConfigSettings()

public UnaryCallSettings<DeleteSearchConfigRequest,Empty> deleteSearchConfigSettings()

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

deleteSearchHypernymSettings()

public UnaryCallSettings<DeleteSearchHypernymRequest,Empty> deleteSearchHypernymSettings()

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

deployIndexOperationSettings()

public OperationCallSettings<DeployIndexRequest,DeployIndexResponse,DeployIndexMetadata> deployIndexOperationSettings()

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

deployIndexSettings()

public UnaryCallSettings<DeployIndexRequest,Operation> deployIndexSettings()

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

Returns
Type Description
UnaryCallSettings<DeployIndexRequest,Operation>

generateHlsUriSettings()

public UnaryCallSettings<GenerateHlsUriRequest,GenerateHlsUriResponse> generateHlsUriSettings()

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

generateRetrievalUrlSettings()

public UnaryCallSettings<GenerateRetrievalUrlRequest,GenerateRetrievalUrlResponse> generateRetrievalUrlSettings()

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

getAnnotationSettings()

public UnaryCallSettings<GetAnnotationRequest,Annotation> getAnnotationSettings()

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

getAssetSettings()

public UnaryCallSettings<GetAssetRequest,Asset> getAssetSettings()

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

Returns
Type Description
UnaryCallSettings<GetAssetRequest,Asset>

getCollectionSettings()

public UnaryCallSettings<GetCollectionRequest,Collection> getCollectionSettings()

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

getCorpusSettings()

public UnaryCallSettings<GetCorpusRequest,Corpus> getCorpusSettings()

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

Returns
Type Description
UnaryCallSettings<GetCorpusRequest,Corpus>

getDataSchemaSettings()

public UnaryCallSettings<GetDataSchemaRequest,DataSchema> getDataSchemaSettings()

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

getIndexEndpointSettings()

public UnaryCallSettings<GetIndexEndpointRequest,IndexEndpoint> getIndexEndpointSettings()

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

getIndexSettings()

public UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()

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

Returns
Type Description
UnaryCallSettings<GetIndexRequest,Index>

getSearchConfigSettings()

public UnaryCallSettings<GetSearchConfigRequest,SearchConfig> getSearchConfigSettings()

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

getSearchHypernymSettings()

public UnaryCallSettings<GetSearchHypernymRequest,SearchHypernym> getSearchHypernymSettings()

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

importAssetsOperationSettings()

public OperationCallSettings<ImportAssetsRequest,ImportAssetsResponse,ImportAssetsMetadata> importAssetsOperationSettings()

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

importAssetsSettings()

public UnaryCallSettings<ImportAssetsRequest,Operation> importAssetsSettings()

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

Returns
Type Description
UnaryCallSettings<ImportAssetsRequest,Operation>

indexAssetOperationSettings()

public OperationCallSettings<IndexAssetRequest,IndexAssetResponse,IndexAssetMetadata> indexAssetOperationSettings()

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

indexAssetSettings()

public UnaryCallSettings<IndexAssetRequest,Operation> indexAssetSettings()

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

Returns
Type Description
UnaryCallSettings<IndexAssetRequest,Operation>

ingestAssetSettings()

public StreamingCallSettings<IngestAssetRequest,IngestAssetResponse> ingestAssetSettings()

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

listAnnotationsSettings()

public PagedCallSettings<ListAnnotationsRequest,ListAnnotationsResponse,WarehouseClient.ListAnnotationsPagedResponse> listAnnotationsSettings()

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

listAssetsSettings()

public PagedCallSettings<ListAssetsRequest,ListAssetsResponse,WarehouseClient.ListAssetsPagedResponse> listAssetsSettings()

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

listCollectionsSettings()

public PagedCallSettings<ListCollectionsRequest,ListCollectionsResponse,WarehouseClient.ListCollectionsPagedResponse> listCollectionsSettings()

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

listCorporaSettings()

public PagedCallSettings<ListCorporaRequest,ListCorporaResponse,WarehouseClient.ListCorporaPagedResponse> listCorporaSettings()

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

listDataSchemasSettings()

public PagedCallSettings<ListDataSchemasRequest,ListDataSchemasResponse,WarehouseClient.ListDataSchemasPagedResponse> listDataSchemasSettings()

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

listIndexEndpointsSettings()

public PagedCallSettings<ListIndexEndpointsRequest,ListIndexEndpointsResponse,WarehouseClient.ListIndexEndpointsPagedResponse> listIndexEndpointsSettings()

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

listIndexesSettings()

public PagedCallSettings<ListIndexesRequest,ListIndexesResponse,WarehouseClient.ListIndexesPagedResponse> listIndexesSettings()

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

listSearchConfigsSettings()

public PagedCallSettings<ListSearchConfigsRequest,ListSearchConfigsResponse,WarehouseClient.ListSearchConfigsPagedResponse> listSearchConfigsSettings()

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

listSearchHypernymsSettings()

public PagedCallSettings<ListSearchHypernymsRequest,ListSearchHypernymsResponse,WarehouseClient.ListSearchHypernymsPagedResponse> listSearchHypernymsSettings()

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

removeCollectionItemSettings()

public UnaryCallSettings<RemoveCollectionItemRequest,RemoveCollectionItemResponse> removeCollectionItemSettings()

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

removeIndexAssetOperationSettings()

public OperationCallSettings<RemoveIndexAssetRequest,RemoveIndexAssetResponse,RemoveIndexAssetMetadata> removeIndexAssetOperationSettings()

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

removeIndexAssetSettings()

public UnaryCallSettings<RemoveIndexAssetRequest,Operation> removeIndexAssetSettings()

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

searchAssetsSettings()

public PagedCallSettings<SearchAssetsRequest,SearchAssetsResponse,WarehouseClient.SearchAssetsPagedResponse> searchAssetsSettings()

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

searchIndexEndpointSettings()

public PagedCallSettings<SearchIndexEndpointRequest,SearchIndexEndpointResponse,WarehouseClient.SearchIndexEndpointPagedResponse> searchIndexEndpointSettings()

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

toBuilder()

public WarehouseSettings.Builder toBuilder()

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

Returns
Type Description
WarehouseSettings.Builder
Overrides

undeployIndexOperationSettings()

public OperationCallSettings<UndeployIndexRequest,UndeployIndexResponse,UndeployIndexMetadata> undeployIndexOperationSettings()

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

undeployIndexSettings()

public UnaryCallSettings<UndeployIndexRequest,Operation> undeployIndexSettings()

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

updateAnnotationSettings()

public UnaryCallSettings<UpdateAnnotationRequest,Annotation> updateAnnotationSettings()

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

updateAssetSettings()

public UnaryCallSettings<UpdateAssetRequest,Asset> updateAssetSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateAssetRequest,Asset>

updateCollectionSettings()

public UnaryCallSettings<UpdateCollectionRequest,Collection> updateCollectionSettings()

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

updateCorpusSettings()

public UnaryCallSettings<UpdateCorpusRequest,Corpus> updateCorpusSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateCorpusRequest,Corpus>

updateDataSchemaSettings()

public UnaryCallSettings<UpdateDataSchemaRequest,DataSchema> updateDataSchemaSettings()

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

updateIndexEndpointOperationSettings()

public OperationCallSettings<UpdateIndexEndpointRequest,IndexEndpoint,UpdateIndexEndpointMetadata> updateIndexEndpointOperationSettings()

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

updateIndexEndpointSettings()

public UnaryCallSettings<UpdateIndexEndpointRequest,Operation> updateIndexEndpointSettings()

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

updateIndexOperationSettings()

public OperationCallSettings<UpdateIndexRequest,Index,UpdateIndexMetadata> updateIndexOperationSettings()

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

updateIndexSettings()

public UnaryCallSettings<UpdateIndexRequest,Operation> updateIndexSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateIndexRequest,Operation>

updateSearchConfigSettings()

public UnaryCallSettings<UpdateSearchConfigRequest,SearchConfig> updateSearchConfigSettings()

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

updateSearchHypernymSettings()

public UnaryCallSettings<UpdateSearchHypernymRequest,SearchHypernym> updateSearchHypernymSettings()

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

uploadAssetOperationSettings()

public OperationCallSettings<UploadAssetRequest,UploadAssetResponse,UploadAssetMetadata> uploadAssetOperationSettings()

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

uploadAssetSettings()

public UnaryCallSettings<UploadAssetRequest,Operation> uploadAssetSettings()

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

Returns
Type Description
UnaryCallSettings<UploadAssetRequest,Operation>

viewCollectionItemsSettings()

public PagedCallSettings<ViewCollectionItemsRequest,ViewCollectionItemsResponse,WarehouseClient.ViewCollectionItemsPagedResponse> viewCollectionItemsSettings()

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

viewIndexedAssetsSettings()

public PagedCallSettings<ViewIndexedAssetsRequest,ViewIndexedAssetsResponse,WarehouseClient.ViewIndexedAssetsPagedResponse> viewIndexedAssetsSettings()

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