Package com.google.privacy.dlp.v2

Class DataProfileJobConfig

  • All Implemented Interfaces:
    DataProfileJobConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class DataProfileJobConfig
extends com.google.protobuf.GeneratedMessageV3
implements DataProfileJobConfigOrBuilder
     Configuration for setting up a job to scan resources for profile generation.
 Only one data profile configuration may exist per organization, folder,
 or project.

 The generated data profiles are retained according to the
 [data retention policy]
 (https://cloud.google.com/dlp/docs/data-profiles#retention).
    Protobuf type google.privacy.dlp.v2.DataProfileJobConfig
    See Also:
    Serialized Form

    • Field Detail

      • PROJECT_ID_FIELD_NUMBER

        public static final int PROJECT_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INSPECT_TEMPLATES_FIELD_NUMBER

        public static final int INSPECT_TEMPLATES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DATA_PROFILE_ACTIONS_FIELD_NUMBER

        public static final int DATA_PROFILE_ACTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasLocation

        public boolean hasLocation()
         The data to scan.
        .google.privacy.dlp.v2.DataProfileLocation location = 1;
        Specified by:
        hasLocation in interface DataProfileJobConfigOrBuilder
        Returns:
        Whether the location field is set.

      • getProjectId

        public String getProjectId()
         The project that will run the scan. The DLP service
 account that exists within this project must have access to all resources
 that are profiled, and the Cloud DLP API must be enabled.
        string project_id = 5;
        Specified by:
        getProjectId in interface DataProfileJobConfigOrBuilder
        Returns:
        The projectId.

      • getProjectIdBytes

        public com.google.protobuf.ByteString getProjectIdBytes()
         The project that will run the scan. The DLP service
 account that exists within this project must have access to all resources
 that are profiled, and the Cloud DLP API must be enabled.
        string project_id = 5;
        Specified by:
        getProjectIdBytes in interface DataProfileJobConfigOrBuilder
        Returns:
        The bytes for projectId.

      • getInspectTemplatesList

        public com.google.protobuf.ProtocolStringList getInspectTemplatesList()
         Detection logic for profile generation.

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

 Multiple templates may be provided if there is data in multiple regions.
 At most one template must be specified per-region (including "global").
 Each region is scanned using the applicable template. If no region-specific
 template is specified, but a "global" template is specified, it will be
 copied to that region and used instead. If no global or region-specific
 template is provided for a region with data, that region's data will not be
 scanned.

 For more information, see
 https://cloud.google.com/dlp/docs/data-profiles#data_residency.
        repeated string inspect_templates = 7;
        Specified by:
        getInspectTemplatesList in interface DataProfileJobConfigOrBuilder
        Returns:
        A list containing the inspectTemplates.

      • getInspectTemplatesCount

        public int getInspectTemplatesCount()
         Detection logic for profile generation.

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

 Multiple templates may be provided if there is data in multiple regions.
 At most one template must be specified per-region (including "global").
 Each region is scanned using the applicable template. If no region-specific
 template is specified, but a "global" template is specified, it will be
 copied to that region and used instead. If no global or region-specific
 template is provided for a region with data, that region's data will not be
 scanned.

 For more information, see
 https://cloud.google.com/dlp/docs/data-profiles#data_residency.
        repeated string inspect_templates = 7;
        Specified by:
        getInspectTemplatesCount in interface DataProfileJobConfigOrBuilder
        Returns:
        The count of inspectTemplates.

      • getInspectTemplates

        public String getInspectTemplates​(int index)
         Detection logic for profile generation.

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

 Multiple templates may be provided if there is data in multiple regions.
 At most one template must be specified per-region (including "global").
 Each region is scanned using the applicable template. If no region-specific
 template is specified, but a "global" template is specified, it will be
 copied to that region and used instead. If no global or region-specific
 template is provided for a region with data, that region's data will not be
 scanned.

 For more information, see
 https://cloud.google.com/dlp/docs/data-profiles#data_residency.
        repeated string inspect_templates = 7;
        Specified by:
        getInspectTemplates in interface DataProfileJobConfigOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The inspectTemplates at the given index.

      • getInspectTemplatesBytes

        public com.google.protobuf.ByteString getInspectTemplatesBytes​(int index)
         Detection logic for profile generation.

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

 Multiple templates may be provided if there is data in multiple regions.
 At most one template must be specified per-region (including "global").
 Each region is scanned using the applicable template. If no region-specific
 template is specified, but a "global" template is specified, it will be
 copied to that region and used instead. If no global or region-specific
 template is provided for a region with data, that region's data will not be
 scanned.

 For more information, see
 https://cloud.google.com/dlp/docs/data-profiles#data_residency.
        repeated string inspect_templates = 7;
        Specified by:
        getInspectTemplatesBytes in interface DataProfileJobConfigOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the inspectTemplates at the given index.

      • getDataProfileActionsCount

        public int getDataProfileActionsCount()
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;
        Specified by:
        getDataProfileActionsCount in interface DataProfileJobConfigOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static DataProfileJobConfig parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataProfileJobConfig parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataProfileJobConfig parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataProfileJobConfig parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataProfileJobConfig parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static DataProfileJobConfig parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public DataProfileJobConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public DataProfileJobConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected DataProfileJobConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<DataProfileJobConfig> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public DataProfileJobConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder