Package com.google.privacy.dlp.v2

Class DataProfileJobConfig.Builder

  • All Implemented Interfaces:
    DataProfileJobConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    DataProfileJobConfig
    public static final class DataProfileJobConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>
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

    • Method Detail

      • 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.Builder<DataProfileJobConfig.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public DataProfileJobConfig.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>

      • clearField

        public DataProfileJobConfig.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>

      • clearOneof

        public DataProfileJobConfig.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>

      • setRepeatedField

        public DataProfileJobConfig.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>

      • addRepeatedField

        public DataProfileJobConfig.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>

      • isInitialized

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

      • mergeFrom

        public DataProfileJobConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<DataProfileJobConfig.Builder>
        Throws:
        IOException

      • 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.

      • clearLocation

        public DataProfileJobConfig.Builder clearLocation()
         The data to scan.
        .google.privacy.dlp.v2.DataProfileLocation location = 1;

      • getLocationBuilder

        public DataProfileLocation.Builder getLocationBuilder()
         The data to scan.
        .google.privacy.dlp.v2.DataProfileLocation location = 1;

      • 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.

      • setProjectId

        public DataProfileJobConfig.Builder setProjectId​(String value)
         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;
        Parameters:
        value - The projectId to set.
        Returns:
        This builder for chaining.

      • clearProjectId

        public DataProfileJobConfig.Builder clearProjectId()
         The project that will run the scan. The DLP service
 account that exists within this project must have access to all resources
 that are profiled, and the Cloud DLP API must be enabled.
        string project_id = 5;
        Returns:
        This builder for chaining.

      • setProjectIdBytes

        public DataProfileJobConfig.Builder setProjectIdBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for projectId to set.
        Returns:
        This builder for chaining.

      • 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.

      • setInspectTemplates

        public DataProfileJobConfig.Builder setInspectTemplates​(int index,
                                                        String value)
         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;
        Parameters:
        index - The index to set the value at.
        value - The inspectTemplates to set.
        Returns:
        This builder for chaining.

      • addInspectTemplates

        public DataProfileJobConfig.Builder addInspectTemplates​(String value)
         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;
        Parameters:
        value - The inspectTemplates to add.
        Returns:
        This builder for chaining.

      • addAllInspectTemplates

        public DataProfileJobConfig.Builder addAllInspectTemplates​(Iterable<String> values)
         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;
        Parameters:
        values - The inspectTemplates to add.
        Returns:
        This builder for chaining.

      • clearInspectTemplates

        public DataProfileJobConfig.Builder clearInspectTemplates()
         Detection logic for profile generation.

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

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

 For more information, see
 https://cloud.google.com/dlp/docs/data-profiles#data_residency.
        repeated string inspect_templates = 7;
        Returns:
        This builder for chaining.

      • addInspectTemplatesBytes

        public DataProfileJobConfig.Builder addInspectTemplatesBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes of the inspectTemplates to add.
        Returns:
        This builder for chaining.

      • 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

      • setDataProfileActions

        public DataProfileJobConfig.Builder setDataProfileActions​(int index,
                                                          DataProfileAction value)
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • setDataProfileActions

        public DataProfileJobConfig.Builder setDataProfileActions​(int index,
                                                          DataProfileAction.Builder builderForValue)
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • addDataProfileActions

        public DataProfileJobConfig.Builder addDataProfileActions​(DataProfileAction value)
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • addDataProfileActions

        public DataProfileJobConfig.Builder addDataProfileActions​(int index,
                                                          DataProfileAction value)
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • addDataProfileActions

        public DataProfileJobConfig.Builder addDataProfileActions​(int index,
                                                          DataProfileAction.Builder builderForValue)
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • clearDataProfileActions

        public DataProfileJobConfig.Builder clearDataProfileActions()
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • removeDataProfileActions

        public DataProfileJobConfig.Builder removeDataProfileActions​(int index)
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • getDataProfileActionsBuilder

        public DataProfileAction.Builder getDataProfileActionsBuilder​(int index)
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • addDataProfileActionsBuilder

        public DataProfileAction.Builder addDataProfileActionsBuilder()
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • addDataProfileActionsBuilder

        public DataProfileAction.Builder addDataProfileActionsBuilder​(int index)
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • getDataProfileActionsBuilderList

        public List<DataProfileAction.Builder> getDataProfileActionsBuilderList()
         Actions to execute at the completion of the job.
        repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;

      • setUnknownFields

        public final DataProfileJobConfig.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>

      • mergeUnknownFields

        public final DataProfileJobConfig.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<DataProfileJobConfig.Builder>