Class DataLabelingServiceSettings (0.148.0)

public class DataLabelingServiceSettings extends ClientSettings<DataLabelingServiceSettings>

Settings class to configure an instance of DataLabelingServiceClient.

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 total timeout of createDataset 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
 DataLabelingServiceSettings.Builder dataLabelingServiceSettingsBuilder =
     DataLabelingServiceSettings.newBuilder();
 dataLabelingServiceSettingsBuilder
     .createDatasetSettings()
     .setRetrySettings(
         dataLabelingServiceSettingsBuilder
             .createDatasetSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataLabelingServiceSettings dataLabelingServiceSettings =
     dataLabelingServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > DataLabelingServiceSettings

Static Methods

create(DataLabelingServiceStubSettings stub)

public static final DataLabelingServiceSettings create(DataLabelingServiceStubSettings stub)
Parameter
NameDescription
stubDataLabelingServiceStubSettings
Returns
TypeDescription
DataLabelingServiceSettings
Exceptions
TypeDescription
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DataLabelingServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
DataLabelingServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DataLabelingServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DataLabelingServiceSettings.Builder

Constructors

DataLabelingServiceSettings(DataLabelingServiceSettings.Builder settingsBuilder)

protected DataLabelingServiceSettings(DataLabelingServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDataLabelingServiceSettings.Builder

Methods

createAnnotationSpecSetSettings()

public UnaryCallSettings<CreateAnnotationSpecSetRequest,AnnotationSpecSet> createAnnotationSpecSetSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAnnotationSpecSetRequest,AnnotationSpecSet>

createDatasetSettings()

public UnaryCallSettings<CreateDatasetRequest,Dataset> createDatasetSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDatasetRequest,Dataset>

createEvaluationJobSettings()

public UnaryCallSettings<CreateEvaluationJobRequest,EvaluationJob> createEvaluationJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEvaluationJobRequest,EvaluationJob>

createInstructionOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateInstructionRequest,Instruction,CreateInstructionMetadata>

createInstructionSettings()

public UnaryCallSettings<CreateInstructionRequest,Operation> createInstructionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInstructionRequest,Operation>

deleteAnnotatedDatasetSettings()

public UnaryCallSettings<DeleteAnnotatedDatasetRequest,Empty> deleteAnnotatedDatasetSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAnnotatedDatasetRequest,Empty>

deleteAnnotationSpecSetSettings()

public UnaryCallSettings<DeleteAnnotationSpecSetRequest,Empty> deleteAnnotationSpecSetSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAnnotationSpecSetRequest,Empty>

deleteDatasetSettings()

public UnaryCallSettings<DeleteDatasetRequest,Empty> deleteDatasetSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteDatasetRequest,Empty>

deleteEvaluationJobSettings()

public UnaryCallSettings<DeleteEvaluationJobRequest,Empty> deleteEvaluationJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEvaluationJobRequest,Empty>

deleteInstructionSettings()

public UnaryCallSettings<DeleteInstructionRequest,Empty> deleteInstructionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInstructionRequest,Empty>

exportDataOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ExportDataRequest,ExportDataOperationResponse,ExportDataOperationMetadata>

exportDataSettings()

public UnaryCallSettings<ExportDataRequest,Operation> exportDataSettings()

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

Returns
TypeDescription
UnaryCallSettings<ExportDataRequest,Operation>

getAnnotatedDatasetSettings()

public UnaryCallSettings<GetAnnotatedDatasetRequest,AnnotatedDataset> getAnnotatedDatasetSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAnnotatedDatasetRequest,AnnotatedDataset>

getAnnotationSpecSetSettings()

public UnaryCallSettings<GetAnnotationSpecSetRequest,AnnotationSpecSet> getAnnotationSpecSetSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAnnotationSpecSetRequest,AnnotationSpecSet>

getDataItemSettings()

public UnaryCallSettings<GetDataItemRequest,DataItem> getDataItemSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDataItemRequest,DataItem>

getDatasetSettings()

public UnaryCallSettings<GetDatasetRequest,Dataset> getDatasetSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDatasetRequest,Dataset>

getEvaluationJobSettings()

public UnaryCallSettings<GetEvaluationJobRequest,EvaluationJob> getEvaluationJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEvaluationJobRequest,EvaluationJob>

getEvaluationSettings()

public UnaryCallSettings<GetEvaluationRequest,Evaluation> getEvaluationSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEvaluationRequest,Evaluation>

getExampleSettings()

public UnaryCallSettings<GetExampleRequest,Example> getExampleSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetExampleRequest,Example>

getInstructionSettings()

public UnaryCallSettings<GetInstructionRequest,Instruction> getInstructionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInstructionRequest,Instruction>

importDataOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ImportDataRequest,ImportDataOperationResponse,ImportDataOperationMetadata>

importDataSettings()

public UnaryCallSettings<ImportDataRequest,Operation> importDataSettings()

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

Returns
TypeDescription
UnaryCallSettings<ImportDataRequest,Operation>

labelImageOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<LabelImageRequest,AnnotatedDataset,LabelOperationMetadata>

labelImageSettings()

public UnaryCallSettings<LabelImageRequest,Operation> labelImageSettings()

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

Returns
TypeDescription
UnaryCallSettings<LabelImageRequest,Operation>

labelTextOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<LabelTextRequest,AnnotatedDataset,LabelOperationMetadata>

labelTextSettings()

public UnaryCallSettings<LabelTextRequest,Operation> labelTextSettings()

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

Returns
TypeDescription
UnaryCallSettings<LabelTextRequest,Operation>

labelVideoOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<LabelVideoRequest,AnnotatedDataset,LabelOperationMetadata>

labelVideoSettings()

public UnaryCallSettings<LabelVideoRequest,Operation> labelVideoSettings()

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

Returns
TypeDescription
UnaryCallSettings<LabelVideoRequest,Operation>

listAnnotatedDatasetsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAnnotatedDatasetsRequest,ListAnnotatedDatasetsResponse,ListAnnotatedDatasetsPagedResponse>

listAnnotationSpecSetsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAnnotationSpecSetsRequest,ListAnnotationSpecSetsResponse,ListAnnotationSpecSetsPagedResponse>

listDataItemsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListDataItemsRequest,ListDataItemsResponse,ListDataItemsPagedResponse>

listDatasetsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListDatasetsRequest,ListDatasetsResponse,ListDatasetsPagedResponse>

listEvaluationJobsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListEvaluationJobsRequest,ListEvaluationJobsResponse,ListEvaluationJobsPagedResponse>

listExamplesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListExamplesRequest,ListExamplesResponse,ListExamplesPagedResponse>

listInstructionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListInstructionsRequest,ListInstructionsResponse,ListInstructionsPagedResponse>

pauseEvaluationJobSettings()

public UnaryCallSettings<PauseEvaluationJobRequest,Empty> pauseEvaluationJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<PauseEvaluationJobRequest,Empty>

resumeEvaluationJobSettings()

public UnaryCallSettings<ResumeEvaluationJobRequest,Empty> resumeEvaluationJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<ResumeEvaluationJobRequest,Empty>

searchEvaluationsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<SearchEvaluationsRequest,SearchEvaluationsResponse,SearchEvaluationsPagedResponse>

searchExampleComparisonsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<SearchExampleComparisonsRequest,SearchExampleComparisonsResponse,SearchExampleComparisonsPagedResponse>

toBuilder()

public DataLabelingServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
DataLabelingServiceSettings.Builder
Overrides

updateEvaluationJobSettings()

public UnaryCallSettings<UpdateEvaluationJobRequest,EvaluationJob> updateEvaluationJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateEvaluationJobRequest,EvaluationJob>