Class DiscoveryConfig (3.48.0)

public final class DiscoveryConfig extends GeneratedMessageV3 implements DiscoveryConfigOrBuilder

Configuration for discovery to scan resources for profile generation. Only one discovery 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.DiscoveryConfig

Static Fields

ACTIONS_FIELD_NUMBER

public static final int ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

ERRORS_FIELD_NUMBER

public static final int ERRORS_FIELD_NUMBER
Field Value
Type Description
int

INSPECT_TEMPLATES_FIELD_NUMBER

public static final int INSPECT_TEMPLATES_FIELD_NUMBER
Field Value
Type Description
int

LAST_RUN_TIME_FIELD_NUMBER

public static final int LAST_RUN_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORG_CONFIG_FIELD_NUMBER

public static final int ORG_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TARGETS_FIELD_NUMBER

public static final int TARGETS_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DiscoveryConfig getDefaultInstance()
Returns
Type Description
DiscoveryConfig

getDescriptor()

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

newBuilder()

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

newBuilder(DiscoveryConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActions(int index)

public DataProfileAction getActions(int index)

Actions to execute at the completion of scanning.

repeated .google.privacy.dlp.v2.DataProfileAction actions = 4;

Parameter
Name Description
index int
Returns
Type Description
DataProfileAction

getActionsCount()

public int getActionsCount()

Actions to execute at the completion of scanning.

repeated .google.privacy.dlp.v2.DataProfileAction actions = 4;

Returns
Type Description
int

getActionsList()

public List<DataProfileAction> getActionsList()

Actions to execute at the completion of scanning.

repeated .google.privacy.dlp.v2.DataProfileAction actions = 4;

Returns
Type Description
List<DataProfileAction>

getActionsOrBuilder(int index)

public DataProfileActionOrBuilder getActionsOrBuilder(int index)

Actions to execute at the completion of scanning.

repeated .google.privacy.dlp.v2.DataProfileAction actions = 4;

Parameter
Name Description
index int
Returns
Type Description
DataProfileActionOrBuilder

getActionsOrBuilderList()

public List<? extends DataProfileActionOrBuilder> getActionsOrBuilderList()

Actions to execute at the completion of scanning.

repeated .google.privacy.dlp.v2.DataProfileAction actions = 4;

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

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation timestamp of a DiscoveryConfig.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation timestamp of a DiscoveryConfig.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DiscoveryConfig getDefaultInstanceForType()
Returns
Type Description
DiscoveryConfig

getDisplayName()

public String getDisplayName()

Display name (max 100 chars)

string display_name = 11;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name (max 100 chars)

string display_name = 11;

Returns
Type Description
ByteString

The bytes for displayName.

getErrors(int index)

public Error getErrors(int index)

Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Error

getErrorsCount()

public int getErrorsCount()

Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getErrorsList()

public List<Error> getErrorsList()

Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Error>

getErrorsOrBuilder(int index)

public ErrorOrBuilder getErrorsOrBuilder(int index)

Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ErrorOrBuilder

getErrorsOrBuilderList()

public List<? extends ErrorOrBuilder> getErrorsOrBuilderList()

Output only. A stream of errors encountered when the config was activated. Repeated errors may result in the config automatically being paused. Output only field. Will return the last 100 errors. Whenever the config is modified this list will be cleared.

repeated .google.privacy.dlp.v2.Error errors = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.ErrorOrBuilder>

getInspectTemplates(int index)

public String getInspectTemplates(int index)

Detection logic for profile generation.

Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery.

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 = 3;

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 Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery.

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 = 3;

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 Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery.

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 = 3;

Returns
Type Description
int

The count of inspectTemplates.

getInspectTemplatesList()

public ProtocolStringList getInspectTemplatesList()

Detection logic for profile generation.

Not all template features are used by Discovery. FindingLimits, include_quote and exclude_info_types have no impact on Discovery.

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 = 3;

Returns
Type Description
ProtocolStringList

A list containing the inspectTemplates.

getLastRunTime()

public Timestamp getLastRunTime()

Output only. The timestamp of the last time this config was executed.

.google.protobuf.Timestamp last_run_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The lastRunTime.

getLastRunTimeOrBuilder()

public TimestampOrBuilder getLastRunTimeOrBuilder()

Output only. The timestamp of the last time this config was executed.

.google.protobuf.Timestamp last_run_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getName()

public String getName()

Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example projects/dlp-test-project/locations/global/discoveryConfigs/53234423.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example projects/dlp-test-project/locations/global/discoveryConfigs/53234423.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOrgConfig()

public DiscoveryConfig.OrgConfig getOrgConfig()

Only set when the parent is an org.

.google.privacy.dlp.v2.DiscoveryConfig.OrgConfig org_config = 2;

Returns
Type Description
DiscoveryConfig.OrgConfig

The orgConfig.

getOrgConfigOrBuilder()

public DiscoveryConfig.OrgConfigOrBuilder getOrgConfigOrBuilder()

Only set when the parent is an org.

.google.privacy.dlp.v2.DiscoveryConfig.OrgConfig org_config = 2;

Returns
Type Description
DiscoveryConfig.OrgConfigOrBuilder

getParserForType()

public Parser<DiscoveryConfig> getParserForType()
Returns
Type Description
Parser<DiscoveryConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatus()

public DiscoveryConfig.Status getStatus()

Required. A status for this configuration.

.google.privacy.dlp.v2.DiscoveryConfig.Status status = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DiscoveryConfig.Status

The status.

getStatusValue()

public int getStatusValue()

Required. A status for this configuration.

.google.privacy.dlp.v2.DiscoveryConfig.Status status = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for status.

getTargets(int index)

public DiscoveryTarget getTargets(int index)

Target to match against for determining what to scan and how frequently.

repeated .google.privacy.dlp.v2.DiscoveryTarget targets = 5;

Parameter
Name Description
index int
Returns
Type Description
DiscoveryTarget

getTargetsCount()

public int getTargetsCount()

Target to match against for determining what to scan and how frequently.

repeated .google.privacy.dlp.v2.DiscoveryTarget targets = 5;

Returns
Type Description
int

getTargetsList()

public List<DiscoveryTarget> getTargetsList()

Target to match against for determining what to scan and how frequently.

repeated .google.privacy.dlp.v2.DiscoveryTarget targets = 5;

Returns
Type Description
List<DiscoveryTarget>

getTargetsOrBuilder(int index)

public DiscoveryTargetOrBuilder getTargetsOrBuilder(int index)

Target to match against for determining what to scan and how frequently.

repeated .google.privacy.dlp.v2.DiscoveryTarget targets = 5;

Parameter
Name Description
index int
Returns
Type Description
DiscoveryTargetOrBuilder

getTargetsOrBuilderList()

public List<? extends DiscoveryTargetOrBuilder> getTargetsOrBuilderList()

Target to match against for determining what to scan and how frequently.

repeated .google.privacy.dlp.v2.DiscoveryTarget targets = 5;

Returns
Type Description
List<? extends com.google.privacy.dlp.v2.DiscoveryTargetOrBuilder>

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The last update timestamp of a DiscoveryConfig.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The last update timestamp of a DiscoveryConfig.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation timestamp of a DiscoveryConfig.

.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasLastRunTime()

public boolean hasLastRunTime()

Output only. The timestamp of the last time this config was executed.

.google.protobuf.Timestamp last_run_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the lastRunTime field is set.

hasOrgConfig()

public boolean hasOrgConfig()

Only set when the parent is an org.

.google.privacy.dlp.v2.DiscoveryConfig.OrgConfig org_config = 2;

Returns
Type Description
boolean

Whether the orgConfig field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The last update timestamp of a DiscoveryConfig.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime 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 DiscoveryConfig.Builder newBuilderForType()
Returns
Type Description
DiscoveryConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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