com.google.privacy.dlp.v2.ListDlpJobsRequestOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dlp-v2 Show documentation
Show all versions of proto-google-cloud-dlp-v2 Show documentation
PROTO library for proto-google-cloud-dlp-v2
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/privacy/dlp/v2/dlp.proto
// Protobuf Java Version: 3.25.4
package com.google.privacy.dlp.v2;
public interface ListDlpJobsRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.privacy.dlp.v2.ListDlpJobsRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Parent resource name.
*
* The format of this value varies depending on whether you have [specified a
* processing
* location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location):
*
* + Projects scope, location specified:
* `projects/{project_id}/locations/{location_id}`
* + Projects scope, no location specified (defaults to global):
* `projects/{project_id}`
*
* 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) = { ... }
*
*
* @return The parent.
*/
java.lang.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/sensitive-data-protection/docs/specifying-location):
*
* + Projects scope, location specified:
* `projects/{project_id}/locations/{location_id}`
* + Projects scope, no location specified (defaults to global):
* `projects/{project_id}`
*
* 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) = { ... }
*
*
* @return The bytes for parent.
*/
com.google.protobuf.ByteString getParentBytes();
/**
*
*
*
* 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;
*
* @return The filter.
*/
java.lang.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;
*
* @return The bytes for filter.
*/
com.google.protobuf.ByteString getFilterBytes();
/**
*
*
*
* The standard list page size.
*
*
* int32 page_size = 2;
*
* @return The pageSize.
*/
int getPageSize();
/**
*
*
*
* The standard list page token.
*
*
* string page_token = 3;
*
* @return The pageToken.
*/
java.lang.String getPageToken();
/**
*
*
*
* The standard list page token.
*
*
* string page_token = 3;
*
* @return The bytes for pageToken.
*/
com.google.protobuf.ByteString getPageTokenBytes();
/**
*
*
*
* The type of job. Defaults to `DlpJobType.INSPECT`
*
*
* .google.privacy.dlp.v2.DlpJobType type = 5;
*
* @return The enum numeric value on the wire for type.
*/
int getTypeValue();
/**
*
*
*
* The type of job. Defaults to `DlpJobType.INSPECT`
*
*
* .google.privacy.dlp.v2.DlpJobType type = 5;
*
* @return The type.
*/
com.google.privacy.dlp.v2.DlpJobType getType();
/**
*
*
*
* Comma-separated list of fields to order by,
* followed by `asc` or `desc` postfix. This list is case insensitive. The
* 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;
*
* @return The orderBy.
*/
java.lang.String getOrderBy();
/**
*
*
*
* Comma-separated list of fields to order by,
* followed by `asc` or `desc` postfix. This list is case insensitive. The
* 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;
*
* @return The bytes for orderBy.
*/
com.google.protobuf.ByteString getOrderByBytes();
/**
*
*
*
* Deprecated. This field has no effect.
*
*
* string location_id = 7;
*
* @return The locationId.
*/
java.lang.String getLocationId();
/**
*
*
*
* Deprecated. This field has no effect.
*
*
* string location_id = 7;
*
* @return The bytes for locationId.
*/
com.google.protobuf.ByteString getLocationIdBytes();
}