Class DataLabelingServiceStubSettings (0.172.0) 

public class DataLabelingServiceStubSettings extends StubSettings<DataLabelingServiceStubSettings>

Settings class to configure an instance of DataLabelingServiceStub.

The default instance has everything set to sensible defaults:

  • The default service address (datalabeling.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 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
 DataLabelingServiceStubSettings.Builder dataLabelingServiceSettingsBuilder =
     DataLabelingServiceStubSettings.newBuilder();
 dataLabelingServiceSettingsBuilder
     .createDatasetSettings()
     .setRetrySettings(
         dataLabelingServiceSettingsBuilder
             .createDatasetSettings()
             .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());
 DataLabelingServiceStubSettings dataLabelingServiceSettings =
     dataLabelingServiceSettingsBuilder.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 importData:


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

Inheritance

java.lang.Object > StubSettings > DataLabelingServiceStubSettings

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

Returns a new builder for this class.

Returns
Type Description
DataLabelingServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DataLabelingServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DataLabelingServiceStubSettings.Builder

Constructors

DataLabelingServiceStubSettings(DataLabelingServiceStubSettings.Builder settingsBuilder)

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

Methods

createAnnotationSpecSetSettings()

public UnaryCallSettings<CreateAnnotationSpecSetRequest,AnnotationSpecSet> createAnnotationSpecSetSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAnnotationSpecSetRequest,AnnotationSpecSet>

createDatasetSettings()

public UnaryCallSettings<CreateDatasetRequest,Dataset> createDatasetSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDatasetRequest,Dataset>

createEvaluationJobSettings()

public UnaryCallSettings<CreateEvaluationJobRequest,EvaluationJob> createEvaluationJobSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEvaluationJobRequest,EvaluationJob>

createInstructionOperationSettings()

public OperationCallSettings<CreateInstructionRequest,Instruction,CreateInstructionMetadata> createInstructionOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateInstructionRequest,Instruction,CreateInstructionMetadata>

createInstructionSettings()

public UnaryCallSettings<CreateInstructionRequest,Operation> createInstructionSettings()

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

Returns
Type Description
UnaryCallSettings<CreateInstructionRequest,Operation>

createStub()

public DataLabelingServiceStub createStub()
Returns
Type Description
DataLabelingServiceStub
Exceptions
Type Description
IOException

deleteAnnotatedDatasetSettings()

public UnaryCallSettings<DeleteAnnotatedDatasetRequest,Empty> deleteAnnotatedDatasetSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAnnotatedDatasetRequest,Empty>

deleteAnnotationSpecSetSettings()

public UnaryCallSettings<DeleteAnnotationSpecSetRequest,Empty> deleteAnnotationSpecSetSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAnnotationSpecSetRequest,Empty>

deleteDatasetSettings()

public UnaryCallSettings<DeleteDatasetRequest,Empty> deleteDatasetSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDatasetRequest,Empty>

deleteEvaluationJobSettings()

public UnaryCallSettings<DeleteEvaluationJobRequest,Empty> deleteEvaluationJobSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEvaluationJobRequest,Empty>

deleteInstructionSettings()

public UnaryCallSettings<DeleteInstructionRequest,Empty> deleteInstructionSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteInstructionRequest,Empty>

exportDataOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<ExportDataRequest,ExportDataOperationResponse,ExportDataOperationMetadata>

exportDataSettings()

public UnaryCallSettings<ExportDataRequest,Operation> exportDataSettings()

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

Returns
Type Description
UnaryCallSettings<ExportDataRequest,Operation>

getAnnotatedDatasetSettings()

public UnaryCallSettings<GetAnnotatedDatasetRequest,AnnotatedDataset> getAnnotatedDatasetSettings()

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

Returns
Type Description
UnaryCallSettings<GetAnnotatedDatasetRequest,AnnotatedDataset>

getAnnotationSpecSetSettings()

public UnaryCallSettings<GetAnnotationSpecSetRequest,AnnotationSpecSet> getAnnotationSpecSetSettings()

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

Returns
Type Description
UnaryCallSettings<GetAnnotationSpecSetRequest,AnnotationSpecSet>

getDataItemSettings()

public UnaryCallSettings<GetDataItemRequest,DataItem> getDataItemSettings()

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

Returns
Type Description
UnaryCallSettings<GetDataItemRequest,DataItem>

getDatasetSettings()

public UnaryCallSettings<GetDatasetRequest,Dataset> getDatasetSettings()

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

Returns
Type Description
UnaryCallSettings<GetDatasetRequest,Dataset>

getEvaluationJobSettings()

public UnaryCallSettings<GetEvaluationJobRequest,EvaluationJob> getEvaluationJobSettings()

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

Returns
Type Description
UnaryCallSettings<GetEvaluationJobRequest,EvaluationJob>

getEvaluationSettings()

public UnaryCallSettings<GetEvaluationRequest,Evaluation> getEvaluationSettings()

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

Returns
Type Description
UnaryCallSettings<GetEvaluationRequest,Evaluation>

getExampleSettings()

public UnaryCallSettings<GetExampleRequest,Example> getExampleSettings()

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

Returns
Type Description
UnaryCallSettings<GetExampleRequest,Example>

getInstructionSettings()

public UnaryCallSettings<GetInstructionRequest,Instruction> getInstructionSettings()

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

Returns
Type Description
UnaryCallSettings<GetInstructionRequest,Instruction>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

importDataOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<ImportDataRequest,ImportDataOperationResponse,ImportDataOperationMetadata>

importDataSettings()

public UnaryCallSettings<ImportDataRequest,Operation> importDataSettings()

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

Returns
Type Description
UnaryCallSettings<ImportDataRequest,Operation>

labelImageOperationSettings()

public OperationCallSettings<LabelImageRequest,AnnotatedDataset,LabelOperationMetadata> labelImageOperationSettings()

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

Returns
Type Description
OperationCallSettings<LabelImageRequest,AnnotatedDataset,LabelOperationMetadata>

labelImageSettings()

public UnaryCallSettings<LabelImageRequest,Operation> labelImageSettings()

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

Returns
Type Description
UnaryCallSettings<LabelImageRequest,Operation>

labelTextOperationSettings()

public OperationCallSettings<LabelTextRequest,AnnotatedDataset,LabelOperationMetadata> labelTextOperationSettings()

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

Returns
Type Description
OperationCallSettings<LabelTextRequest,AnnotatedDataset,LabelOperationMetadata>

labelTextSettings()

public UnaryCallSettings<LabelTextRequest,Operation> labelTextSettings()

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

Returns
Type Description
UnaryCallSettings<LabelTextRequest,Operation>

labelVideoOperationSettings()

public OperationCallSettings<LabelVideoRequest,AnnotatedDataset,LabelOperationMetadata> labelVideoOperationSettings()

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

Returns
Type Description
OperationCallSettings<LabelVideoRequest,AnnotatedDataset,LabelOperationMetadata>

labelVideoSettings()

public UnaryCallSettings<LabelVideoRequest,Operation> labelVideoSettings()

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

Returns
Type Description
UnaryCallSettings<LabelVideoRequest,Operation>

listAnnotatedDatasetsSettings()

public PagedCallSettings<ListAnnotatedDatasetsRequest,ListAnnotatedDatasetsResponse,DataLabelingServiceClient.ListAnnotatedDatasetsPagedResponse> listAnnotatedDatasetsSettings()

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

Returns
Type Description
PagedCallSettings<ListAnnotatedDatasetsRequest,ListAnnotatedDatasetsResponse,ListAnnotatedDatasetsPagedResponse>

listAnnotationSpecSetsSettings()

public PagedCallSettings<ListAnnotationSpecSetsRequest,ListAnnotationSpecSetsResponse,DataLabelingServiceClient.ListAnnotationSpecSetsPagedResponse> listAnnotationSpecSetsSettings()

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

Returns
Type Description
PagedCallSettings<ListAnnotationSpecSetsRequest,ListAnnotationSpecSetsResponse,ListAnnotationSpecSetsPagedResponse>

listDataItemsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListDataItemsRequest,ListDataItemsResponse,ListDataItemsPagedResponse>

listDatasetsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListDatasetsRequest,ListDatasetsResponse,ListDatasetsPagedResponse>

listEvaluationJobsSettings()

public PagedCallSettings<ListEvaluationJobsRequest,ListEvaluationJobsResponse,DataLabelingServiceClient.ListEvaluationJobsPagedResponse> listEvaluationJobsSettings()

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

Returns
Type Description
PagedCallSettings<ListEvaluationJobsRequest,ListEvaluationJobsResponse,ListEvaluationJobsPagedResponse>

listExamplesSettings()

public PagedCallSettings<ListExamplesRequest,ListExamplesResponse,DataLabelingServiceClient.ListExamplesPagedResponse> listExamplesSettings()

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

Returns
Type Description
PagedCallSettings<ListExamplesRequest,ListExamplesResponse,ListExamplesPagedResponse>

listInstructionsSettings()

public PagedCallSettings<ListInstructionsRequest,ListInstructionsResponse,DataLabelingServiceClient.ListInstructionsPagedResponse> listInstructionsSettings()

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

Returns
Type Description
PagedCallSettings<ListInstructionsRequest,ListInstructionsResponse,ListInstructionsPagedResponse>

pauseEvaluationJobSettings()

public UnaryCallSettings<PauseEvaluationJobRequest,Empty> pauseEvaluationJobSettings()

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

Returns
Type Description
UnaryCallSettings<PauseEvaluationJobRequest,Empty>

resumeEvaluationJobSettings()

public UnaryCallSettings<ResumeEvaluationJobRequest,Empty> resumeEvaluationJobSettings()

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

Returns
Type Description
UnaryCallSettings<ResumeEvaluationJobRequest,Empty>

searchEvaluationsSettings()

public PagedCallSettings<SearchEvaluationsRequest,SearchEvaluationsResponse,DataLabelingServiceClient.SearchEvaluationsPagedResponse> searchEvaluationsSettings()

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

Returns
Type Description
PagedCallSettings<SearchEvaluationsRequest,SearchEvaluationsResponse,SearchEvaluationsPagedResponse>

searchExampleComparisonsSettings()

public PagedCallSettings<SearchExampleComparisonsRequest,SearchExampleComparisonsResponse,DataLabelingServiceClient.SearchExampleComparisonsPagedResponse> searchExampleComparisonsSettings()

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

Returns
Type Description
PagedCallSettings<SearchExampleComparisonsRequest,SearchExampleComparisonsResponse,SearchExampleComparisonsPagedResponse>

toBuilder()

public DataLabelingServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
DataLabelingServiceStubSettings.Builder
Overrides

updateEvaluationJobSettings()

public UnaryCallSettings<UpdateEvaluationJobRequest,EvaluationJob> updateEvaluationJobSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEvaluationJobRequest,EvaluationJob>