Class DataProfileJobConfig.Builder (3.18.0)

public static final class DataProfileJobConfig.Builder extends GeneratedMessageV3.Builder<DataProfileJobConfig.Builder> implements DataProfileJobConfigOrBuilder

Configuration for setting up a job to scan resources for profile generation. Only one data profile configuration may exist per organization, folder, or project. The generated data profiles are retained according to the data retention policy.

Protobuf type google.privacy.dlp.v2.DataProfileJobConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllDataProfileActions(Iterable<? extends DataProfileAction> values)

public DataProfileJobConfig.Builder addAllDataProfileActions(Iterable<? extends DataProfileAction> values)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameter
NameDescription
valuesIterable<? extends com.google.privacy.dlp.v2.DataProfileAction>
Returns
TypeDescription
DataProfileJobConfig.Builder

addAllInspectTemplates(Iterable<String> values)

public DataProfileJobConfig.Builder addAllInspectTemplates(Iterable<String> values)

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Parameter
NameDescription
valuesIterable<String>

The inspectTemplates to add.

Returns
TypeDescription
DataProfileJobConfig.Builder

This builder for chaining.

addDataProfileActions(DataProfileAction value)

public DataProfileJobConfig.Builder addDataProfileActions(DataProfileAction value)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameter
NameDescription
valueDataProfileAction
Returns
TypeDescription
DataProfileJobConfig.Builder

addDataProfileActions(DataProfileAction.Builder builderForValue)

public DataProfileJobConfig.Builder addDataProfileActions(DataProfileAction.Builder builderForValue)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameter
NameDescription
builderForValueDataProfileAction.Builder
Returns
TypeDescription
DataProfileJobConfig.Builder

addDataProfileActions(int index, DataProfileAction value)

public DataProfileJobConfig.Builder addDataProfileActions(int index, DataProfileAction value)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameters
NameDescription
indexint
valueDataProfileAction
Returns
TypeDescription
DataProfileJobConfig.Builder

addDataProfileActions(int index, DataProfileAction.Builder builderForValue)

public DataProfileJobConfig.Builder addDataProfileActions(int index, DataProfileAction.Builder builderForValue)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameters
NameDescription
indexint
builderForValueDataProfileAction.Builder
Returns
TypeDescription
DataProfileJobConfig.Builder

addDataProfileActionsBuilder()

public DataProfileAction.Builder addDataProfileActionsBuilder()

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Returns
TypeDescription
DataProfileAction.Builder

addDataProfileActionsBuilder(int index)

public DataProfileAction.Builder addDataProfileActionsBuilder(int index)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataProfileAction.Builder

addInspectTemplates(String value)

public DataProfileJobConfig.Builder addInspectTemplates(String value)

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Parameter
NameDescription
valueString

The inspectTemplates to add.

Returns
TypeDescription
DataProfileJobConfig.Builder

This builder for chaining.

addInspectTemplatesBytes(ByteString value)

public DataProfileJobConfig.Builder addInspectTemplatesBytes(ByteString value)

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Parameter
NameDescription
valueByteString

The bytes of the inspectTemplates to add.

Returns
TypeDescription
DataProfileJobConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataProfileJobConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

build()

public DataProfileJobConfig build()
Returns
TypeDescription
DataProfileJobConfig

buildPartial()

public DataProfileJobConfig buildPartial()
Returns
TypeDescription
DataProfileJobConfig

clear()

public DataProfileJobConfig.Builder clear()
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

clearDataProfileActions()

public DataProfileJobConfig.Builder clearDataProfileActions()

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Returns
TypeDescription
DataProfileJobConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public DataProfileJobConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

clearInspectTemplates()

public DataProfileJobConfig.Builder clearInspectTemplates()

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Returns
TypeDescription
DataProfileJobConfig.Builder

This builder for chaining.

clearLocation()

public DataProfileJobConfig.Builder clearLocation()

The data to scan.

.google.privacy.dlp.v2.DataProfileLocation location = 1;

Returns
TypeDescription
DataProfileJobConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DataProfileJobConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

clearProjectId()

public DataProfileJobConfig.Builder clearProjectId()

The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.

string project_id = 5;

Returns
TypeDescription
DataProfileJobConfig.Builder

This builder for chaining.

clone()

public DataProfileJobConfig.Builder clone()
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

getDataProfileActions(int index)

public DataProfileAction getDataProfileActions(int index)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataProfileAction

getDataProfileActionsBuilder(int index)

public DataProfileAction.Builder getDataProfileActionsBuilder(int index)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataProfileAction.Builder

getDataProfileActionsBuilderList()

public List<DataProfileAction.Builder> getDataProfileActionsBuilderList()

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Returns
TypeDescription
List<Builder>

getDataProfileActionsCount()

public int getDataProfileActionsCount()

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Returns
TypeDescription
int

getDataProfileActionsList()

public List<DataProfileAction> getDataProfileActionsList()

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Returns
TypeDescription
List<DataProfileAction>

getDataProfileActionsOrBuilder(int index)

public DataProfileActionOrBuilder getDataProfileActionsOrBuilder(int index)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataProfileActionOrBuilder

getDataProfileActionsOrBuilderList()

public List<? extends DataProfileActionOrBuilder> getDataProfileActionsOrBuilderList()

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Returns
TypeDescription
List<? extends com.google.privacy.dlp.v2.DataProfileActionOrBuilder>

getDefaultInstanceForType()

public DataProfileJobConfig getDefaultInstanceForType()
Returns
TypeDescription
DataProfileJobConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getInspectTemplates(int index)

public String getInspectTemplates(int index)

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The inspectTemplates at the given index.

getInspectTemplatesBytes(int index)

public ByteString getInspectTemplatesBytes(int index)

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the inspectTemplates at the given index.

getInspectTemplatesCount()

public int getInspectTemplatesCount()

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Returns
TypeDescription
int

The count of inspectTemplates.

getInspectTemplatesList()

public ProtocolStringList getInspectTemplatesList()

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Returns
TypeDescription
ProtocolStringList

A list containing the inspectTemplates.

getLocation()

public DataProfileLocation getLocation()

The data to scan.

.google.privacy.dlp.v2.DataProfileLocation location = 1;

Returns
TypeDescription
DataProfileLocation

The location.

getLocationBuilder()

public DataProfileLocation.Builder getLocationBuilder()

The data to scan.

.google.privacy.dlp.v2.DataProfileLocation location = 1;

Returns
TypeDescription
DataProfileLocation.Builder

getLocationOrBuilder()

public DataProfileLocationOrBuilder getLocationOrBuilder()

The data to scan.

.google.privacy.dlp.v2.DataProfileLocation location = 1;

Returns
TypeDescription
DataProfileLocationOrBuilder

getProjectId()

public String getProjectId()

The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.

string project_id = 5;

Returns
TypeDescription
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.

string project_id = 5;

Returns
TypeDescription
ByteString

The bytes for projectId.

hasLocation()

public boolean hasLocation()

The data to scan.

.google.privacy.dlp.v2.DataProfileLocation location = 1;

Returns
TypeDescription
boolean

Whether the location field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DataProfileJobConfig other)

public DataProfileJobConfig.Builder mergeFrom(DataProfileJobConfig other)
Parameter
NameDescription
otherDataProfileJobConfig
Returns
TypeDescription
DataProfileJobConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DataProfileJobConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DataProfileJobConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

mergeLocation(DataProfileLocation value)

public DataProfileJobConfig.Builder mergeLocation(DataProfileLocation value)

The data to scan.

.google.privacy.dlp.v2.DataProfileLocation location = 1;

Parameter
NameDescription
valueDataProfileLocation
Returns
TypeDescription
DataProfileJobConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DataProfileJobConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

removeDataProfileActions(int index)

public DataProfileJobConfig.Builder removeDataProfileActions(int index)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataProfileJobConfig.Builder

setDataProfileActions(int index, DataProfileAction value)

public DataProfileJobConfig.Builder setDataProfileActions(int index, DataProfileAction value)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameters
NameDescription
indexint
valueDataProfileAction
Returns
TypeDescription
DataProfileJobConfig.Builder

setDataProfileActions(int index, DataProfileAction.Builder builderForValue)

public DataProfileJobConfig.Builder setDataProfileActions(int index, DataProfileAction.Builder builderForValue)

Actions to execute at the completion of the job.

repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

Parameters
NameDescription
indexint
builderForValueDataProfileAction.Builder
Returns
TypeDescription
DataProfileJobConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DataProfileJobConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

setInspectTemplates(int index, String value)

public DataProfileJobConfig.Builder setInspectTemplates(int index, String value)

Detection logic for profile generation. Not all template features are used by profiles. FindingLimits, include_quote and exclude_info_types have no impact on data profiling. Multiple templates may be provided if there is data in multiple regions. At most one template must be specified per-region (including "global"). Each region is scanned using the applicable template. If no region-specific template is specified, but a "global" template is specified, it will be copied to that region and used instead. If no global or region-specific template is provided for a region with data, that region's data will not be scanned. For more information, see https://cloud.google.com/dlp/docs/data-profiles#data_residency.

repeated string inspect_templates = 7;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The inspectTemplates to set.

Returns
TypeDescription
DataProfileJobConfig.Builder

This builder for chaining.

setLocation(DataProfileLocation value)

public DataProfileJobConfig.Builder setLocation(DataProfileLocation value)

The data to scan.

.google.privacy.dlp.v2.DataProfileLocation location = 1;

Parameter
NameDescription
valueDataProfileLocation
Returns
TypeDescription
DataProfileJobConfig.Builder

setLocation(DataProfileLocation.Builder builderForValue)

public DataProfileJobConfig.Builder setLocation(DataProfileLocation.Builder builderForValue)

The data to scan.

.google.privacy.dlp.v2.DataProfileLocation location = 1;

Parameter
NameDescription
builderForValueDataProfileLocation.Builder
Returns
TypeDescription
DataProfileJobConfig.Builder

setProjectId(String value)

public DataProfileJobConfig.Builder setProjectId(String value)

The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.

string project_id = 5;

Parameter
NameDescription
valueString

The projectId to set.

Returns
TypeDescription
DataProfileJobConfig.Builder

This builder for chaining.

setProjectIdBytes(ByteString value)

public DataProfileJobConfig.Builder setProjectIdBytes(ByteString value)

The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.

string project_id = 5;

Parameter
NameDescription
valueByteString

The bytes for projectId to set.

Returns
TypeDescription
DataProfileJobConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DataProfileJobConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DataProfileJobConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides