Class DataProfileJobConfig (3.36.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
TypeDescription
int

INSPECT_TEMPLATES_FIELD_NUMBER

public static final int INSPECT_TEMPLATES_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DataProfileJobConfig getDefaultInstance()
Returns
TypeDescription
DataProfileJobConfig

getDescriptor()

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

newBuilder()

public static DataProfileJobConfig.Builder newBuilder()
Returns
TypeDescription
DataProfileJobConfig.Builder

newBuilder(DataProfileJobConfig prototype)

public static DataProfileJobConfig.Builder newBuilder(DataProfileJobConfig prototype)
Parameter
NameDescription
prototypeDataProfileJobConfig
Returns
TypeDescription
DataProfileJobConfig.Builder

parseDelimitedFrom(InputStream input)

public static DataProfileJobConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DataProfileJobConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataProfileJobConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataProfileJobConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DataProfileJobConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DataProfileJobConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataProfileJobConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DataProfileJobConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DataProfileJobConfig> parser()
Returns
TypeDescription
Parser<DataProfileJobConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
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

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.

getLocationOrBuilder()

public DataProfileLocationOrBuilder getLocationOrBuilder()

The data to scan.

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

Returns
TypeDescription
DataProfileLocationOrBuilder

getParserForType()

public Parser<DataProfileJobConfig> getParserForType()
Returns
TypeDescription
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
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasLocation()

public boolean hasLocation()

The data to scan.

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

Returns
TypeDescription
boolean

Whether the location field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DataProfileJobConfig.Builder newBuilderForType()
Returns
TypeDescription
DataProfileJobConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataProfileJobConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DataProfileJobConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DataProfileJobConfig.Builder toBuilder()
Returns
TypeDescription
DataProfileJobConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException