Class DatasetServiceStubSettings (3.56.0)

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 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 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();

Inheritance

java.lang.Object > StubSettings > DatasetServiceStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

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

Returns a new builder for this class.

Returns
Type	Description
`DatasetServiceStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static DatasetServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`DatasetServiceStubSettings.Builder`

Constructors

DatasetServiceStubSettings(DatasetServiceStubSettings.Builder settingsBuilder)

protected DatasetServiceStubSettings(DatasetServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`DatasetServiceStubSettings.Builder`

Methods

createDatasetOperationSettings()

public OperationCallSettings<CreateDatasetRequest,Dataset,CreateDatasetOperationMetadata> createDatasetOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateDatasetRequest,Dataset,CreateDatasetOperationMetadata>`

createDatasetSettings()

public UnaryCallSettings<CreateDatasetRequest,Operation> createDatasetSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateDatasetRequest,Operation>`

createDatasetVersionOperationSettings()

public OperationCallSettings<CreateDatasetVersionRequest,DatasetVersion,CreateDatasetVersionOperationMetadata> createDatasetVersionOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateDatasetVersionRequest,DatasetVersion,CreateDatasetVersionOperationMetadata>`

createDatasetVersionSettings()

public UnaryCallSettings<CreateDatasetVersionRequest,Operation> createDatasetVersionSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateDatasetVersionRequest,Operation>`

createStub()

public DatasetServiceStub createStub()

Returns
Type	Description
`DatasetServiceStub`

Exceptions
Type	Description
`IOException`

deleteDatasetOperationSettings()

public OperationCallSettings<DeleteDatasetRequest,Empty,DeleteOperationMetadata> deleteDatasetOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteDatasetRequest,Empty,DeleteOperationMetadata>`

deleteDatasetSettings()

public UnaryCallSettings<DeleteDatasetRequest,Operation> deleteDatasetSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteDatasetRequest,Operation>`

deleteDatasetVersionOperationSettings()

public OperationCallSettings<DeleteDatasetVersionRequest,Empty,DeleteOperationMetadata> deleteDatasetVersionOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteDatasetVersionRequest,Empty,DeleteOperationMetadata>`

deleteDatasetVersionSettings()

public UnaryCallSettings<DeleteDatasetVersionRequest,Operation> deleteDatasetVersionSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteDatasetVersionRequest,Operation>`

deleteSavedQueryOperationSettings()

public OperationCallSettings<DeleteSavedQueryRequest,Empty,DeleteOperationMetadata> deleteSavedQueryOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteSavedQueryRequest,Empty,DeleteOperationMetadata>`

deleteSavedQuerySettings()

public UnaryCallSettings<DeleteSavedQueryRequest,Operation> deleteSavedQuerySettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteSavedQueryRequest,Operation>`

exportDataOperationSettings()

public OperationCallSettings<ExportDataRequest,ExportDataResponse,ExportDataOperationMetadata> exportDataOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ExportDataRequest,ExportDataResponse,ExportDataOperationMetadata>`

exportDataSettings()

public UnaryCallSettings<ExportDataRequest,Operation> exportDataSettings()

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

Returns
Type	Description
`UnaryCallSettings<ExportDataRequest,Operation>`

getAnnotationSpecSettings()

public UnaryCallSettings<GetAnnotationSpecRequest,AnnotationSpec> getAnnotationSpecSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetAnnotationSpecRequest,AnnotationSpec>`

getDatasetSettings()

public UnaryCallSettings<GetDatasetRequest,Dataset> getDatasetSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDatasetRequest,Dataset>`

getDatasetVersionSettings()

public UnaryCallSettings<GetDatasetVersionRequest,DatasetVersion> getDatasetVersionSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDatasetVersionRequest,DatasetVersion>`

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

importDataOperationSettings()

public OperationCallSettings<ImportDataRequest,ImportDataResponse,ImportDataOperationMetadata> importDataOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ImportDataRequest,ImportDataResponse,ImportDataOperationMetadata>`

importDataSettings()

public UnaryCallSettings<ImportDataRequest,Operation> importDataSettings()

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

Returns
Type	Description
`UnaryCallSettings<ImportDataRequest,Operation>`

listAnnotationsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListAnnotationsRequest,ListAnnotationsResponse,ListAnnotationsPagedResponse>`

listDataItemsSettings()

public PagedCallSettings<ListDataItemsRequest,ListDataItemsResponse,DatasetServiceClient.ListDataItemsPagedResponse> listDataItemsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDataItemsRequest,ListDataItemsResponse,ListDataItemsPagedResponse>`

listDatasetVersionsSettings()

public PagedCallSettings<ListDatasetVersionsRequest,ListDatasetVersionsResponse,DatasetServiceClient.ListDatasetVersionsPagedResponse> listDatasetVersionsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDatasetVersionsRequest,ListDatasetVersionsResponse,ListDatasetVersionsPagedResponse>`

listDatasetsSettings()

public PagedCallSettings<ListDatasetsRequest,ListDatasetsResponse,DatasetServiceClient.ListDatasetsPagedResponse> listDatasetsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDatasetsRequest,ListDatasetsResponse,ListDatasetsPagedResponse>`

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,DatasetServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
`PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>`

listSavedQueriesSettings()

public PagedCallSettings<ListSavedQueriesRequest,ListSavedQueriesResponse,DatasetServiceClient.ListSavedQueriesPagedResponse> listSavedQueriesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListSavedQueriesRequest,ListSavedQueriesResponse,ListSavedQueriesPagedResponse>`

restoreDatasetVersionOperationSettings()

public OperationCallSettings<RestoreDatasetVersionRequest,DatasetVersion,RestoreDatasetVersionOperationMetadata> restoreDatasetVersionOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<RestoreDatasetVersionRequest,DatasetVersion,RestoreDatasetVersionOperationMetadata>`

restoreDatasetVersionSettings()

public UnaryCallSettings<RestoreDatasetVersionRequest,Operation> restoreDatasetVersionSettings()

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

Returns
Type	Description
`UnaryCallSettings<RestoreDatasetVersionRequest,Operation>`

searchDataItemsSettings()

public PagedCallSettings<SearchDataItemsRequest,SearchDataItemsResponse,DatasetServiceClient.SearchDataItemsPagedResponse> searchDataItemsSettings()

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

Returns
Type	Description
`PagedCallSettings<SearchDataItemsRequest,SearchDataItemsResponse,SearchDataItemsPagedResponse>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

toBuilder()

public DatasetServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
`DatasetServiceStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateDatasetSettings()

public UnaryCallSettings<UpdateDatasetRequest,Dataset> updateDatasetSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDatasetRequest,Dataset>`

updateDatasetVersionSettings()

public UnaryCallSettings<UpdateDatasetVersionRequest,DatasetVersion> updateDatasetVersionSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDatasetVersionRequest,DatasetVersion>`