Class DiscoveryConfig.Builder (3.57.0)

public static final class DiscoveryConfig.Builder extends GeneratedMessageV3.Builder<DiscoveryConfig.Builder> 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 Methods

getDescriptor()

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

Methods

addActions(DataProfileAction value)

public DiscoveryConfig.Builder addActions(DataProfileAction value)

Actions to execute at the completion of scanning.

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

Parameter
Name Description
value DataProfileAction
Returns
Type Description
DiscoveryConfig.Builder

addActions(DataProfileAction.Builder builderForValue)

public DiscoveryConfig.Builder addActions(DataProfileAction.Builder builderForValue)

Actions to execute at the completion of scanning.

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

Parameter
Name Description
builderForValue DataProfileAction.Builder
Returns
Type Description
DiscoveryConfig.Builder

addActions(int index, DataProfileAction value)

public DiscoveryConfig.Builder addActions(int index, DataProfileAction value)

Actions to execute at the completion of scanning.

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

Parameters
Name Description
index int
value DataProfileAction
Returns
Type Description
DiscoveryConfig.Builder

addActions(int index, DataProfileAction.Builder builderForValue)

public DiscoveryConfig.Builder addActions(int index, DataProfileAction.Builder builderForValue)

Actions to execute at the completion of scanning.

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

Parameters
Name Description
index int
builderForValue DataProfileAction.Builder
Returns
Type Description
DiscoveryConfig.Builder

addActionsBuilder()

public DataProfileAction.Builder addActionsBuilder()

Actions to execute at the completion of scanning.

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

Returns
Type Description
DataProfileAction.Builder

addActionsBuilder(int index)

public DataProfileAction.Builder addActionsBuilder(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.Builder

addAllActions(Iterable<? extends DataProfileAction> values)

public DiscoveryConfig.Builder addAllActions(Iterable<? extends DataProfileAction> values)

Actions to execute at the completion of scanning.

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

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.DataProfileAction>
Returns
Type Description
DiscoveryConfig.Builder

addAllErrors(Iterable<? extends Error> values)

public DiscoveryConfig.Builder addAllErrors(Iterable<? extends Error> values)

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
values Iterable<? extends com.google.privacy.dlp.v2.Error>
Returns
Type Description
DiscoveryConfig.Builder

addAllInspectTemplates(Iterable<String> values)

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

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
values Iterable<String>

The inspectTemplates to add.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

addAllTargets(Iterable<? extends DiscoveryTarget> values)

public DiscoveryConfig.Builder addAllTargets(Iterable<? extends DiscoveryTarget> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.privacy.dlp.v2.DiscoveryTarget>
Returns
Type Description
DiscoveryConfig.Builder

addErrors(Error value)

public DiscoveryConfig.Builder addErrors(Error value)

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
value Error
Returns
Type Description
DiscoveryConfig.Builder

addErrors(Error.Builder builderForValue)

public DiscoveryConfig.Builder addErrors(Error.Builder builderForValue)

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
builderForValue Error.Builder
Returns
Type Description
DiscoveryConfig.Builder

addErrors(int index, Error value)

public DiscoveryConfig.Builder addErrors(int index, Error value)

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];

Parameters
Name Description
index int
value Error
Returns
Type Description
DiscoveryConfig.Builder

addErrors(int index, Error.Builder builderForValue)

public DiscoveryConfig.Builder addErrors(int index, Error.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Error.Builder
Returns
Type Description
DiscoveryConfig.Builder

addErrorsBuilder()

public Error.Builder addErrorsBuilder()

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
Error.Builder

addErrorsBuilder(int index)

public Error.Builder addErrorsBuilder(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.Builder

addInspectTemplates(String value)

public DiscoveryConfig.Builder addInspectTemplates(String value)

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
value String

The inspectTemplates to add.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

addInspectTemplatesBytes(ByteString value)

public DiscoveryConfig.Builder addInspectTemplatesBytes(ByteString value)

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
value ByteString

The bytes of the inspectTemplates to add.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DiscoveryConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DiscoveryConfig.Builder
Overrides

addTargets(DiscoveryTarget value)

public DiscoveryConfig.Builder addTargets(DiscoveryTarget value)

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

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

Parameter
Name Description
value DiscoveryTarget
Returns
Type Description
DiscoveryConfig.Builder

addTargets(DiscoveryTarget.Builder builderForValue)

public DiscoveryConfig.Builder addTargets(DiscoveryTarget.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue DiscoveryTarget.Builder
Returns
Type Description
DiscoveryConfig.Builder

addTargets(int index, DiscoveryTarget value)

public DiscoveryConfig.Builder addTargets(int index, DiscoveryTarget value)

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

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

Parameters
Name Description
index int
value DiscoveryTarget
Returns
Type Description
DiscoveryConfig.Builder

addTargets(int index, DiscoveryTarget.Builder builderForValue)

public DiscoveryConfig.Builder addTargets(int index, DiscoveryTarget.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue DiscoveryTarget.Builder
Returns
Type Description
DiscoveryConfig.Builder

addTargetsBuilder()

public DiscoveryTarget.Builder addTargetsBuilder()

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

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

Returns
Type Description
DiscoveryTarget.Builder

addTargetsBuilder(int index)

public DiscoveryTarget.Builder addTargetsBuilder(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.Builder

build()

public DiscoveryConfig build()
Returns
Type Description
DiscoveryConfig

buildPartial()

public DiscoveryConfig buildPartial()
Returns
Type Description
DiscoveryConfig

clear()

public DiscoveryConfig.Builder clear()
Returns
Type Description
DiscoveryConfig.Builder
Overrides

clearActions()

public DiscoveryConfig.Builder clearActions()

Actions to execute at the completion of scanning.

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

Returns
Type Description
DiscoveryConfig.Builder

clearCreateTime()

public DiscoveryConfig.Builder clearCreateTime()

Output only. The creation timestamp of a DiscoveryConfig.

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

Returns
Type Description
DiscoveryConfig.Builder

clearDisplayName()

public DiscoveryConfig.Builder clearDisplayName()

Display name (max 100 chars)

string display_name = 11;

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

clearErrors()

public DiscoveryConfig.Builder clearErrors()

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
DiscoveryConfig.Builder

clearField(Descriptors.FieldDescriptor field)

public DiscoveryConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DiscoveryConfig.Builder
Overrides

clearInspectTemplates()

public DiscoveryConfig.Builder clearInspectTemplates()

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
DiscoveryConfig.Builder

This builder for chaining.

clearLastRunTime()

public DiscoveryConfig.Builder clearLastRunTime()

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
DiscoveryConfig.Builder

clearName()

public DiscoveryConfig.Builder clearName()

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
DiscoveryConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DiscoveryConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DiscoveryConfig.Builder
Overrides

clearOrgConfig()

public DiscoveryConfig.Builder clearOrgConfig()

Only set when the parent is an org.

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

Returns
Type Description
DiscoveryConfig.Builder

clearOtherCloudStartingLocation()

public DiscoveryConfig.Builder clearOtherCloudStartingLocation()

Must be set only when scanning other clouds.

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

Returns
Type Description
DiscoveryConfig.Builder

clearStatus()

public DiscoveryConfig.Builder clearStatus()

Required. A status for this configuration.

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

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

clearTargets()

public DiscoveryConfig.Builder clearTargets()

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

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

Returns
Type Description
DiscoveryConfig.Builder

clearUpdateTime()

public DiscoveryConfig.Builder clearUpdateTime()

Output only. The last update timestamp of a DiscoveryConfig.

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

Returns
Type Description
DiscoveryConfig.Builder

clone()

public DiscoveryConfig.Builder clone()
Returns
Type Description
DiscoveryConfig.Builder
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

getActionsBuilder(int index)

public DataProfileAction.Builder getActionsBuilder(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.Builder

getActionsBuilderList()

public List<DataProfileAction.Builder> getActionsBuilderList()

Actions to execute at the completion of scanning.

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

Returns
Type Description
List<Builder>

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation timestamp of a DiscoveryConfig.

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

Returns
Type Description
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getErrorsBuilder(int index)

public Error.Builder getErrorsBuilder(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.Builder

getErrorsBuilderList()

public List<Error.Builder> getErrorsBuilderList()

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<Builder>

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.

getLastRunTimeBuilder()

public Timestamp.Builder getLastRunTimeBuilder()

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
Builder

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.

getOrgConfigBuilder()

public DiscoveryConfig.OrgConfig.Builder getOrgConfigBuilder()

Only set when the parent is an org.

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

Returns
Type Description
DiscoveryConfig.OrgConfig.Builder

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

getOtherCloudStartingLocation()

public OtherCloudDiscoveryStartingLocation getOtherCloudStartingLocation()

Must be set only when scanning other clouds.

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

Returns
Type Description
OtherCloudDiscoveryStartingLocation

The otherCloudStartingLocation.

getOtherCloudStartingLocationBuilder()

public OtherCloudDiscoveryStartingLocation.Builder getOtherCloudStartingLocationBuilder()

Must be set only when scanning other clouds.

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

Returns
Type Description
OtherCloudDiscoveryStartingLocation.Builder

getOtherCloudStartingLocationOrBuilder()

public OtherCloudDiscoveryStartingLocationOrBuilder getOtherCloudStartingLocationOrBuilder()

Must be set only when scanning other clouds.

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

Returns
Type Description
OtherCloudDiscoveryStartingLocationOrBuilder

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

getTargetsBuilder(int index)

public DiscoveryTarget.Builder getTargetsBuilder(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.Builder

getTargetsBuilderList()

public List<DiscoveryTarget.Builder> getTargetsBuilderList()

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

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

Returns
Type Description
List<Builder>

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The last update timestamp of a DiscoveryConfig.

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

Returns
Type Description
Builder

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.

hasOtherCloudStartingLocation()

public boolean hasOtherCloudStartingLocation()

Must be set only when scanning other clouds.

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

Returns
Type Description
boolean

Whether the otherCloudStartingLocation 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public DiscoveryConfig.Builder mergeCreateTime(Timestamp value)

Output only. The creation timestamp of a DiscoveryConfig.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DiscoveryConfig.Builder

mergeFrom(DiscoveryConfig other)

public DiscoveryConfig.Builder mergeFrom(DiscoveryConfig other)
Parameter
Name Description
other DiscoveryConfig
Returns
Type Description
DiscoveryConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DiscoveryConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DiscoveryConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DiscoveryConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DiscoveryConfig.Builder
Overrides

mergeLastRunTime(Timestamp value)

public DiscoveryConfig.Builder mergeLastRunTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
DiscoveryConfig.Builder

mergeOrgConfig(DiscoveryConfig.OrgConfig value)

public DiscoveryConfig.Builder mergeOrgConfig(DiscoveryConfig.OrgConfig value)

Only set when the parent is an org.

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

Parameter
Name Description
value DiscoveryConfig.OrgConfig
Returns
Type Description
DiscoveryConfig.Builder

mergeOtherCloudStartingLocation(OtherCloudDiscoveryStartingLocation value)

public DiscoveryConfig.Builder mergeOtherCloudStartingLocation(OtherCloudDiscoveryStartingLocation value)

Must be set only when scanning other clouds.

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

Parameter
Name Description
value OtherCloudDiscoveryStartingLocation
Returns
Type Description
DiscoveryConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DiscoveryConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DiscoveryConfig.Builder
Overrides

mergeUpdateTime(Timestamp value)

public DiscoveryConfig.Builder mergeUpdateTime(Timestamp value)

Output only. The last update timestamp of a DiscoveryConfig.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DiscoveryConfig.Builder

removeActions(int index)

public DiscoveryConfig.Builder removeActions(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
DiscoveryConfig.Builder

removeErrors(int index)

public DiscoveryConfig.Builder removeErrors(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
DiscoveryConfig.Builder

removeTargets(int index)

public DiscoveryConfig.Builder removeTargets(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
DiscoveryConfig.Builder

setActions(int index, DataProfileAction value)

public DiscoveryConfig.Builder setActions(int index, DataProfileAction value)

Actions to execute at the completion of scanning.

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

Parameters
Name Description
index int
value DataProfileAction
Returns
Type Description
DiscoveryConfig.Builder

setActions(int index, DataProfileAction.Builder builderForValue)

public DiscoveryConfig.Builder setActions(int index, DataProfileAction.Builder builderForValue)

Actions to execute at the completion of scanning.

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

Parameters
Name Description
index int
builderForValue DataProfileAction.Builder
Returns
Type Description
DiscoveryConfig.Builder

setCreateTime(Timestamp value)

public DiscoveryConfig.Builder setCreateTime(Timestamp value)

Output only. The creation timestamp of a DiscoveryConfig.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DiscoveryConfig.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DiscoveryConfig.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The creation timestamp of a DiscoveryConfig.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DiscoveryConfig.Builder

setDisplayName(String value)

public DiscoveryConfig.Builder setDisplayName(String value)

Display name (max 100 chars)

string display_name = 11;

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DiscoveryConfig.Builder setDisplayNameBytes(ByteString value)

Display name (max 100 chars)

string display_name = 11;

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

setErrors(int index, Error value)

public DiscoveryConfig.Builder setErrors(int index, Error value)

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];

Parameters
Name Description
index int
value Error
Returns
Type Description
DiscoveryConfig.Builder

setErrors(int index, Error.Builder builderForValue)

public DiscoveryConfig.Builder setErrors(int index, Error.Builder builderForValue)

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];

Parameters
Name Description
index int
builderForValue Error.Builder
Returns
Type Description
DiscoveryConfig.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DiscoveryConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DiscoveryConfig.Builder
Overrides

setInspectTemplates(int index, String value)

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

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The inspectTemplates to set.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

setLastRunTime(Timestamp value)

public DiscoveryConfig.Builder setLastRunTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
DiscoveryConfig.Builder

setLastRunTime(Timestamp.Builder builderForValue)

public DiscoveryConfig.Builder setLastRunTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DiscoveryConfig.Builder

setName(String value)

public DiscoveryConfig.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DiscoveryConfig.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

setOrgConfig(DiscoveryConfig.OrgConfig value)

public DiscoveryConfig.Builder setOrgConfig(DiscoveryConfig.OrgConfig value)

Only set when the parent is an org.

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

Parameter
Name Description
value DiscoveryConfig.OrgConfig
Returns
Type Description
DiscoveryConfig.Builder

setOrgConfig(DiscoveryConfig.OrgConfig.Builder builderForValue)

public DiscoveryConfig.Builder setOrgConfig(DiscoveryConfig.OrgConfig.Builder builderForValue)

Only set when the parent is an org.

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

Parameter
Name Description
builderForValue DiscoveryConfig.OrgConfig.Builder
Returns
Type Description
DiscoveryConfig.Builder

setOtherCloudStartingLocation(OtherCloudDiscoveryStartingLocation value)

public DiscoveryConfig.Builder setOtherCloudStartingLocation(OtherCloudDiscoveryStartingLocation value)

Must be set only when scanning other clouds.

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

Parameter
Name Description
value OtherCloudDiscoveryStartingLocation
Returns
Type Description
DiscoveryConfig.Builder

setOtherCloudStartingLocation(OtherCloudDiscoveryStartingLocation.Builder builderForValue)

public DiscoveryConfig.Builder setOtherCloudStartingLocation(OtherCloudDiscoveryStartingLocation.Builder builderForValue)

Must be set only when scanning other clouds.

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

Parameter
Name Description
builderForValue OtherCloudDiscoveryStartingLocation.Builder
Returns
Type Description
DiscoveryConfig.Builder

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

public DiscoveryConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DiscoveryConfig.Builder
Overrides

setStatus(DiscoveryConfig.Status value)

public DiscoveryConfig.Builder setStatus(DiscoveryConfig.Status value)

Required. A status for this configuration.

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

Parameter
Name Description
value DiscoveryConfig.Status

The status to set.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

setStatusValue(int value)

public DiscoveryConfig.Builder setStatusValue(int value)

Required. A status for this configuration.

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

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.

Returns
Type Description
DiscoveryConfig.Builder

This builder for chaining.

setTargets(int index, DiscoveryTarget value)

public DiscoveryConfig.Builder setTargets(int index, DiscoveryTarget value)

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

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

Parameters
Name Description
index int
value DiscoveryTarget
Returns
Type Description
DiscoveryConfig.Builder

setTargets(int index, DiscoveryTarget.Builder builderForValue)

public DiscoveryConfig.Builder setTargets(int index, DiscoveryTarget.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue DiscoveryTarget.Builder
Returns
Type Description
DiscoveryConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final DiscoveryConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DiscoveryConfig.Builder
Overrides

setUpdateTime(Timestamp value)

public DiscoveryConfig.Builder setUpdateTime(Timestamp value)

Output only. The last update timestamp of a DiscoveryConfig.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
DiscoveryConfig.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DiscoveryConfig.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The last update timestamp of a DiscoveryConfig.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DiscoveryConfig.Builder