Package com.google.privacy.dlp.v2

Class ListDlpJobsRequest

  • All Implemented Interfaces:
    ListDlpJobsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListDlpJobsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListDlpJobsRequestOrBuilder
     The request message for listing DLP jobs.
    Protobuf type google.privacy.dlp.v2.ListDlpJobsRequest
    See Also:
    Serialized Form

    • 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

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface ListDlpJobsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface ListDlpJobsRequestOrBuilder
        Returns:
        The bytes for parent.

      • getFilter

        public 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;
        Specified by:
        getFilter in interface ListDlpJobsRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public 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;
        Specified by:
        getFilterBytes in interface ListDlpJobsRequestOrBuilder
        Returns:
        The bytes for filter.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         The standard list page token.
        string page_token = 3;
        Specified by:
        getPageTokenBytes in interface ListDlpJobsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getTypeValue

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

      • getOrderBy

        public 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;
        Specified by:
        getOrderBy in interface ListDlpJobsRequestOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public 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;
        Specified by:
        getOrderByBytes in interface ListDlpJobsRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • getLocationIdBytes

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

      • 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 ListDlpJobsRequest parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ListDlpJobsRequest> 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 ListDlpJobsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder