Class DlpServiceStubSettings (3.58.0)

public class DlpServiceStubSettings extends StubSettings<DlpServiceStubSettings>

Settings class to configure an instance of DlpServiceStub.

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 RetrySettings of inspectContent:


 // 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
 DlpServiceStubSettings.Builder dlpServiceSettingsBuilder = DlpServiceStubSettings.newBuilder();
 dlpServiceSettingsBuilder
     .inspectContentSettings()
     .setRetrySettings(
         dlpServiceSettingsBuilder
             .inspectContentSettings()
             .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());
 DlpServiceStubSettings dlpServiceSettings = dlpServiceSettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > DlpServiceStubSettings

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 DlpServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
DlpServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DlpServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DlpServiceStubSettings.Builder

newHttpJsonBuilder()

public static DlpServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
DlpServiceStubSettings.Builder

Constructors

DlpServiceStubSettings(DlpServiceStubSettings.Builder settingsBuilder)

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

Methods

activateJobTriggerSettings()

public UnaryCallSettings<ActivateJobTriggerRequest,DlpJob> activateJobTriggerSettings()

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

Returns
Type Description
UnaryCallSettings<ActivateJobTriggerRequest,DlpJob>

cancelDlpJobSettings()

public UnaryCallSettings<CancelDlpJobRequest,Empty> cancelDlpJobSettings()

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

Returns
Type Description
UnaryCallSettings<CancelDlpJobRequest,Empty>

createConnectionSettings()

public UnaryCallSettings<CreateConnectionRequest,Connection> createConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<CreateConnectionRequest,Connection>

createDeidentifyTemplateSettings()

public UnaryCallSettings<CreateDeidentifyTemplateRequest,DeidentifyTemplate> createDeidentifyTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDeidentifyTemplateRequest,DeidentifyTemplate>

createDiscoveryConfigSettings()

public UnaryCallSettings<CreateDiscoveryConfigRequest,DiscoveryConfig> createDiscoveryConfigSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDiscoveryConfigRequest,DiscoveryConfig>

createDlpJobSettings()

public UnaryCallSettings<CreateDlpJobRequest,DlpJob> createDlpJobSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDlpJobRequest,DlpJob>

createInspectTemplateSettings()

public UnaryCallSettings<CreateInspectTemplateRequest,InspectTemplate> createInspectTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<CreateInspectTemplateRequest,InspectTemplate>

createJobTriggerSettings()

public UnaryCallSettings<CreateJobTriggerRequest,JobTrigger> createJobTriggerSettings()

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

Returns
Type Description
UnaryCallSettings<CreateJobTriggerRequest,JobTrigger>

createStoredInfoTypeSettings()

public UnaryCallSettings<CreateStoredInfoTypeRequest,StoredInfoType> createStoredInfoTypeSettings()

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

Returns
Type Description
UnaryCallSettings<CreateStoredInfoTypeRequest,StoredInfoType>

createStub()

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

deidentifyContentSettings()

public UnaryCallSettings<DeidentifyContentRequest,DeidentifyContentResponse> deidentifyContentSettings()

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

Returns
Type Description
UnaryCallSettings<DeidentifyContentRequest,DeidentifyContentResponse>

deleteConnectionSettings()

public UnaryCallSettings<DeleteConnectionRequest,Empty> deleteConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteConnectionRequest,Empty>

deleteDeidentifyTemplateSettings()

public UnaryCallSettings<DeleteDeidentifyTemplateRequest,Empty> deleteDeidentifyTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDeidentifyTemplateRequest,Empty>

deleteDiscoveryConfigSettings()

public UnaryCallSettings<DeleteDiscoveryConfigRequest,Empty> deleteDiscoveryConfigSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDiscoveryConfigRequest,Empty>

deleteDlpJobSettings()

public UnaryCallSettings<DeleteDlpJobRequest,Empty> deleteDlpJobSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDlpJobRequest,Empty>

deleteFileStoreDataProfileSettings()

public UnaryCallSettings<DeleteFileStoreDataProfileRequest,Empty> deleteFileStoreDataProfileSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteFileStoreDataProfileRequest,Empty>

deleteInspectTemplateSettings()

public UnaryCallSettings<DeleteInspectTemplateRequest,Empty> deleteInspectTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteInspectTemplateRequest,Empty>

deleteJobTriggerSettings()

public UnaryCallSettings<DeleteJobTriggerRequest,Empty> deleteJobTriggerSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteJobTriggerRequest,Empty>

deleteStoredInfoTypeSettings()

public UnaryCallSettings<DeleteStoredInfoTypeRequest,Empty> deleteStoredInfoTypeSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteStoredInfoTypeRequest,Empty>

deleteTableDataProfileSettings()

public UnaryCallSettings<DeleteTableDataProfileRequest,Empty> deleteTableDataProfileSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteTableDataProfileRequest,Empty>

finishDlpJobSettings()

public UnaryCallSettings<FinishDlpJobRequest,Empty> finishDlpJobSettings()

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

Returns
Type Description
UnaryCallSettings<FinishDlpJobRequest,Empty>

getColumnDataProfileSettings()

public UnaryCallSettings<GetColumnDataProfileRequest,ColumnDataProfile> getColumnDataProfileSettings()

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

Returns
Type Description
UnaryCallSettings<GetColumnDataProfileRequest,ColumnDataProfile>

getConnectionSettings()

public UnaryCallSettings<GetConnectionRequest,Connection> getConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<GetConnectionRequest,Connection>

getDeidentifyTemplateSettings()

public UnaryCallSettings<GetDeidentifyTemplateRequest,DeidentifyTemplate> getDeidentifyTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<GetDeidentifyTemplateRequest,DeidentifyTemplate>

getDiscoveryConfigSettings()

public UnaryCallSettings<GetDiscoveryConfigRequest,DiscoveryConfig> getDiscoveryConfigSettings()

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

Returns
Type Description
UnaryCallSettings<GetDiscoveryConfigRequest,DiscoveryConfig>

getDlpJobSettings()

public UnaryCallSettings<GetDlpJobRequest,DlpJob> getDlpJobSettings()

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

Returns
Type Description
UnaryCallSettings<GetDlpJobRequest,DlpJob>

getFileStoreDataProfileSettings()

public UnaryCallSettings<GetFileStoreDataProfileRequest,FileStoreDataProfile> getFileStoreDataProfileSettings()

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

Returns
Type Description
UnaryCallSettings<GetFileStoreDataProfileRequest,FileStoreDataProfile>

getInspectTemplateSettings()

public UnaryCallSettings<GetInspectTemplateRequest,InspectTemplate> getInspectTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<GetInspectTemplateRequest,InspectTemplate>

getJobTriggerSettings()

public UnaryCallSettings<GetJobTriggerRequest,JobTrigger> getJobTriggerSettings()

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

Returns
Type Description
UnaryCallSettings<GetJobTriggerRequest,JobTrigger>

getProjectDataProfileSettings()

public UnaryCallSettings<GetProjectDataProfileRequest,ProjectDataProfile> getProjectDataProfileSettings()

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

Returns
Type Description
UnaryCallSettings<GetProjectDataProfileRequest,ProjectDataProfile>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getStoredInfoTypeSettings()

public UnaryCallSettings<GetStoredInfoTypeRequest,StoredInfoType> getStoredInfoTypeSettings()

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

Returns
Type Description
UnaryCallSettings<GetStoredInfoTypeRequest,StoredInfoType>

getTableDataProfileSettings()

public UnaryCallSettings<GetTableDataProfileRequest,TableDataProfile> getTableDataProfileSettings()

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

Returns
Type Description
UnaryCallSettings<GetTableDataProfileRequest,TableDataProfile>

hybridInspectDlpJobSettings()

public UnaryCallSettings<HybridInspectDlpJobRequest,HybridInspectResponse> hybridInspectDlpJobSettings()

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

Returns
Type Description
UnaryCallSettings<HybridInspectDlpJobRequest,HybridInspectResponse>

hybridInspectJobTriggerSettings()

public UnaryCallSettings<HybridInspectJobTriggerRequest,HybridInspectResponse> hybridInspectJobTriggerSettings()

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

Returns
Type Description
UnaryCallSettings<HybridInspectJobTriggerRequest,HybridInspectResponse>

inspectContentSettings()

public UnaryCallSettings<InspectContentRequest,InspectContentResponse> inspectContentSettings()

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

Returns
Type Description
UnaryCallSettings<InspectContentRequest,InspectContentResponse>

listColumnDataProfilesSettings()

public PagedCallSettings<ListColumnDataProfilesRequest,ListColumnDataProfilesResponse,DlpServiceClient.ListColumnDataProfilesPagedResponse> listColumnDataProfilesSettings()

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

Returns
Type Description
PagedCallSettings<ListColumnDataProfilesRequest,ListColumnDataProfilesResponse,ListColumnDataProfilesPagedResponse>

listConnectionsSettings()

public PagedCallSettings<ListConnectionsRequest,ListConnectionsResponse,DlpServiceClient.ListConnectionsPagedResponse> listConnectionsSettings()

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

Returns
Type Description
PagedCallSettings<ListConnectionsRequest,ListConnectionsResponse,ListConnectionsPagedResponse>

listDeidentifyTemplatesSettings()

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

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

Returns
Type Description
PagedCallSettings<ListDeidentifyTemplatesRequest,ListDeidentifyTemplatesResponse,ListDeidentifyTemplatesPagedResponse>

listDiscoveryConfigsSettings()

public PagedCallSettings<ListDiscoveryConfigsRequest,ListDiscoveryConfigsResponse,DlpServiceClient.ListDiscoveryConfigsPagedResponse> listDiscoveryConfigsSettings()

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

Returns
Type Description
PagedCallSettings<ListDiscoveryConfigsRequest,ListDiscoveryConfigsResponse,ListDiscoveryConfigsPagedResponse>

listDlpJobsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListDlpJobsRequest,ListDlpJobsResponse,ListDlpJobsPagedResponse>

listFileStoreDataProfilesSettings()

public PagedCallSettings<ListFileStoreDataProfilesRequest,ListFileStoreDataProfilesResponse,DlpServiceClient.ListFileStoreDataProfilesPagedResponse> listFileStoreDataProfilesSettings()

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

Returns
Type Description
PagedCallSettings<ListFileStoreDataProfilesRequest,ListFileStoreDataProfilesResponse,ListFileStoreDataProfilesPagedResponse>

listInfoTypesSettings()

public UnaryCallSettings<ListInfoTypesRequest,ListInfoTypesResponse> listInfoTypesSettings()

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

Returns
Type Description
UnaryCallSettings<ListInfoTypesRequest,ListInfoTypesResponse>

listInspectTemplatesSettings()

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

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

Returns
Type Description
PagedCallSettings<ListInspectTemplatesRequest,ListInspectTemplatesResponse,ListInspectTemplatesPagedResponse>

listJobTriggersSettings()

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

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

Returns
Type Description
PagedCallSettings<ListJobTriggersRequest,ListJobTriggersResponse,ListJobTriggersPagedResponse>

listProjectDataProfilesSettings()

public PagedCallSettings<ListProjectDataProfilesRequest,ListProjectDataProfilesResponse,DlpServiceClient.ListProjectDataProfilesPagedResponse> listProjectDataProfilesSettings()

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

Returns
Type Description
PagedCallSettings<ListProjectDataProfilesRequest,ListProjectDataProfilesResponse,ListProjectDataProfilesPagedResponse>

listStoredInfoTypesSettings()

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

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

Returns
Type Description
PagedCallSettings<ListStoredInfoTypesRequest,ListStoredInfoTypesResponse,ListStoredInfoTypesPagedResponse>

listTableDataProfilesSettings()

public PagedCallSettings<ListTableDataProfilesRequest,ListTableDataProfilesResponse,DlpServiceClient.ListTableDataProfilesPagedResponse> listTableDataProfilesSettings()

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

Returns
Type Description
PagedCallSettings<ListTableDataProfilesRequest,ListTableDataProfilesResponse,ListTableDataProfilesPagedResponse>

redactImageSettings()

public UnaryCallSettings<RedactImageRequest,RedactImageResponse> redactImageSettings()

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

Returns
Type Description
UnaryCallSettings<RedactImageRequest,RedactImageResponse>

reidentifyContentSettings()

public UnaryCallSettings<ReidentifyContentRequest,ReidentifyContentResponse> reidentifyContentSettings()

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

Returns
Type Description
UnaryCallSettings<ReidentifyContentRequest,ReidentifyContentResponse>

searchConnectionsSettings()

public PagedCallSettings<SearchConnectionsRequest,SearchConnectionsResponse,DlpServiceClient.SearchConnectionsPagedResponse> searchConnectionsSettings()

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

Returns
Type Description
PagedCallSettings<SearchConnectionsRequest,SearchConnectionsResponse,SearchConnectionsPagedResponse>

toBuilder()

public DlpServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
DlpServiceStubSettings.Builder
Overrides

updateConnectionSettings()

public UnaryCallSettings<UpdateConnectionRequest,Connection> updateConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateConnectionRequest,Connection>

updateDeidentifyTemplateSettings()

public UnaryCallSettings<UpdateDeidentifyTemplateRequest,DeidentifyTemplate> updateDeidentifyTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDeidentifyTemplateRequest,DeidentifyTemplate>

updateDiscoveryConfigSettings()

public UnaryCallSettings<UpdateDiscoveryConfigRequest,DiscoveryConfig> updateDiscoveryConfigSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDiscoveryConfigRequest,DiscoveryConfig>

updateInspectTemplateSettings()

public UnaryCallSettings<UpdateInspectTemplateRequest,InspectTemplate> updateInspectTemplateSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateInspectTemplateRequest,InspectTemplate>

updateJobTriggerSettings()

public UnaryCallSettings<UpdateJobTriggerRequest,JobTrigger> updateJobTriggerSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateJobTriggerRequest,JobTrigger>

updateStoredInfoTypeSettings()

public UnaryCallSettings<UpdateStoredInfoTypeRequest,StoredInfoType> updateStoredInfoTypeSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateStoredInfoTypeRequest,StoredInfoType>