Class DlpServiceSettings (3.1.4)

public class DlpServiceSettings extends ClientSettings<DlpServiceSettings>

Settings class to configure an instance of DlpServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (dlp.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 inspectContent to 30 seconds:


 DlpServiceSettings.Builder dlpServiceSettingsBuilder = DlpServiceSettings.newBuilder();
 dlpServiceSettingsBuilder
     .inspectContentSettings()
     .setRetrySettings(
         dlpServiceSettingsBuilder
             .inspectContentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DlpServiceSettings dlpServiceSettings = dlpServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > DlpServiceSettings

Static Methods

create(DlpServiceStubSettings stub)

public static final DlpServiceSettings create(DlpServiceStubSettings stub)
Parameter
NameDescription
stubDlpServiceStubSettings
Returns
TypeDescription
DlpServiceSettings
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 DlpServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
DlpServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DlpServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DlpServiceSettings.Builder

Constructors

DlpServiceSettings(DlpServiceSettings.Builder settingsBuilder)

protected DlpServiceSettings(DlpServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDlpServiceSettings.Builder

Methods

activateJobTriggerSettings()

public UnaryCallSettings<ActivateJobTriggerRequest,DlpJob> activateJobTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<ActivateJobTriggerRequest,DlpJob>

cancelDlpJobSettings()

public UnaryCallSettings<CancelDlpJobRequest,Empty> cancelDlpJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelDlpJobRequest,Empty>

createDeidentifyTemplateSettings()

public UnaryCallSettings<CreateDeidentifyTemplateRequest,DeidentifyTemplate> createDeidentifyTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDeidentifyTemplateRequest,DeidentifyTemplate>

createDlpJobSettings()

public UnaryCallSettings<CreateDlpJobRequest,DlpJob> createDlpJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateDlpJobRequest,DlpJob>

createInspectTemplateSettings()

public UnaryCallSettings<CreateInspectTemplateRequest,InspectTemplate> createInspectTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInspectTemplateRequest,InspectTemplate>

createJobTriggerSettings()

public UnaryCallSettings<CreateJobTriggerRequest,JobTrigger> createJobTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateJobTriggerRequest,JobTrigger>

createStoredInfoTypeSettings()

public UnaryCallSettings<CreateStoredInfoTypeRequest,StoredInfoType> createStoredInfoTypeSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateStoredInfoTypeRequest,StoredInfoType>

deidentifyContentSettings()

public UnaryCallSettings<DeidentifyContentRequest,DeidentifyContentResponse> deidentifyContentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeidentifyContentRequest,DeidentifyContentResponse>

deleteDeidentifyTemplateSettings()

public UnaryCallSettings<DeleteDeidentifyTemplateRequest,Empty> deleteDeidentifyTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteDeidentifyTemplateRequest,Empty>

deleteDlpJobSettings()

public UnaryCallSettings<DeleteDlpJobRequest,Empty> deleteDlpJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteDlpJobRequest,Empty>

deleteInspectTemplateSettings()

public UnaryCallSettings<DeleteInspectTemplateRequest,Empty> deleteInspectTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInspectTemplateRequest,Empty>

deleteJobTriggerSettings()

public UnaryCallSettings<DeleteJobTriggerRequest,Empty> deleteJobTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteJobTriggerRequest,Empty>

deleteStoredInfoTypeSettings()

public UnaryCallSettings<DeleteStoredInfoTypeRequest,Empty> deleteStoredInfoTypeSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteStoredInfoTypeRequest,Empty>

finishDlpJobSettings()

public UnaryCallSettings<FinishDlpJobRequest,Empty> finishDlpJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<FinishDlpJobRequest,Empty>

getDeidentifyTemplateSettings()

public UnaryCallSettings<GetDeidentifyTemplateRequest,DeidentifyTemplate> getDeidentifyTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDeidentifyTemplateRequest,DeidentifyTemplate>

getDlpJobSettings()

public UnaryCallSettings<GetDlpJobRequest,DlpJob> getDlpJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetDlpJobRequest,DlpJob>

getInspectTemplateSettings()

public UnaryCallSettings<GetInspectTemplateRequest,InspectTemplate> getInspectTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInspectTemplateRequest,InspectTemplate>

getJobTriggerSettings()

public UnaryCallSettings<GetJobTriggerRequest,JobTrigger> getJobTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetJobTriggerRequest,JobTrigger>

getStoredInfoTypeSettings()

public UnaryCallSettings<GetStoredInfoTypeRequest,StoredInfoType> getStoredInfoTypeSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetStoredInfoTypeRequest,StoredInfoType>

hybridInspectDlpJobSettings()

public UnaryCallSettings<HybridInspectDlpJobRequest,HybridInspectResponse> hybridInspectDlpJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<HybridInspectDlpJobRequest,HybridInspectResponse>

hybridInspectJobTriggerSettings()

public UnaryCallSettings<HybridInspectJobTriggerRequest,HybridInspectResponse> hybridInspectJobTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<HybridInspectJobTriggerRequest,HybridInspectResponse>

inspectContentSettings()

public UnaryCallSettings<InspectContentRequest,InspectContentResponse> inspectContentSettings()

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

Returns
TypeDescription
UnaryCallSettings<InspectContentRequest,InspectContentResponse>

listDeidentifyTemplatesSettings()

public PagedCallSettings<ListDeidentifyTemplatesRequest,ListDeidentifyTemplatesResponse,DlpServiceClient.ListDeidentifyTemplatesPagedResponse> listDeidentifyTemplatesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListDeidentifyTemplatesRequest,ListDeidentifyTemplatesResponse,ListDeidentifyTemplatesPagedResponse>

listDlpJobsSettings()

public PagedCallSettings<ListDlpJobsRequest,ListDlpJobsResponse,DlpServiceClient.ListDlpJobsPagedResponse> listDlpJobsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListDlpJobsRequest,ListDlpJobsResponse,ListDlpJobsPagedResponse>

listInfoTypesSettings()

public UnaryCallSettings<ListInfoTypesRequest,ListInfoTypesResponse> listInfoTypesSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListInfoTypesRequest,ListInfoTypesResponse>

listInspectTemplatesSettings()

public PagedCallSettings<ListInspectTemplatesRequest,ListInspectTemplatesResponse,DlpServiceClient.ListInspectTemplatesPagedResponse> listInspectTemplatesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListInspectTemplatesRequest,ListInspectTemplatesResponse,ListInspectTemplatesPagedResponse>

listJobTriggersSettings()

public PagedCallSettings<ListJobTriggersRequest,ListJobTriggersResponse,DlpServiceClient.ListJobTriggersPagedResponse> listJobTriggersSettings()

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

Returns
TypeDescription
PagedCallSettings<ListJobTriggersRequest,ListJobTriggersResponse,ListJobTriggersPagedResponse>

listStoredInfoTypesSettings()

public PagedCallSettings<ListStoredInfoTypesRequest,ListStoredInfoTypesResponse,DlpServiceClient.ListStoredInfoTypesPagedResponse> listStoredInfoTypesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListStoredInfoTypesRequest,ListStoredInfoTypesResponse,ListStoredInfoTypesPagedResponse>

redactImageSettings()

public UnaryCallSettings<RedactImageRequest,RedactImageResponse> redactImageSettings()

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

Returns
TypeDescription
UnaryCallSettings<RedactImageRequest,RedactImageResponse>

reidentifyContentSettings()

public UnaryCallSettings<ReidentifyContentRequest,ReidentifyContentResponse> reidentifyContentSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReidentifyContentRequest,ReidentifyContentResponse>

toBuilder()

public DlpServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
DlpServiceSettings.Builder
Overrides

updateDeidentifyTemplateSettings()

public UnaryCallSettings<UpdateDeidentifyTemplateRequest,DeidentifyTemplate> updateDeidentifyTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateDeidentifyTemplateRequest,DeidentifyTemplate>

updateInspectTemplateSettings()

public UnaryCallSettings<UpdateInspectTemplateRequest,InspectTemplate> updateInspectTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInspectTemplateRequest,InspectTemplate>

updateJobTriggerSettings()

public UnaryCallSettings<UpdateJobTriggerRequest,JobTrigger> updateJobTriggerSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateJobTriggerRequest,JobTrigger>

updateStoredInfoTypeSettings()

public UnaryCallSettings<UpdateStoredInfoTypeRequest,StoredInfoType> updateStoredInfoTypeSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateStoredInfoTypeRequest,StoredInfoType>