Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Interface FileStoreDataProfileOrBuilder (3.68.0)

public interface FileStoreDataProfileOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsResourceAttributes(String key)

public abstract boolean containsResourceAttributes(String key)

Attributes of the resource being profiled. Currently used attributes:

customer_managed_encryption: boolean
- true: the resource is encrypted with a customer-managed key.
- false: the resource is encrypted with a provider-managed key.

map<string, .google.privacy.dlp.v2.Value> resource_attributes = 17;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

containsResourceLabels(String key)

public abstract boolean containsResourceLabels(String key)

The labels applied to the resource at the time the profile was generated.

map<string, string> resource_labels = 18;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getConfigSnapshot()

public abstract DataProfileConfigSnapshot getConfigSnapshot()

The snapshot of the configurations used to generate the profile.

.google.privacy.dlp.v2.DataProfileConfigSnapshot config_snapshot = 7;

Returns
Type	Description
`DataProfileConfigSnapshot`	The configSnapshot.

getConfigSnapshotOrBuilder()

public abstract DataProfileConfigSnapshotOrBuilder getConfigSnapshotOrBuilder()

The snapshot of the configurations used to generate the profile.

.google.privacy.dlp.v2.DataProfileConfigSnapshot config_snapshot = 7;

Returns
Type	Description
`DataProfileConfigSnapshotOrBuilder`

getCreateTime()

public abstract Timestamp getCreateTime()

The time the file store was first created.

.google.protobuf.Timestamp create_time = 14;

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

The time the file store was first created.

.google.protobuf.Timestamp create_time = 14;

Returns
Type	Description
`TimestampOrBuilder`

getDataRiskLevel()

public abstract DataRiskLevel getDataRiskLevel()

The data risk level of this resource.

.google.privacy.dlp.v2.DataRiskLevel data_risk_level = 13;

Returns
Type	Description
`DataRiskLevel`	The dataRiskLevel.

getDataRiskLevelOrBuilder()

public abstract DataRiskLevelOrBuilder getDataRiskLevelOrBuilder()

The data risk level of this resource.

.google.privacy.dlp.v2.DataRiskLevel data_risk_level = 13;

Returns
Type	Description
`DataRiskLevelOrBuilder`

getDataSourceType()

public abstract DataSourceType getDataSourceType()

The resource type that was profiled.

.google.privacy.dlp.v2.DataSourceType data_source_type = 2;

Returns
Type	Description
`DataSourceType`	The dataSourceType.

getDataSourceTypeOrBuilder()

public abstract DataSourceTypeOrBuilder getDataSourceTypeOrBuilder()

The resource type that was profiled.

.google.privacy.dlp.v2.DataSourceType data_source_type = 2;

Returns
Type	Description
`DataSourceTypeOrBuilder`

getDataStorageLocations(int index)

public abstract String getDataStorageLocations(int index)

For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. file_store_location will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile.

repeated string data_storage_locations = 19;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The dataStorageLocations at the given index.

getDataStorageLocationsBytes(int index)

public abstract ByteString getDataStorageLocationsBytes(int index)

repeated string data_storage_locations = 19;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the dataStorageLocations at the given index.

getDataStorageLocationsCount()

public abstract int getDataStorageLocationsCount()

repeated string data_storage_locations = 19;

Returns
Type	Description
`int`	The count of dataStorageLocations.

getDataStorageLocationsList()

public abstract List<String> getDataStorageLocationsList()

repeated string data_storage_locations = 19;

Returns
Type	Description
`List<String>`	A list containing the dataStorageLocations.

getFileClusterSummaries(int index)

public abstract FileClusterSummary getFileClusterSummaries(int index)

FileClusterSummary per each cluster.

repeated .google.privacy.dlp.v2.FileClusterSummary file_cluster_summaries = 16;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`FileClusterSummary`

getFileClusterSummariesCount()

public abstract int getFileClusterSummariesCount()

FileClusterSummary per each cluster.

repeated .google.privacy.dlp.v2.FileClusterSummary file_cluster_summaries = 16;

Returns
Type	Description
`int`

getFileClusterSummariesList()

public abstract List<FileClusterSummary> getFileClusterSummariesList()

FileClusterSummary per each cluster.

repeated .google.privacy.dlp.v2.FileClusterSummary file_cluster_summaries = 16;

Returns
Type	Description
`List<FileClusterSummary>`

getFileClusterSummariesOrBuilder(int index)

public abstract FileClusterSummaryOrBuilder getFileClusterSummariesOrBuilder(int index)

FileClusterSummary per each cluster.

repeated .google.privacy.dlp.v2.FileClusterSummary file_cluster_summaries = 16;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`FileClusterSummaryOrBuilder`

getFileClusterSummariesOrBuilderList()

public abstract List<? extends FileClusterSummaryOrBuilder> getFileClusterSummariesOrBuilderList()

FileClusterSummary per each cluster.

repeated .google.privacy.dlp.v2.FileClusterSummary file_cluster_summaries = 16;

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

getFileStoreInfoTypeSummaries(int index)

public abstract FileStoreInfoTypeSummary getFileStoreInfoTypeSummaries(int index)

InfoTypes detected in this file store.

repeated .google.privacy.dlp.v2.FileStoreInfoTypeSummary file_store_info_type_summaries = 21;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`FileStoreInfoTypeSummary`

getFileStoreInfoTypeSummariesCount()

public abstract int getFileStoreInfoTypeSummariesCount()

InfoTypes detected in this file store.

repeated .google.privacy.dlp.v2.FileStoreInfoTypeSummary file_store_info_type_summaries = 21;

Returns
Type	Description
`int`

getFileStoreInfoTypeSummariesList()

public abstract List<FileStoreInfoTypeSummary> getFileStoreInfoTypeSummariesList()

InfoTypes detected in this file store.

repeated .google.privacy.dlp.v2.FileStoreInfoTypeSummary file_store_info_type_summaries = 21;

Returns
Type	Description
`List<FileStoreInfoTypeSummary>`

getFileStoreInfoTypeSummariesOrBuilder(int index)

public abstract FileStoreInfoTypeSummaryOrBuilder getFileStoreInfoTypeSummariesOrBuilder(int index)

InfoTypes detected in this file store.

repeated .google.privacy.dlp.v2.FileStoreInfoTypeSummary file_store_info_type_summaries = 21;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`FileStoreInfoTypeSummaryOrBuilder`

getFileStoreInfoTypeSummariesOrBuilderList()

public abstract List<? extends FileStoreInfoTypeSummaryOrBuilder> getFileStoreInfoTypeSummariesOrBuilderList()

InfoTypes detected in this file store.

repeated .google.privacy.dlp.v2.FileStoreInfoTypeSummary file_store_info_type_summaries = 21;

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

getFileStoreIsEmpty()

public abstract boolean getFileStoreIsEmpty()

The file store does not have any files. If the profiling operation failed, this is false.

bool file_store_is_empty = 23;

Returns
Type	Description
`boolean`	The fileStoreIsEmpty.

getFileStoreLocation()

public abstract String getFileStoreLocation()

The location of the file store.

Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations
Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints

string file_store_location = 5;

Returns
Type	Description
`String`	The fileStoreLocation.

getFileStoreLocationBytes()

public abstract ByteString getFileStoreLocationBytes()

The location of the file store.

Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations
Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints

string file_store_location = 5;

Returns
Type	Description
`ByteString`	The bytes for fileStoreLocation.

getFileStorePath()

public abstract String getFileStorePath()

The file store path.

Cloud Storage: gs://{bucket}
Amazon S3: s3://{bucket}
Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}

string file_store_path = 6;

Returns
Type	Description
`String`	The fileStorePath.

getFileStorePathBytes()

public abstract ByteString getFileStorePathBytes()

The file store path.

Cloud Storage: gs://{bucket}
Amazon S3: s3://{bucket}
Vertex AI dataset: projects/{project_number}/locations/{location}/datasets/{dataset_id}

string file_store_path = 6;

Returns
Type	Description
`ByteString`	The bytes for fileStorePath.

getFullResource()

public abstract String getFullResource()

The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name

Example format of an S3 bucket full resource name: //cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}

string full_resource = 24;

Returns
Type	Description
`String`	The fullResource.

getFullResourceBytes()

public abstract ByteString getFullResourceBytes()

The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name

Example format of an S3 bucket full resource name: //cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}

string full_resource = 24;

Returns
Type	Description
`ByteString`	The bytes for fullResource.

getLastModifiedTime()

public abstract Timestamp getLastModifiedTime()

The time the file store was last modified.

.google.protobuf.Timestamp last_modified_time = 15;

Returns
Type	Description
`Timestamp`	The lastModifiedTime.

getLastModifiedTimeOrBuilder()

public abstract TimestampOrBuilder getLastModifiedTimeOrBuilder()

The time the file store was last modified.

.google.protobuf.Timestamp last_modified_time = 15;

Returns
Type	Description
`TimestampOrBuilder`

getLocationType()

public abstract String getLocationType()

The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.

string location_type = 20;

Returns
Type	Description
`String`	The locationType.

getLocationTypeBytes()

public abstract ByteString getLocationTypeBytes()

The location type of the file store (region, dual-region, multi-region, etc). If dual-region, expect data_storage_locations to be populated.

string location_type = 20;

Returns
Type	Description
`ByteString`	The bytes for locationType.

getName()

public abstract String getName()

The name of the profile.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of the profile.

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

getProfileLastGenerated()

public abstract Timestamp getProfileLastGenerated()

The last time the profile was generated.

.google.protobuf.Timestamp profile_last_generated = 10;

Returns
Type	Description
`Timestamp`	The profileLastGenerated.

getProfileLastGeneratedOrBuilder()

public abstract TimestampOrBuilder getProfileLastGeneratedOrBuilder()

The last time the profile was generated.

.google.protobuf.Timestamp profile_last_generated = 10;

Returns
Type	Description
`TimestampOrBuilder`

getProfileStatus()

public abstract ProfileStatus getProfileStatus()

Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

.google.privacy.dlp.v2.ProfileStatus profile_status = 8;

Returns
Type	Description
`ProfileStatus`	The profileStatus.

getProfileStatusOrBuilder()

public abstract ProfileStatusOrBuilder getProfileStatusOrBuilder()

Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

.google.privacy.dlp.v2.ProfileStatus profile_status = 8;

Returns
Type	Description
`ProfileStatusOrBuilder`

getProjectDataProfile()

public abstract String getProjectDataProfile()

The resource name of the project data profile for this file store.

string project_data_profile = 3;

Returns
Type	Description
`String`	The projectDataProfile.

getProjectDataProfileBytes()

public abstract ByteString getProjectDataProfileBytes()

The resource name of the project data profile for this file store.

string project_data_profile = 3;

Returns
Type	Description
`ByteString`	The bytes for projectDataProfile.

getProjectId()

public abstract String getProjectId()

The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.

string project_id = 4;

Returns
Type	Description
`String`	The projectId.

getProjectIdBytes()

public abstract ByteString getProjectIdBytes()

The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.

string project_id = 4;

Returns
Type	Description
`ByteString`	The bytes for projectId.

getRelatedResources(int index)

public abstract RelatedResource getRelatedResources(int index)

Resources related to this profile.

repeated .google.privacy.dlp.v2.RelatedResource related_resources = 26;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RelatedResource`

getRelatedResourcesCount()

public abstract int getRelatedResourcesCount()

Resources related to this profile.

repeated .google.privacy.dlp.v2.RelatedResource related_resources = 26;

Returns
Type	Description
`int`

getRelatedResourcesList()

public abstract List<RelatedResource> getRelatedResourcesList()

Resources related to this profile.

repeated .google.privacy.dlp.v2.RelatedResource related_resources = 26;

Returns
Type	Description
`List<RelatedResource>`

getRelatedResourcesOrBuilder(int index)

public abstract RelatedResourceOrBuilder getRelatedResourcesOrBuilder(int index)

Resources related to this profile.

repeated .google.privacy.dlp.v2.RelatedResource related_resources = 26;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RelatedResourceOrBuilder`

getRelatedResourcesOrBuilderList()

public abstract List<? extends RelatedResourceOrBuilder> getRelatedResourcesOrBuilderList()

Resources related to this profile.

repeated .google.privacy.dlp.v2.RelatedResource related_resources = 26;

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

getResourceAttributes() (deprecated)

public abstract Map<String,Value> getResourceAttributes()

Use #getResourceAttributesMap() instead.

Returns
Type	Description
`Map<String,Value>`

getResourceAttributesCount()

public abstract int getResourceAttributesCount()

Attributes of the resource being profiled. Currently used attributes:

customer_managed_encryption: boolean
- true: the resource is encrypted with a customer-managed key.
- false: the resource is encrypted with a provider-managed key.

map<string, .google.privacy.dlp.v2.Value> resource_attributes = 17;

Returns
Type	Description
`int`

getResourceAttributesMap()

public abstract Map<String,Value> getResourceAttributesMap()

Attributes of the resource being profiled. Currently used attributes:

customer_managed_encryption: boolean
- true: the resource is encrypted with a customer-managed key.
- false: the resource is encrypted with a provider-managed key.

map<string, .google.privacy.dlp.v2.Value> resource_attributes = 17;

Returns
Type	Description
`Map<String,Value>`

getResourceAttributesOrDefault(String key, Value defaultValue)

public abstract Value getResourceAttributesOrDefault(String key, Value defaultValue)

Attributes of the resource being profiled. Currently used attributes:

customer_managed_encryption: boolean
- true: the resource is encrypted with a customer-managed key.
- false: the resource is encrypted with a provider-managed key.

map<string, .google.privacy.dlp.v2.Value> resource_attributes = 17;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`Value`

Returns
Type	Description
`Value`

getResourceAttributesOrThrow(String key)

public abstract Value getResourceAttributesOrThrow(String key)

Attributes of the resource being profiled. Currently used attributes:

customer_managed_encryption: boolean
- true: the resource is encrypted with a customer-managed key.
- false: the resource is encrypted with a provider-managed key.

map<string, .google.privacy.dlp.v2.Value> resource_attributes = 17;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Value`

getResourceLabels() (deprecated)

public abstract Map<String,String> getResourceLabels()

Use #getResourceLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getResourceLabelsCount()

public abstract int getResourceLabelsCount()

The labels applied to the resource at the time the profile was generated.

map<string, string> resource_labels = 18;

Returns
Type	Description
`int`

getResourceLabelsMap()

public abstract Map<String,String> getResourceLabelsMap()

The labels applied to the resource at the time the profile was generated.

map<string, string> resource_labels = 18;

Returns
Type	Description
`Map<String,String>`

getResourceLabelsOrDefault(String key, String defaultValue)

public abstract String getResourceLabelsOrDefault(String key, String defaultValue)

The labels applied to the resource at the time the profile was generated.

map<string, string> resource_labels = 18;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getResourceLabelsOrThrow(String key)

public abstract String getResourceLabelsOrThrow(String key)

The labels applied to the resource at the time the profile was generated.

map<string, string> resource_labels = 18;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getResourceVisibility()

public abstract ResourceVisibility getResourceVisibility()

How broadly a resource has been shared.

.google.privacy.dlp.v2.ResourceVisibility resource_visibility = 11;

Returns
Type	Description
`ResourceVisibility`	The resourceVisibility.

getResourceVisibilityValue()

public abstract int getResourceVisibilityValue()

How broadly a resource has been shared.

.google.privacy.dlp.v2.ResourceVisibility resource_visibility = 11;

Returns
Type	Description
`int`	The enum numeric value on the wire for resourceVisibility.

getSampleFindingsTable()

public abstract BigQueryTable getSampleFindingsTable()

The BigQuery table to which the sample findings are written.

.google.privacy.dlp.v2.BigQueryTable sample_findings_table = 22;

Returns
Type	Description
`BigQueryTable`	The sampleFindingsTable.

getSampleFindingsTableOrBuilder()

public abstract BigQueryTableOrBuilder getSampleFindingsTableOrBuilder()

The BigQuery table to which the sample findings are written.

.google.privacy.dlp.v2.BigQueryTable sample_findings_table = 22;

Returns
Type	Description
`BigQueryTableOrBuilder`

getSensitivityScore()

public abstract SensitivityScore getSensitivityScore()

The sensitivity score of this resource.

.google.privacy.dlp.v2.SensitivityScore sensitivity_score = 12;

Returns
Type	Description
`SensitivityScore`	The sensitivityScore.

getSensitivityScoreOrBuilder()

public abstract SensitivityScoreOrBuilder getSensitivityScoreOrBuilder()

The sensitivity score of this resource.

.google.privacy.dlp.v2.SensitivityScore sensitivity_score = 12;

Returns
Type	Description
`SensitivityScoreOrBuilder`

getState()

public abstract FileStoreDataProfile.State getState()

State of a profile.

.google.privacy.dlp.v2.FileStoreDataProfile.State state = 9;

Returns
Type	Description
`FileStoreDataProfile.State`	The state.

getStateValue()

public abstract int getStateValue()

State of a profile.

.google.privacy.dlp.v2.FileStoreDataProfile.State state = 9;

Returns
Type	Description
`int`	The enum numeric value on the wire for state.

getTags(int index)

public abstract Tag getTags(int index)

The tags attached to the resource, including any tags attached during profiling.

repeated .google.privacy.dlp.v2.Tag tags = 25;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Tag`

getTagsCount()

public abstract int getTagsCount()

The tags attached to the resource, including any tags attached during profiling.

repeated .google.privacy.dlp.v2.Tag tags = 25;

Returns
Type	Description
`int`

getTagsList()

public abstract List<Tag> getTagsList()

The tags attached to the resource, including any tags attached during profiling.

repeated .google.privacy.dlp.v2.Tag tags = 25;

Returns
Type	Description
`List<Tag>`

getTagsOrBuilder(int index)

public abstract TagOrBuilder getTagsOrBuilder(int index)

The tags attached to the resource, including any tags attached during profiling.

repeated .google.privacy.dlp.v2.Tag tags = 25;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`TagOrBuilder`

getTagsOrBuilderList()

public abstract List<? extends TagOrBuilder> getTagsOrBuilderList()

The tags attached to the resource, including any tags attached during profiling.

repeated .google.privacy.dlp.v2.Tag tags = 25;

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

hasConfigSnapshot()

public abstract boolean hasConfigSnapshot()

The snapshot of the configurations used to generate the profile.

.google.privacy.dlp.v2.DataProfileConfigSnapshot config_snapshot = 7;

Returns
Type	Description
`boolean`	Whether the configSnapshot field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

The time the file store was first created.

.google.protobuf.Timestamp create_time = 14;

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasDataRiskLevel()

public abstract boolean hasDataRiskLevel()

The data risk level of this resource.

.google.privacy.dlp.v2.DataRiskLevel data_risk_level = 13;

Returns
Type	Description
`boolean`	Whether the dataRiskLevel field is set.

hasDataSourceType()

public abstract boolean hasDataSourceType()

The resource type that was profiled.

.google.privacy.dlp.v2.DataSourceType data_source_type = 2;

Returns
Type	Description
`boolean`	Whether the dataSourceType field is set.

hasLastModifiedTime()

public abstract boolean hasLastModifiedTime()

The time the file store was last modified.

.google.protobuf.Timestamp last_modified_time = 15;

Returns
Type	Description
`boolean`	Whether the lastModifiedTime field is set.

hasProfileLastGenerated()

public abstract boolean hasProfileLastGenerated()

The last time the profile was generated.

.google.protobuf.Timestamp profile_last_generated = 10;

Returns
Type	Description
`boolean`	Whether the profileLastGenerated field is set.

hasProfileStatus()

public abstract boolean hasProfileStatus()

Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated.

.google.privacy.dlp.v2.ProfileStatus profile_status = 8;

Returns
Type	Description
`boolean`	Whether the profileStatus field is set.

hasSampleFindingsTable()

public abstract boolean hasSampleFindingsTable()

The BigQuery table to which the sample findings are written.

.google.privacy.dlp.v2.BigQueryTable sample_findings_table = 22;

Returns
Type	Description
`boolean`	Whether the sampleFindingsTable field is set.

hasSensitivityScore()

public abstract boolean hasSensitivityScore()

The sensitivity score of this resource.

.google.privacy.dlp.v2.SensitivityScore sensitivity_score = 12;

Returns
Type	Description
`boolean`	Whether the sensitivityScore field is set.