Package com.google.privacy.dlp.v2

Interface ListDlpJobsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListDlpJobsRequest, ListDlpJobsRequest.Builder
    public interface ListDlpJobsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Allows filtering.
      com.google.protobuf.ByteString getFilterBytes()
      Allows filtering.
      String getLocationId()
      Deprecated.
      com.google.protobuf.ByteString getLocationIdBytes()
      Deprecated.
      String getOrderBy()
      Comma separated list of fields to order by, followed by `asc` or `desc` postfix.
      com.google.protobuf.ByteString getOrderByBytes()
      Comma separated list of fields to order by, followed by `asc` or `desc` postfix.
      int getPageSize()
      The standard list page size.
      String getPageToken()
      The standard list page token.
      com.google.protobuf.ByteString getPageTokenBytes()
      The standard list page token.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      DlpJobType getType()
      The type of job.
      int getTypeValue()
      The type of job.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. Parent resource name.

 The format of this value varies depending on whether you have [specified a
 processing
 location](https://cloud.google.com/dlp/docs/specifying-location):

 + Projects scope, location specified:<br/>
   `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
 + Projects scope, no location specified (defaults to global):<br/>
   `projects/`<var>PROJECT_ID</var>

 The following example `parent` string specifies a parent project with the
 identifier `example-project`, and specifies the `europe-west3` location
 for processing data:

     parent=projects/example-project/locations/europe-west3
        string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. Parent resource name.

 The format of this value varies depending on whether you have [specified a
 processing
 location](https://cloud.google.com/dlp/docs/specifying-location):

 + Projects scope, location specified:<br/>
   `projects/`<var>PROJECT_ID</var>`/locations/`<var>LOCATION_ID</var>
 + Projects scope, no location specified (defaults to global):<br/>
   `projects/`<var>PROJECT_ID</var>

 The following example `parent` string specifies a parent project with the
 identifier `example-project`, and specifies the `europe-west3` location
 for processing data:

     parent=projects/example-project/locations/europe-west3
        string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getFilter

        String getFilter()
         Allows filtering.

 Supported syntax:

 * Filter expressions are made up of one or more restrictions.
 * Restrictions can be combined by `AND` or `OR` logical operators. A
 sequence of restrictions implicitly uses `AND`.
 * A restriction has the form of `{field} {operator} {value}`.
 * Supported fields/values for inspect jobs:
     - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED
     - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
     - `trigger_name` - The name of the trigger that created the job.
     - 'end_time` - Corresponds to the time the job finished.
     - 'start_time` - Corresponds to the time the job finished.
 * Supported fields for risk analysis jobs:
     - `state` - RUNNING|CANCELED|FINISHED|FAILED
     - 'end_time` - Corresponds to the time the job finished.
     - 'start_time` - Corresponds to the time the job finished.
 * The operator must be `=` or `!=`.

 Examples:

 * inspected_storage = cloud_storage AND state = done
 * inspected_storage = cloud_storage OR inspected_storage = bigquery
 * inspected_storage = cloud_storage AND (state = done OR state = canceled)
 * end_time > \"2017-12-12T00:00:00+00:00\"

 The length of this field should be no more than 500 characters.
        string filter = 1;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         Allows filtering.

 Supported syntax:

 * Filter expressions are made up of one or more restrictions.
 * Restrictions can be combined by `AND` or `OR` logical operators. A
 sequence of restrictions implicitly uses `AND`.
 * A restriction has the form of `{field} {operator} {value}`.
 * Supported fields/values for inspect jobs:
     - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED
     - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY
     - `trigger_name` - The name of the trigger that created the job.
     - 'end_time` - Corresponds to the time the job finished.
     - 'start_time` - Corresponds to the time the job finished.
 * Supported fields for risk analysis jobs:
     - `state` - RUNNING|CANCELED|FINISHED|FAILED
     - 'end_time` - Corresponds to the time the job finished.
     - 'start_time` - Corresponds to the time the job finished.
 * The operator must be `=` or `!=`.

 Examples:

 * inspected_storage = cloud_storage AND state = done
 * inspected_storage = cloud_storage OR inspected_storage = bigquery
 * inspected_storage = cloud_storage AND (state = done OR state = canceled)
 * end_time > \"2017-12-12T00:00:00+00:00\"

 The length of this field should be no more than 500 characters.
        string filter = 1;
        Returns:
        The bytes for filter.

      • getPageSize

        int getPageSize()
         The standard list page size.
        int32 page_size = 2;
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         The standard list page token.
        string page_token = 3;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         The standard list page token.
        string page_token = 3;
        Returns:
        The bytes for pageToken.

      • getTypeValue

        int getTypeValue()
         The type of job. Defaults to `DlpJobType.INSPECT`
        .google.privacy.dlp.v2.DlpJobType type = 5;
        Returns:
        The enum numeric value on the wire for type.

      • getType

        DlpJobType getType()
         The type of job. Defaults to `DlpJobType.INSPECT`
        .google.privacy.dlp.v2.DlpJobType type = 5;
        Returns:
        The type.

      • getOrderBy

        String getOrderBy()
         Comma separated list of fields to order by,
 followed by `asc` or `desc` postfix. This list is case-insensitive,
 default sorting order is ascending, redundant space characters are
 insignificant.

 Example: `name asc, end_time asc, create_time desc`

 Supported fields are:

 - `create_time`: corresponds to the time the job was created.
 - `end_time`: corresponds to the time the job ended.
 - `name`: corresponds to the job's name.
 - `state`: corresponds to `state`
        string order_by = 6;
        Returns:
        The orderBy.

      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         Comma separated list of fields to order by,
 followed by `asc` or `desc` postfix. This list is case-insensitive,
 default sorting order is ascending, redundant space characters are
 insignificant.

 Example: `name asc, end_time asc, create_time desc`

 Supported fields are:

 - `create_time`: corresponds to the time the job was created.
 - `end_time`: corresponds to the time the job ended.
 - `name`: corresponds to the job's name.
 - `state`: corresponds to `state`
        string order_by = 6;
        Returns:
        The bytes for orderBy.

      • getLocationId

        String getLocationId()
         Deprecated. This field has no effect.
        string location_id = 7;
        Returns:
        The locationId.

      • getLocationIdBytes

        com.google.protobuf.ByteString getLocationIdBytes()
         Deprecated. This field has no effect.
        string location_id = 7;
        Returns:
        The bytes for locationId.