Package com.google.privacy.dlp.v2

Class DataProfileJobConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.privacy.dlp.v2.DataProfileJobConfig
All Implemented Interfaces:
DataProfileJobConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataProfileJobConfig extends com.google.protobuf.GeneratedMessage 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/sensitive-data-protection/docs/data-profiles#retention).
Protobuf type google.privacy.dlp.v2.DataProfileJobConfig
See Also:

  • Field Details

    • LOCATION_FIELD_NUMBER

      public static final int LOCATION_FIELD_NUMBER
      See Also:

    • PROJECT_ID_FIELD_NUMBER

      public static final int PROJECT_ID_FIELD_NUMBER
      See Also:

    • OTHER_CLOUD_STARTING_LOCATION_FIELD_NUMBER

      public static final int OTHER_CLOUD_STARTING_LOCATION_FIELD_NUMBER
      See Also:

    • INSPECT_TEMPLATES_FIELD_NUMBER

      public static final int INSPECT_TEMPLATES_FIELD_NUMBER
      See Also:

    • DATA_PROFILE_ACTIONS_FIELD_NUMBER

      public static final int DATA_PROFILE_ACTIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

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

    • getLocation

      public DataProfileLocation getLocation()
       The data to scan.
      .google.privacy.dlp.v2.DataProfileLocation location = 1;
      Specified by:
      getLocation in interface DataProfileJobConfigOrBuilder
      Returns:
      The location.

    • getLocationOrBuilder

      public DataProfileLocationOrBuilder getLocationOrBuilder()
       The data to scan.
      .google.privacy.dlp.v2.DataProfileLocation location = 1;
      Specified by:
      getLocationOrBuilder in interface DataProfileJobConfigOrBuilder

    • 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 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 DLP API must be enabled.
      string project_id = 5;
      Specified by:
      getProjectIdBytes in interface DataProfileJobConfigOrBuilder
      Returns:
      The bytes for projectId.

    • hasOtherCloudStartingLocation

      public boolean hasOtherCloudStartingLocation()
       Must be set only when scanning other clouds.
      .google.privacy.dlp.v2.OtherCloudDiscoveryStartingLocation other_cloud_starting_location = 8;
      Specified by:
      hasOtherCloudStartingLocation in interface DataProfileJobConfigOrBuilder
      Returns:
      Whether the otherCloudStartingLocation field is set.

    • getOtherCloudStartingLocation

      public OtherCloudDiscoveryStartingLocation getOtherCloudStartingLocation()
       Must be set only when scanning other clouds.
      .google.privacy.dlp.v2.OtherCloudDiscoveryStartingLocation other_cloud_starting_location = 8;
      Specified by:
      getOtherCloudStartingLocation in interface DataProfileJobConfigOrBuilder
      Returns:
      The otherCloudStartingLocation.

    • getOtherCloudStartingLocationOrBuilder

      public OtherCloudDiscoveryStartingLocationOrBuilder getOtherCloudStartingLocationOrBuilder()
       Must be set only when scanning other clouds.
      .google.privacy.dlp.v2.OtherCloudDiscoveryStartingLocation other_cloud_starting_location = 8;
      Specified by:
      getOtherCloudStartingLocationOrBuilder in interface DataProfileJobConfigOrBuilder

    • 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/sensitive-data-protection/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/sensitive-data-protection/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/sensitive-data-protection/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/sensitive-data-protection/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.

    • getDataProfileActionsList

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

    • getDataProfileActionsOrBuilderList

      public List<? extends DataProfileActionOrBuilder> getDataProfileActionsOrBuilderList()
       Actions to execute at the completion of the job.
      repeated .google.privacy.dlp.v2.DataProfileAction data_profile_actions = 6;
      Specified by:
      getDataProfileActionsOrBuilderList in interface DataProfileJobConfigOrBuilder

    • 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

    • getDataProfileActions

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

    • getDataProfileActionsOrBuilder

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

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static DataProfileJobConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataProfileJobConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataProfileJobConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataProfileJobConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataProfileJobConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataProfileJobConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static DataProfileJobConfig.Builder newBuilder()

    • newBuilder

      public static DataProfileJobConfig.Builder newBuilder(DataProfileJobConfig prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataProfileJobConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DataProfileJobConfig> parser()

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

    • getDefaultInstanceForType

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