public final class DataProfileJobConfig extends GeneratedMessageV3 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 Fields
DATA_PROFILE_ACTIONS_FIELD_NUMBER
public static final int DATA_PROFILE_ACTIONS_FIELD_NUMBER
Field Value
INSPECT_TEMPLATES_FIELD_NUMBER
public static final int INSPECT_TEMPLATES_FIELD_NUMBER
Field Value
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER
Field Value
PROJECT_ID_FIELD_NUMBER
public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DataProfileJobConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DataProfileJobConfig.Builder newBuilder()
Returns
newBuilder(DataProfileJobConfig prototype)
public static DataProfileJobConfig.Builder newBuilder(DataProfileJobConfig prototype)
Parameter
Returns
public static DataProfileJobConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataProfileJobConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DataProfileJobConfig parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataProfileJobConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DataProfileJobConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataProfileJobConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataProfileJobConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DataProfileJobConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataProfileJobConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataProfileJobConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DataProfileJobConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataProfileJobConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DataProfileJobConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
Returns
getDataProfileActionsCount()
public int getDataProfileActionsCount()
Actions to execute at the completion of the job.
repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;
Returns
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
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
Returns
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
Type | Description |
List<? extends com.google.privacy.dlp.v2.DataProfileActionOrBuilder> | |
getDefaultInstanceForType()
public DataProfileJobConfig getDefaultInstanceForType()
Returns
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
Name | Description |
index | int
The index of the element to return.
|
Returns
Type | Description |
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
Name | Description |
index | int
The index of the value to return.
|
Returns
Type | Description |
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
Type | Description |
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
getLocation()
public DataProfileLocation getLocation()
The data to scan.
.google.privacy.dlp.v2.DataProfileLocation location = 1;
Returns
getLocationOrBuilder()
public DataProfileLocationOrBuilder getLocationOrBuilder()
The data to scan.
.google.privacy.dlp.v2.DataProfileLocation location = 1;
Returns
getParserForType()
public Parser<DataProfileJobConfig> getParserForType()
Returns
Overrides
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
Type | Description |
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
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasLocation()
public boolean hasLocation()
The data to scan.
.google.privacy.dlp.v2.DataProfileLocation location = 1;
Returns
Type | Description |
boolean | Whether the location field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DataProfileJobConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataProfileJobConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DataProfileJobConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions