Class DataProfileJobConfig (3.56.0)

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
Type Description
int

INSPECT_TEMPLATES_FIELD_NUMBER

public static final int INSPECT_TEMPLATES_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

OTHER_CLOUD_STARTING_LOCATION_FIELD_NUMBER

public static final int OTHER_CLOUD_STARTING_LOCATION_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataProfileJobConfig getDefaultInstance()
Returns
Type Description
DataProfileJobConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DataProfileJobConfig.Builder newBuilder()
Returns
Type Description
DataProfileJobConfig.Builder

newBuilder(DataProfileJobConfig prototype)

public static DataProfileJobConfig.Builder newBuilder(DataProfileJobConfig prototype)
Parameter
Name Description
prototype DataProfileJobConfig
Returns
Type Description
DataProfileJobConfig.Builder

parseDelimitedFrom(InputStream input)

public static DataProfileJobConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataProfileJobConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataProfileJobConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataProfileJobConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataProfileJobConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataProfileJobConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataProfileJobConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataProfileJobConfig> parser()
Returns
Type Description
Parser<DataProfileJobConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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
Name Description
index int
Returns
Type Description
DataProfileAction

getDataProfileActionsCount()

public int getDataProfileActionsCount()

Actions to execute at the completion of the job.

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

Returns
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.privacy.dlp.v2.DataProfileActionOrBuilder>

getDefaultInstanceForType()

public DataProfileJobConfig getDefaultInstanceForType()
Returns
Type Description
DataProfileJobConfig

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/sensitive-data-protection/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/sensitive-data-protection/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/sensitive-data-protection/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/sensitive-data-protection/docs/data-profiles#data-residency.

repeated string inspect_templates = 7;

Returns
Type Description
ProtocolStringList

A list containing the inspectTemplates.

getLocation()

public DataProfileLocation getLocation()

The data to scan.

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

Returns
Type Description
DataProfileLocation

The location.

getLocationOrBuilder()

public DataProfileLocationOrBuilder getLocationOrBuilder()

The data to scan.

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

Returns
Type Description
DataProfileLocationOrBuilder

getOtherCloudStartingLocation()

public OtherCloudDiscoveryStartingLocation getOtherCloudStartingLocation()

Must be set only when scanning other clouds.

.google.privacy.dlp.v2.OtherCloudDiscoveryStartingLocation other_cloud_starting_location = 8;

Returns
Type Description
OtherCloudDiscoveryStartingLocation

The otherCloudStartingLocation.

getOtherCloudStartingLocationOrBuilder()

public OtherCloudDiscoveryStartingLocationOrBuilder getOtherCloudStartingLocationOrBuilder()

Must be set only when scanning other clouds.

.google.privacy.dlp.v2.OtherCloudDiscoveryStartingLocation other_cloud_starting_location = 8;

Returns
Type Description
OtherCloudDiscoveryStartingLocationOrBuilder

getParserForType()

public Parser<DataProfileJobConfig> getParserForType()
Returns
Type Description
Parser<DataProfileJobConfig>
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
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

hasOtherCloudStartingLocation()

public boolean hasOtherCloudStartingLocation()

Must be set only when scanning other clouds.

.google.privacy.dlp.v2.OtherCloudDiscoveryStartingLocation other_cloud_starting_location = 8;

Returns
Type Description
boolean

Whether the otherCloudStartingLocation field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataProfileJobConfig.Builder newBuilderForType()
Returns
Type Description
DataProfileJobConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataProfileJobConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataProfileJobConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DataProfileJobConfig.Builder toBuilder()
Returns
Type Description
DataProfileJobConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException