Class DatasetServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<DatasetServiceStubSettings>
com.google.cloud.aiplatform.v1.stub.DatasetServiceStubSettings
@Generated("by gapic-generator-java")
public class DatasetServiceStubSettings
extends StubSettings<DatasetServiceStubSettings>
Settings class to configure an instance of
DatasetServiceStub.
The default instance has everything set to sensible defaults:
- The default service address (aiplatform.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getDataset:
// 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
DatasetServiceStubSettings.Builder datasetServiceSettingsBuilder =
DatasetServiceStubSettings.newBuilder();
datasetServiceSettingsBuilder
.getDatasetSettings()
.setRetrySettings(
datasetServiceSettingsBuilder
.getDatasetSettings()
.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());
DatasetServiceStubSettings datasetServiceSettings = datasetServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createDataset:
// 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
DatasetServiceStubSettings.Builder datasetServiceSettingsBuilder =
DatasetServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
datasetServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DatasetServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDatasetServiceStubSettings(DatasetServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createDataset.Returns the object with the settings used for calls to createDataset.OperationCallSettings<CreateDatasetVersionRequest,DatasetVersion, CreateDatasetVersionOperationMetadata> Returns the object with the settings used for calls to createDatasetVersion.Returns the object with the settings used for calls to createDatasetVersion.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteDatasetRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteDataset.Returns the object with the settings used for calls to deleteDataset.OperationCallSettings<DeleteDatasetVersionRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteDatasetVersion.Returns the object with the settings used for calls to deleteDatasetVersion.OperationCallSettings<DeleteSavedQueryRequest,com.google.protobuf.Empty, DeleteOperationMetadata> Returns the object with the settings used for calls to deleteSavedQuery.Returns the object with the settings used for calls to deleteSavedQuery.Returns the object with the settings used for calls to exportData.Returns the object with the settings used for calls to exportData.Returns the object with the settings used for calls to getAnnotationSpec.Returns the object with the settings used for calls to getDataset.Returns the object with the settings used for calls to getDatasetVersion.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the default service name.Returns the object with the settings used for calls to importData.Returns the object with the settings used for calls to importData.PagedCallSettings<ListAnnotationsRequest,ListAnnotationsResponse, DatasetServiceClient.ListAnnotationsPagedResponse> Returns the object with the settings used for calls to listAnnotations.PagedCallSettings<ListDataItemsRequest,ListDataItemsResponse, DatasetServiceClient.ListDataItemsPagedResponse> Returns the object with the settings used for calls to listDataItems.PagedCallSettings<ListDatasetsRequest,ListDatasetsResponse, DatasetServiceClient.ListDatasetsPagedResponse> Returns the object with the settings used for calls to listDatasets.PagedCallSettings<ListDatasetVersionsRequest,ListDatasetVersionsResponse, DatasetServiceClient.ListDatasetVersionsPagedResponse> Returns the object with the settings used for calls to listDatasetVersions.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, DatasetServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListSavedQueriesRequest,ListSavedQueriesResponse, DatasetServiceClient.ListSavedQueriesPagedResponse> Returns the object with the settings used for calls to listSavedQueries.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.OperationCallSettings<RestoreDatasetVersionRequest,DatasetVersion, RestoreDatasetVersionOperationMetadata> Returns the object with the settings used for calls to restoreDatasetVersion.Returns the object with the settings used for calls to restoreDatasetVersion.PagedCallSettings<SearchDataItemsRequest,SearchDataItemsResponse, DatasetServiceClient.SearchDataItemsPagedResponse> Returns the object with the settings used for calls to searchDataItems.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateDataset.Returns the object with the settings used for calls to updateDatasetVersion.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
DatasetServiceStubSettings
protected DatasetServiceStubSettings(DatasetServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createDatasetSettings
Returns the object with the settings used for calls to createDataset. -
createDatasetOperationSettings
public OperationCallSettings<CreateDatasetRequest,Dataset, createDatasetOperationSettings()CreateDatasetOperationMetadata> Returns the object with the settings used for calls to createDataset. -
getDatasetSettings
Returns the object with the settings used for calls to getDataset. -
updateDatasetSettings
Returns the object with the settings used for calls to updateDataset. -
listDatasetsSettings
public PagedCallSettings<ListDatasetsRequest,ListDatasetsResponse, listDatasetsSettings()DatasetServiceClient.ListDatasetsPagedResponse> Returns the object with the settings used for calls to listDatasets. -
deleteDatasetSettings
Returns the object with the settings used for calls to deleteDataset. -
deleteDatasetOperationSettings
public OperationCallSettings<DeleteDatasetRequest,com.google.protobuf.Empty, deleteDatasetOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteDataset. -
importDataSettings
Returns the object with the settings used for calls to importData. -
importDataOperationSettings
public OperationCallSettings<ImportDataRequest,ImportDataResponse, importDataOperationSettings()ImportDataOperationMetadata> Returns the object with the settings used for calls to importData. -
exportDataSettings
Returns the object with the settings used for calls to exportData. -
exportDataOperationSettings
public OperationCallSettings<ExportDataRequest,ExportDataResponse, exportDataOperationSettings()ExportDataOperationMetadata> Returns the object with the settings used for calls to exportData. -
createDatasetVersionSettings
Returns the object with the settings used for calls to createDatasetVersion. -
createDatasetVersionOperationSettings
public OperationCallSettings<CreateDatasetVersionRequest,DatasetVersion, createDatasetVersionOperationSettings()CreateDatasetVersionOperationMetadata> Returns the object with the settings used for calls to createDatasetVersion. -
updateDatasetVersionSettings
Returns the object with the settings used for calls to updateDatasetVersion. -
deleteDatasetVersionSettings
Returns the object with the settings used for calls to deleteDatasetVersion. -
deleteDatasetVersionOperationSettings
public OperationCallSettings<DeleteDatasetVersionRequest,com.google.protobuf.Empty, deleteDatasetVersionOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteDatasetVersion. -
getDatasetVersionSettings
Returns the object with the settings used for calls to getDatasetVersion. -
listDatasetVersionsSettings
public PagedCallSettings<ListDatasetVersionsRequest,ListDatasetVersionsResponse, listDatasetVersionsSettings()DatasetServiceClient.ListDatasetVersionsPagedResponse> Returns the object with the settings used for calls to listDatasetVersions. -
restoreDatasetVersionSettings
Returns the object with the settings used for calls to restoreDatasetVersion. -
restoreDatasetVersionOperationSettings
public OperationCallSettings<RestoreDatasetVersionRequest,DatasetVersion, restoreDatasetVersionOperationSettings()RestoreDatasetVersionOperationMetadata> Returns the object with the settings used for calls to restoreDatasetVersion. -
listDataItemsSettings
public PagedCallSettings<ListDataItemsRequest,ListDataItemsResponse, listDataItemsSettings()DatasetServiceClient.ListDataItemsPagedResponse> Returns the object with the settings used for calls to listDataItems. -
searchDataItemsSettings
public PagedCallSettings<SearchDataItemsRequest,SearchDataItemsResponse, searchDataItemsSettings()DatasetServiceClient.SearchDataItemsPagedResponse> Returns the object with the settings used for calls to searchDataItems. -
listSavedQueriesSettings
public PagedCallSettings<ListSavedQueriesRequest,ListSavedQueriesResponse, listSavedQueriesSettings()DatasetServiceClient.ListSavedQueriesPagedResponse> Returns the object with the settings used for calls to listSavedQueries. -
deleteSavedQuerySettings
Returns the object with the settings used for calls to deleteSavedQuery. -
deleteSavedQueryOperationSettings
public OperationCallSettings<DeleteSavedQueryRequest,com.google.protobuf.Empty, deleteSavedQueryOperationSettings()DeleteOperationMetadata> Returns the object with the settings used for calls to deleteSavedQuery. -
getAnnotationSpecSettings
Returns the object with the settings used for calls to getAnnotationSpec. -
listAnnotationsSettings
public PagedCallSettings<ListAnnotationsRequest,ListAnnotationsResponse, listAnnotationsSettings()DatasetServiceClient.ListAnnotationsPagedResponse> Returns the object with the settings used for calls to listAnnotations. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()DatasetServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<DatasetServiceStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<DatasetServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<DatasetServiceStubSettings>
-