suguo
/
googleapis
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Synchronize new proto/yaml changes. 

PiperOrigin-RevId: 195685034
This commit is contained in:
Google APIs 2018-05-07 10:45:54 -07:00 committed by Copybara-Service
parent 9d30023953
commit a24627df1d
10 changed files with 0 additions and 5391 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
google/privacy/dlp/artman_dlp_v2beta1.yaml
View File

@ -1,110 +0,0 @@
common:
api_name: dlp
api_version: v2beta1
organization_name: google-cloud
service_yaml: dlp.yaml
gapic_yaml: v2beta1/dlp_gapic.yaml
src_proto_paths:
- v2beta1
proto_deps:
- name: google-common-protos
artifacts:
- name: java_gapic
type: GAPIC
language: JAVA
publish_targets:
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/java/gapic-google-cloud-dlp-v2beta1
- name: grpc
dest: generated/java/grpc-google-cloud-dlp-v2beta1
- name: proto
dest: generated/java/proto-google-cloud-dlp-v2beta1
- name: java
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-java.git
directory_mappings:
- dest: google-cloud-dlp
- name: python_gapic
type: GAPIC
language: PYTHON
publish_targets:
- name: python
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-python.git
directory_mappings:
- src: .
dest: dlp
- name: grpc
src: google/cloud/proto
dest: dlp/google/cloud/proto
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/python/gapic-google-cloud-dlp-v2beta1
- name: grpc
dest: generated/python/proto-google-cloud-dlp-v2beta1
- name: php_gapic
type: GAPIC
language: PHP
publish_targets:
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/php/google-cloud-dlp-v2beta1
- name: ruby_gapic
type: GAPIC
language: RUBY
publish_targets:
- name: ruby
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-ruby.git
directory_mappings:
- src: lib/google/cloud/dlp/v2beta1
dest: google-cloud-dlp/lib/google/cloud/dlp/v2beta1
- src: test/google/cloud/privacy/dlp/v2beta1
dest: google-cloud-dlp/test/google/cloud/dlp/v2beta1
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/ruby/google-cloud-dlp
- name: go_gapic
type: GAPIC
language: GO
publish_targets:
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/go/vendor/cloud.google.com/go/google-cloud-dlp-v2beta1/vendor
- name: go
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-go.git
directory_mappings:
- dest: dlp/apiv2beta1
- name: nodejs_gapic
type: GAPIC
language: NODEJS
package_version:
grpc_dep_lower_bound: 0.0.0
publish_targets:
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/nodejs/dlp
- name: nodejs
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-node.git
directory_mappings:
- src: src/v2beta1
dest: packages/dlp/src/v2beta1
- src: test/test.js
dest: packages/dlp/test/gapic-v2beta1.js
- name: gapic_config
type: GAPIC_CONFIG

117
google/privacy/dlp/artman_dlp_v2beta2.yaml
View File

@ -1,117 +0,0 @@
common:
api_name: dlp
api_version: v2beta2
organization_name: google-cloud
proto_deps:
- name: google-common-protos
src_proto_paths:
- v2beta2
service_yaml: dlp_v2beta2.yaml
gapic_yaml: v2beta2/dlp_gapic.yaml
artifacts:
- name: gapic_config
type: GAPIC_CONFIG
- name: java_gapic
type: GAPIC
language: JAVA
publish_targets:
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/java/gapic-google-cloud-dlp-v2beta2
- name: grpc
dest: generated/java/grpc-google-cloud-dlp-v2beta2
- name: proto
dest: generated/java/proto-google-cloud-dlp-v2beta2
- name: java
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-java.git
directory_mappings:
- dest: google-cloud-dlp
- name: python_gapic
type: GAPIC
language: PYTHON
publish_targets:
- name: python
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-python.git
directory_mappings:
- src: google/cloud/gapic
dest: dlp/google/cloud/gapic
- src: test/google/cloud/gapic/dlp/v2beta2
dest: dlp/tests/gapic
- name: grpc
src: google/cloud/proto
dest: dlp/google/cloud/proto
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/python/gapic-google-cloud-dlp-v2beta2
- name: grpc
dest: generated/python/proto-google-cloud-dlp-v2beta2
- name: nodejs_gapic
type: GAPIC
language: NODEJS
package_version:
grpc_dep_lower_bound: 0.0.0
publish_targets:
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/nodejs/dlp
- name: nodejs
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-node.git
directory_mappings:
- src: src/v2beta2
dest: packages/dlp/src/v2beta2
- src: test/test.js
dest: packages/dlp/test/gapic-v2beta2.js
- name: php_gapic
type: GAPIC
language: PHP
publish_targets:
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/php/google-cloud-dlp-v2beta2
- name: go_gapic
type: GAPIC
language: GO
publish_targets:
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/go/vendor/cloud.google.com/go/google-cloud-dlp-v2beta2/vendor
- name: go
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-go.git
directory_mappings:
- dest: dlp/apiv2beta2
- name: ruby_gapic
type: GAPIC
language: RUBY
package_version:
grpc_dep_lower_bound: 0.20.0
publish_targets:
- name: ruby
type: GITHUB
location: git@github.com:GoogleCloudPlatform/google-cloud-ruby.git
directory_mappings:
- src: lib/google/cloud/dlp/v2beta2
dest: google-cloud-dlp/lib/google/cloud/dlp/v2beta2
- src: test/google/cloud/privacy/dlp/v2beta2
dest: google-cloud-dlp/test/google/cloud/dlp/v2beta2
- name: staging
type: GITHUB
location: git@github.com:googleapis/api-client-staging.git
directory_mappings:
- dest: generated/ruby/google-cloud-dlp
- name: csharp_gapic
type: GAPIC
language: CSHARP

90
google/privacy/dlp/dlp.yaml
View File

@ -1,90 +0,0 @@
type: google.api.Service
config_version: 3
name: dlp.googleapis.com
title: DLP API
apis:
- name: google.privacy.dlp.v2beta1.DlpService
types:
- name: google.privacy.dlp.v2beta1.InspectOperationMetadata
- name: google.privacy.dlp.v2beta1.InspectOperationResult
- name: google.privacy.dlp.v2beta1.InfoTypeStatistics
- name: google.privacy.dlp.v2beta1.RiskAnalysisOperationResult
- name: google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata
documentation:
summary: |-
The Google Data Loss Prevention API provides methods for detection of
privacy-sensitive fragments in text, images, and Google Cloud Platform
storage repositories.
rules:
- selector: google.longrunning.Operations.CancelOperation
description: |-
Cancels an operation. Use the
[`inspect.operations.get`][/dlp/docs/reference/rest/v2beta1/inspect.operations/get]
to check whether the cancellation succeeded or the operation completed
despite cancellation.
- selector: google.longrunning.Operations.DeleteOperation
description: This method is not supported and the server returns `UNIMPLEMENTED`.
- selector: google.longrunning.Operations.ListOperations
description: Fetches the list of long running operations.
backend:
rules:
- selector: google.longrunning.Operations.ListOperations
deadline: 300.0
- selector: google.longrunning.Operations.GetOperation
deadline: 300.0
- selector: google.longrunning.Operations.DeleteOperation
deadline: 300.0
- selector: google.longrunning.Operations.CancelOperation
deadline: 300.0
- selector: google.privacy.dlp.v2beta1.DlpService.InspectContent
deadline: 300.0
- selector: google.privacy.dlp.v2beta1.DlpService.RedactContent
deadline: 300.0
- selector: google.privacy.dlp.v2beta1.DlpService.DeidentifyContent
deadline: 300.0
- selector: google.privacy.dlp.v2beta1.DlpService.CreateInspectOperation
deadline: 300.0
- selector: google.privacy.dlp.v2beta1.DlpService.AnalyzeDataSourceRisk
deadline: 300.0
- selector: google.privacy.dlp.v2beta1.DlpService.ListInspectFindings
deadline: 300.0
- selector: google.privacy.dlp.v2beta1.DlpService.ListInfoTypes
deadline: 300.0
- selector: google.privacy.dlp.v2beta1.DlpService.ListRootCategories
deadline: 300.0
http:
rules:
- selector: google.longrunning.Operations.ListOperations
get: '/v2beta1/{name=inspect/operations}'
additional_bindings:
- get: '/v2beta1/{name=riskAnalysis/operations}'
- selector: google.longrunning.Operations.GetOperation
get: '/v2beta1/{name=inspect/operations/*}'
additional_bindings:
- get: '/v2beta1/{name=riskAnalysis/operations/*}'
- selector: google.longrunning.Operations.DeleteOperation
delete: '/v2beta1/{name=inspect/operations/*}'
additional_bindings:
- delete: '/v2beta1/{name=riskAnalysis/operations/*}'
- selector: google.longrunning.Operations.CancelOperation
post: '/v2beta1/{name=inspect/operations/*}:cancel'
body: '*'
additional_bindings:
- post: '/v2beta1/{name=riskAnalysis/operations/*}:cancel'
body: '*'
authentication:
rules:
- selector: '*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform

75
google/privacy/dlp/dlp_v2beta2.yaml
View File

@ -1,75 +0,0 @@
type: google.api.Service
config_version: 3
name: dlp.googleapis.com
title: DLP API
apis:
- name: google.privacy.dlp.v2beta2.DlpService
documentation:
summary: |-
The Google Data Loss Prevention API provides methods for detection of
privacy-sensitive fragments in text, images, and Google Cloud Platform
storage repositories.
backend:
rules:
- selector: google.privacy.dlp.v2beta2.DlpService.InspectContent
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.RedactImage
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.DeidentifyContent
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.ReidentifyContent
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.InspectDataSource
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.AnalyzeDataSourceRisk
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.ListInfoTypes
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.CreateInspectTemplate
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.UpdateInspectTemplate
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.GetInspectTemplate
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.ListInspectTemplates
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.DeleteInspectTemplate
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.CreateDeidentifyTemplate
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.UpdateDeidentifyTemplate
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.GetDeidentifyTemplate
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.ListDeidentifyTemplates
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.DeleteDeidentifyTemplate
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.CreateJobTrigger
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.UpdateJobTrigger
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.GetJobTrigger
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.ListJobTriggers
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.DeleteJobTrigger
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.ListDlpJobs
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.GetDlpJob
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.DeleteDlpJob
deadline: 300.0
- selector: google.privacy.dlp.v2beta2.DlpService.CancelDlpJob
deadline: 300.0
authentication:
rules:
- selector: '*'
oauth:
canonical_scopes: |-
https://www.googleapis.com/auth/cloud-platform

1329
google/privacy/dlp/v2beta1/dlp.proto
View File

File diff suppressed because it is too large Load Diff

191
google/privacy/dlp/v2beta1/dlp_gapic.yaml
View File

@ -1,191 +0,0 @@
type: com.google.api.codegen.ConfigProto
config_schema_version: 1.0.0
language_settings:
java:
package_name: com.google.cloud.dlp.v2beta1
python:
package_name: google.cloud.dlp_v2beta1.gapic
go:
package_name: cloud.google.com/go/dlp/apiv2beta1
csharp:
package_name: Google.Cloud.Dlp.V2Beta1
ruby:
package_name: Google::Cloud::Dlp::V2beta1
release_level: BETA
php:
package_name: Google\Cloud\Dlp\V2beta1
nodejs:
package_name: dlp.v2beta1
domain_layer_location: google-cloud
license_header:
copyright_file: copyright-google.txt
license_file: license-header-apache-2.0.txt
interfaces:
- name: google.privacy.dlp.v2beta1.DlpService
smoke_test:
method: InspectContent
init_fields:
- inspect_config.min_likelihood=POSSIBLE
- items[0].type="text/plain"
- items[0].value="my phone number is 215-512-1212"
collections:
- name_pattern: inspect/results/{result}
entity_name: result
retry_codes_def:
- name: idempotent
retry_codes:
- UNAVAILABLE
- DEADLINE_EXCEEDED
- name: non_idempotent
retry_codes: []
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
methods:
- name: InspectContent
flattening:
groups:
- parameters:
- inspect_config
- items
required_fields:
- inspect_config
- items
request_object_method: true
retry_codes_name: non_idempotent
retry_params_name: default
timeout_millis: 60000
sample_code_init_fields:
- inspect_config.info_types[0].name="EMAIL_ADDRESS"
- items[0].type="text/plain"
- items[0].value="My email is example@example.com."
- name: RedactContent
required_fields:
- inspect_config
- items
request_object_method: true
retry_codes_name: non_idempotent
retry_params_name: default
timeout_millis: 60000
sample_code_init_fields:
- inspect_config.info_types[0].name="EMAIL_ADDRESS"
- items[0].type="text/plain"
- items[0].value="My email is example@example.com."
- replace_configs[0].info_type.name="EMAIL_ADDRESS"
- replace_configs[0].replace_with="REDACTED"
- name: DeidentifyContent
flattening:
groups:
- parameters:
- deidentify_config
- inspect_config
- items
required_fields:
- deidentify_config
- inspect_config
- items
request_object_method: true
retry_codes_name: idempotent
retry_params_name: default
timeout_millis: 60000
- name: AnalyzeDataSourceRisk
flattening:
groups:
- parameters:
- privacy_metric
- source_table
required_fields:
- privacy_metric
- source_table
request_object_method: true
retry_codes_name: idempotent
retry_params_name: default
timeout_millis: 60000
long_running:
return_type: google.privacy.dlp.v2beta1.RiskAnalysisOperationResult
metadata_type: google.privacy.dlp.v2beta1.RiskAnalysisOperationMetadata
initial_poll_delay_millis: 20000
poll_delay_multiplier: 1.5
max_poll_delay_millis: 45000
total_poll_timeout_millis: 86400000
- name: CreateInspectOperation
flattening:
groups:
- parameters:
- inspect_config
- storage_config
- output_config
long_running:
return_type: google.privacy.dlp.v2beta1.InspectOperationResult
metadata_type: google.privacy.dlp.v2beta1.InspectOperationMetadata
initial_poll_delay_millis: 20000
poll_delay_multiplier: 1.5
max_poll_delay_millis: 45000
total_poll_timeout_millis: 86400000
required_fields:
- inspect_config
- storage_config
- output_config
request_object_method: true
retry_codes_name: non_idempotent
retry_params_name: default
timeout_millis: 60000
sample_code_init_fields:
- inspect_config.info_types[0].name="EMAIL_ADDRESS"
- storage_config.cloud_storage_options.file_set.url="gs://example_bucket/example_file.png"
- name: ListInspectFindings
flattening:
groups:
- parameters:
- name
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: result
timeout_millis: 60000
- name: ListInfoTypes
flattening:
groups:
- parameters:
- category
- language_code
required_fields:
- category
- language_code
request_object_method: true
retry_codes_name: idempotent
retry_params_name: default
timeout_millis: 60000
sample_code_init_fields:
- category="PII"
- language_code="en"
- name: ListRootCategories
flattening:
groups:
- parameters:
- language_code
required_fields:
- language_code
request_object_method: false
retry_codes_name: idempotent
retry_params_name: default
timeout_millis: 60000
sample_code_init_fields:
- language_code="en"
resource_name_generation:
- message_name: InspectOperationResult
field_entity_map:
name: result
- message_name: ListInspectFindingsRequest
field_entity_map:
name: result

276
google/privacy/dlp/v2beta1/storage.proto
View File

@ -1,276 +0,0 @@
// Copyright 2017 Google Inc.
//
// 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
//
// http://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.
syntax = "proto3";
package google.privacy.dlp.v2beta1;
import "google/api/annotations.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Dlp.V2Beta1";
option go_package = "google.golang.org/genproto/googleapis/privacy/dlp/v2beta1;dlp";
option java_multiple_files = true;
option java_outer_classname = "DlpStorage";
option java_package = "com.google.privacy.dlp.v2beta1";
option php_namespace = "Google\\Cloud\\Dlp\\V2beta1";
// Type of information detected by the API.
message InfoType {
// Name of the information type.
string name = 1;
}
// Custom information type provided by the user. Used to find domain-specific
// sensitive information configurable to the data in question.
message CustomInfoType {
// Custom information type based on a dictionary of words or phrases. This can
// be used to match sensitive information specific to the data, such as a list
// of employee IDs or job titles.
//
// Dictionary words are case-insensitive and all characters other than letters
// and digits in the unicode [Basic Multilingual
// Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)
// will be replaced with whitespace when scanning for matches, so the
// dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",
// "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters
// surrounding any match must be of a different type than the adjacent
// characters within the word, so letters must be next to non-letters and
// digits next to non-digits. For example, the dictionary word "jen" will
// match the first three letters of the text "jen123" but will return no
// matches for "jennifer".
//
// Dictionary words containing a large number of characters that are not
// letters or digits may result in unexpected findings because such characters
// are treated as whitespace.
message Dictionary {
// Message defining a list of words or phrases to search for in the data.
message WordList {
// Words or phrases defining the dictionary. The dictionary must contain
// at least one phrase and every phrase must contain at least 2 characters
// that are letters or digits. [required]
repeated string words = 1;
}
oneof source {
// List of words or phrases to search for.
WordList word_list = 1;
}
}
// Info type configuration. All custom info types must have configurations
// that do not conflict with built-in info types or other custom info types.
InfoType info_type = 1;
oneof type {
// Dictionary-based custom info type.
Dictionary dictionary = 2;
}
}
// General identifier of a data field in a storage service.
message FieldId {
// Name describing the field.
string column_name = 1;
}
// Datastore partition ID.
// A partition ID identifies a grouping of entities. The grouping is always
// by project and namespace, however the namespace ID may be empty.
//
// A partition ID contains several dimensions:
// project ID and namespace ID.
message PartitionId {
// The ID of the project to which the entities belong.
string project_id = 2;
// If not empty, the ID of the namespace to which the entities belong.
string namespace_id = 4;
}
// A representation of a Datastore kind.
message KindExpression {
// The name of the kind.
string name = 1;
}
// A reference to a property relative to the Datastore kind expressions.
message PropertyReference {
// The name of the property.
// If name includes "."s, it may be interpreted as a property name path.
string name = 2;
}
// A representation of a Datastore property in a projection.
message Projection {
// The property to project.
PropertyReference property = 1;
}
// Options defining a data set within Google Cloud Datastore.
message DatastoreOptions {
// A partition ID identifies a grouping of entities. The grouping is always
// by project and namespace, however the namespace ID may be empty.
PartitionId partition_id = 1;
// The kind to process.
KindExpression kind = 2;
// Properties to scan. If none are specified, all properties will be scanned
// by default.
repeated Projection projection = 3;
}
// Options defining a file or a set of files (path ending with *) within
// a Google Cloud Storage bucket.
message CloudStorageOptions {
// Set of files to scan.
message FileSet {
// The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the
// path is allowed.
string url = 1;
}
FileSet file_set = 1;
}
// A location in Cloud Storage.
message CloudStoragePath {
// The url, in the format of `gs://bucket/<path>`.
string path = 1;
}
// Options defining BigQuery table and row identifiers.
message BigQueryOptions {
// Complete BigQuery table reference.
BigQueryTable table_reference = 1;
// References to fields uniquely identifying rows within the table.
// Nested fields in the format, like `person.birthdate.year`, are allowed.
repeated FieldId identifying_fields = 2;
}
// Shared message indicating Cloud storage type.
message StorageConfig {
oneof type {
// Google Cloud Datastore options specification.
DatastoreOptions datastore_options = 2;
// Google Cloud Storage options specification.
CloudStorageOptions cloud_storage_options = 3;
// BigQuery options specification.
BigQueryOptions big_query_options = 4;
}
}
// Record key for a finding in a Cloud Storage file.
message CloudStorageKey {
// Path to the file.
string file_path = 1;
// Byte offset of the referenced data in the file.
int64 start_offset = 2;
}
// Record key for a finding in Cloud Datastore.
message DatastoreKey {
// Datastore entity key.
Key entity_key = 1;
}
// A unique identifier for a Datastore entity.
// If a key's partition ID or any of its path kinds or names are
// reserved/read-only, the key is reserved/read-only.
// A reserved/read-only key is forbidden in certain documented contexts.
message Key {
// A (kind, ID/name) pair used to construct a key path.
//
// If either name or ID is set, the element is complete.
// If neither is set, the element is incomplete.
message PathElement {
// The kind of the entity.
// A kind matching regex `__.*__` is reserved/read-only.
// A kind must not contain more than 1500 bytes when UTF-8 encoded.
// Cannot be `""`.
string kind = 1;
// The type of ID.
oneof id_type {
// The auto-allocated ID of the entity.
// Never equal to zero. Values less than zero are discouraged and may not
// be supported in the future.
int64 id = 2;
// The name of the entity.
// A name matching regex `__.*__` is reserved/read-only.
// A name must not be more than 1500 bytes when UTF-8 encoded.
// Cannot be `""`.
string name = 3;
}
}
// Entities are partitioned into subsets, currently identified by a project
// ID and namespace ID.
// Queries are scoped to a single partition.
PartitionId partition_id = 1;
// The entity path.
// An entity path consists of one or more elements composed of a kind and a
// string or numerical identifier, which identify entities. The first
// element identifies a _root entity_, the second element identifies
// a _child_ of the root entity, the third element identifies a child of the
// second entity, and so forth. The entities identified by all prefixes of
// the path are called the element's _ancestors_.
//
// A path can never be empty, and a path can have at most 100 elements.
repeated PathElement path = 2;
}
// Message for a unique key indicating a record that contains a finding.
message RecordKey {
oneof type {
CloudStorageKey cloud_storage_key = 1;
DatastoreKey datastore_key = 2;
}
}
// Message defining the location of a BigQuery table. A table is uniquely
// identified by its project_id, dataset_id, and table_name. Within a query
// a table is often referenced with a string in the format of:
// `<project_id>:<dataset_id>.<table_id>` or
// `<project_id>.<dataset_id>.<table_id>`.
message BigQueryTable {
// The Google Cloud Platform project ID of the project containing the table.
// If omitted, project ID is inferred from the API call.
string project_id = 1;
// Dataset ID of the table.
string dataset_id = 2;
// Name of the table.
string table_id = 3;
}
// An entity in a dataset is a field or set of fields that correspond to a
// single person. For example, in medical records the `EntityId` might be
// a patient identifier, or for financial records it might be an account
// identifier. This message is used when generalizations or analysis must be
// consistent across multiple rows pertaining to the same entity.
message EntityId {
// Composite key indicating which field contains the entity identifier.
FieldId field = 1;
}

2309
google/privacy/dlp/v2beta2/dlp.proto
View File

File diff suppressed because it is too large Load Diff

493
google/privacy/dlp/v2beta2/dlp_gapic.yaml
View File

@ -1,493 +0,0 @@
type: com.google.api.codegen.ConfigProto
config_schema_version: 1.0.0
language_settings:
java:
package_name: com.google.cloud.dlp.v2beta2
python:
package_name: google.cloud.dlp_v2beta2.gapic
go:
package_name: cloud.google.com/go/dlp/apiv2beta2
csharp:
package_name: Google.Cloud.Dlp.V2Beta2
ruby:
package_name: Google::Cloud::Dlp::V2beta2
php:
package_name: Google\Cloud\Dlp\V2beta2
nodejs:
package_name: dlp.v2beta2
domain_layer_location: google-cloud
license_header:
copyright_file: copyright-google.txt
license_file: license-header-apache-2.0.txt
collection_oneofs:
- oneof_name: deidentify_template_oneof
collection_names:
- organization_deidentify_template
- project_deidentify_template
- oneof_name: inspect_template_oneof
collection_names:
- organization_inspect_template
- project_inspect_template
# A list of API interface configurations.
interfaces:
- name: google.privacy.dlp.v2beta2.DlpService
# A list of resource collection configurations.
# Consists of a name_pattern and an entity_name.
# The name_pattern is a pattern to describe the names of the resources of this
# collection, using the platform's conventions for URI patterns. A generator
# may use this to generate methods to compose and decompose such names. The
# pattern should use named placeholders as in `shelves/{shelf}/books/{book}`;
# those will be taken as hints for the parameter names of the generated
# methods. If empty, no name methods are generated.
# The entity_name is the name to be used as a basis for generated methods and
# classes.
collections:
- name_pattern: organizations/{organization}
entity_name: organization
- name_pattern: organizations/{organization}/deidentifyTemplates/{deidentify_template}
entity_name: organization_deidentify_template
- name_pattern: projects/{project}/deidentifyTemplates/{deidentify_template}
entity_name: project_deidentify_template
- name_pattern: organizations/{organization}/inspectTemplates/{inspect_template}
entity_name: organization_inspect_template
- name_pattern: projects/{project}/inspectTemplates/{inspect_template}
entity_name: project_inspect_template
- name_pattern: projects/{project}/jobTriggers/{job_trigger}
entity_name: project_job_trigger
- name_pattern: projects/{project}
entity_name: project
- name_pattern: projects/{project}/dlpJobs/{dlp_job}
entity_name: dlp_job
# Definition for retryable codes.
retry_codes_def:
- name: idempotent
retry_codes:
- UNAVAILABLE
- DEADLINE_EXCEEDED
- name: non_idempotent
retry_codes: []
# Definition for retry/backoff parameters.
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000
initial_rpc_timeout_millis: 20000
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 20000
total_timeout_millis: 600000
# A list of method configurations.
# Common properties:
#
# name - The simple name of the method.
#
# flattening - Specifies the configuration for parameter flattening.
# Describes the parameter groups for which a generator should produce method
# overloads which allow a client to directly pass request message fields as
# method parameters. This information may or may not be used, depending on
# the target language.
# Consists of groups, which each represent a list of parameters to be
# flattened. Each parameter listed must be a field of the request message.
#
# required_fields - Fields that are always required for a request to be
# valid.
#
# request_object_method - Turns on or off the generation of a method whose
# sole parameter is a request object. Not all languages will generate this
# method.
#
# resource_name_treatment - An enum that specifies how to treat the resource
# name formats defined in the field_name_patterns and
# response_field_name_patterns fields.
# UNSET: default value
# NONE: the collection configs will not be used by the generated code.
# VALIDATE: string fields will be validated by the client against the
# specified resource name formats.
# STATIC_TYPES: the client will use generated types for resource names.
#
# page_streaming - Specifies the configuration for paging.
# Describes information for generating a method which transforms a paging
# list RPC into a stream of resources.
# Consists of a request and a response.
# The request specifies request information of the list method. It defines
# which fields match the paging pattern in the request. The request consists
# of a page_size_field and a token_field. The page_size_field is the name of
# the optional field specifying the maximum number of elements to be
# returned in the response. The token_field is the name of the field in the
# request containing the page token.
# The response specifies response information of the list method. It defines
# which fields match the paging pattern in the response. The response
# consists of a token_field and a resources_field. The token_field is the
# name of the field in the response containing the next page token. The
# resources_field is the name of the field in the response containing the
# list of resources belonging to the page.
#
# retry_codes_name - Specifies the configuration for retryable codes. The
# name must be defined in interfaces.retry_codes_def.
#
# retry_params_name - Specifies the configuration for retry/backoff
# parameters. The name must be defined in interfaces.retry_params_def.
#
# field_name_patterns - Maps the field name of the request type to
# entity_name of interfaces.collections.
# Specifies the string pattern that the field must follow.
#
# timeout_millis - Specifies the default timeout for a non-retrying call. If
# the call is retrying, refer to retry_params_name instead.
methods:
- name: InspectContent
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
- name: RedactImage
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
- name: DeidentifyContent
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
- name: ReidentifyContent
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
- name: InspectDataSource
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
- name: AnalyzeDataSourceRisk
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
- name: ListInfoTypes
request_object_method: true
retry_codes_name: idempotent
retry_params_name: default
timeout_millis: 300000
- name: CreateInspectTemplate
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: organization
timeout_millis: 300000
- name: UpdateInspectTemplate
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: inspect_template_oneof
timeout_millis: 300000
- name: GetInspectTemplate
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: inspect_template_oneof
timeout_millis: 300000
- name: ListInspectTemplates
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: inspect_templates
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: organization
timeout_millis: 300000
- name: DeleteInspectTemplate
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: inspect_template_oneof
timeout_millis: 300000
- name: CreateDeidentifyTemplate
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: organization
timeout_millis: 300000
- name: UpdateDeidentifyTemplate
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: deidentify_template_oneof
timeout_millis: 300000
- name: GetDeidentifyTemplate
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: deidentify_template_oneof
timeout_millis: 300000
- name: ListDeidentifyTemplates
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: deidentify_templates
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: organization
timeout_millis: 300000
- name: DeleteDeidentifyTemplate
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: deidentify_template_oneof
timeout_millis: 300000
- name: ListDlpJobs
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: jobs
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
- name: GetDlpJob
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: dlp_job
timeout_millis: 300000
- name: DeleteDlpJob
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: dlp_job
timeout_millis: 300000
- name: CancelDlpJob
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: dlp_job
timeout_millis: 300000
- name: ListJobTriggers
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: job_triggers
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
- name: GetJobTrigger
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: project_job_trigger
timeout_millis: 300000
- name: DeleteJobTrigger
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
timeout_millis: 300000
- name: UpdateJobTrigger
required_fields:
- name
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: project_job_trigger
timeout_millis: 300000
- name: CreateJobTrigger
required_fields:
- parent
request_object_method: true
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
parent: project
timeout_millis: 300000
resource_name_generation:
- message_name: InspectContentRequest
field_entity_map:
parent: project
- message_name: RedactImageRequest
field_entity_map:
parent: project
- message_name: DeidentifyContentRequest
field_entity_map:
parent: project
- message_name: ReidentifyContentRequest
field_entity_map:
parent: project
- message_name: InspectDataSourceRequest
field_entity_map:
parent: project
- message_name: AnalyzeDataSourceRiskRequest
field_entity_map:
parent: project
- message_name: CreateInspectTemplateRequest
field_entity_map:
parent: organization
- message_name: UpdateInspectTemplateRequest
field_entity_map:
name: inspect_template_oneof
- message_name: GetInspectTemplateRequest
field_entity_map:
name: inspect_template_oneof
- message_name: ListInspectTemplatesRequest
field_entity_map:
parent: organization
- message_name: DeleteInspectTemplateRequest
field_entity_map:
name: inspect_template_oneof
- message_name: CreateDeidentifyTemplateRequest
field_entity_map:
parent: organization
- message_name: UpdateDeidentifyTemplateRequest
field_entity_map:
name: deidentify_template_oneof
- message_name: GetDeidentifyTemplateRequest
field_entity_map:
name: deidentify_template_oneof
- message_name: ListDeidentifyTemplatesRequest
field_entity_map:
parent: organization
- message_name: DeleteDeidentifyTemplateRequest
field_entity_map:
name: deidentify_template_oneof
- message_name: CreateJobTriggerRequest
field_entity_map:
parent: project
- message_name: UpdateJobTriggerRequest
field_entity_map:
name: project_job_trigger
- message_name: GetJobTriggerRequest
field_entity_map:
name: project_job_trigger
- message_name: ListJobTriggersRequest
field_entity_map:
parent: project
- message_name: DeleteJobTriggerRequest
field_entity_map:
name: project_job_trigger
- message_name: ListDlpJobsRequest
field_entity_map:
parent: project
- message_name: GetDlpJobRequest
field_entity_map:
name: dlp_job
- message_name: DeleteDlpJobRequest
field_entity_map:
name: dlp_job
- message_name: CancelDlpJobRequest
field_entity_map:
name: dlp_job

401
google/privacy/dlp/v2beta2/storage.proto
View File

@ -1,401 +0,0 @@
// Copyright 2018 Google Inc.
//
// 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
//
// http://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.
syntax = "proto3";
package google.privacy.dlp.v2beta2;
import "google/api/annotations.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Dlp.V2Beta2";
option go_package = "google.golang.org/genproto/googleapis/privacy/dlp/v2beta2;dlp";
option java_multiple_files = true;
option java_outer_classname = "DlpStorage";
option java_package = "com.google.privacy.dlp.v2beta2";
option php_namespace = "Google\\Cloud\\Dlp\\V2beta2";
// Type of information detected by the API.
message InfoType {
// Name of the information type.
string name = 1;
}
// Custom information type provided by the user. Used to find domain-specific
// sensitive information configurable to the data in question.
message CustomInfoType {
// Custom information type based on a dictionary of words or phrases. This can
// be used to match sensitive information specific to the data, such as a list
// of employee IDs or job titles.
//
// Dictionary words are case-insensitive and all characters other than letters
// and digits in the unicode [Basic Multilingual
// Plane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)
// will be replaced with whitespace when scanning for matches, so the
// dictionary phrase "Sam Johnson" will match all three phrases "sam johnson",
// "Sam, Johnson", and "Sam (Johnson)". Additionally, the characters
// surrounding any match must be of a different type than the adjacent
// characters within the word, so letters must be next to non-letters and
// digits next to non-digits. For example, the dictionary word "jen" will
// match the first three letters of the text "jen123" but will return no
// matches for "jennifer".
//
// Dictionary words containing a large number of characters that are not
// letters or digits may result in unexpected findings because such characters
// are treated as whitespace.
message Dictionary {
// Message defining a list of words or phrases to search for in the data.
message WordList {
// Words or phrases defining the dictionary. The dictionary must contain
// at least one phrase and every phrase must contain at least 2 characters
// that are letters or digits. [required]
repeated string words = 1;
}
oneof source {
// List of words or phrases to search for.
WordList word_list = 1;
}
}
// Message defining a custom regular expression.
message Regex {
// Pattern defining the regular expression.
string pattern = 1;
}
// Message for detecting output from deidentification transformations
// such as
// [`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).
// These types of transformations are
// those that perform pseudonymization, thereby producing a "surrogate" as
// output. This should be used in conjunction with a field on the
// transformation such as `surrogate_info_type`. This custom info type does
// not support the use of `detection_rules`.
message SurrogateType {
}
// Rule for modifying a custom info type to alter behavior under certain
// circumstances, depending on the specific details of the rule. Not supported
// for the `surrogate_type` custom info type.
message DetectionRule {
// Message for specifying a window around a finding to apply a detection
// rule.
message Proximity {
// Number of characters before the finding to consider.
int32 window_before = 1;
// Number of characters after the finding to consider.
int32 window_after = 2;
}
// Message for specifying an adjustment to the likelihood of a finding as
// part of a detection rule.
message LikelihoodAdjustment {
oneof adjustment {
// Set the likelihood of a finding to a fixed value.
Likelihood fixed_likelihood = 1;
// Increase or decrease the likelihood by the specified number of
// levels. For example, if a finding would be `POSSIBLE` without the
// detection rule and `relative_likelihood` is 1, then it is upgraded to
// `LIKELY`, while a value of -1 would downgrade it to `UNLIKELY`.
// Likelihood may never drop below `VERY_UNLIKELY` or exceed
// `VERY_LIKELY`, so applying an adjustment of 1 followed by an
// adjustment of -1 when base likelihood is `VERY_LIKELY` will result in
// a final likelihood of `LIKELY`.
int32 relative_likelihood = 2;
}
}
// Detection rule that adjusts the likelihood of findings within a certain
// proximity of hotwords.
message HotwordRule {
// Regex pattern defining what qualifies as a hotword.
Regex hotword_regex = 1;
// Proximity of the finding within which the entire hotword must reside.
// The total length of the window cannot exceed 1000 characters. Note that
// the finding itself will be included in the window, so that hotwords may
// be used to match substrings of the finding itself. For example, the
// certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be
// adjusted upwards if the area code is known to be the local area code of
// a company office using the hotword regex "\(xxx\)", where "xxx"
// is the area code in question.
Proximity proximity = 2;
// Likelihood adjustment to apply to all matching findings.
LikelihoodAdjustment likelihood_adjustment = 3;
}
oneof type {
// Hotword-based detection rule.
HotwordRule hotword_rule = 1;
}
}
// Info type configuration. All custom info types must have configurations
// that do not conflict with built-in info types or other custom info types.
InfoType info_type = 1;
// Likelihood to return for this custom info type. This base value can be
// altered by a detection rule if the finding meets the criteria specified by
// the rule. Defaults to `VERY_LIKELY` if not specified.
Likelihood likelihood = 6;
oneof type {
// Dictionary-based custom info type.
Dictionary dictionary = 2;
// Regex-based custom info type.
Regex regex = 3;
// Surrogate info type.
SurrogateType surrogate_type = 4;
}
// Set of detection rules to apply to all findings of this custom info type.
// Rules are applied in order that they are specified. Not supported for the
// `surrogate_type` custom info type.
repeated DetectionRule detection_rules = 7;
}
// General identifier of a data field in a storage service.
message FieldId {
// Name describing the field.
string name = 1;
}
// Datastore partition ID.
// A partition ID identifies a grouping of entities. The grouping is always
// by project and namespace, however the namespace ID may be empty.
//
// A partition ID contains several dimensions:
// project ID and namespace ID.
message PartitionId {
// The ID of the project to which the entities belong.
string project_id = 2;
// If not empty, the ID of the namespace to which the entities belong.
string namespace_id = 4;
}
// A representation of a Datastore kind.
message KindExpression {
// The name of the kind.
string name = 1;
}
// Options defining a data set within Google Cloud Datastore.
message DatastoreOptions {
// A partition ID identifies a grouping of entities. The grouping is always
// by project and namespace, however the namespace ID may be empty.
PartitionId partition_id = 1;
// The kind to process.
KindExpression kind = 2;
}
// Options defining a file or a set of files (path ending with *) within
// a Google Cloud Storage bucket.
message CloudStorageOptions {
// Set of files to scan.
message FileSet {
// The url, in the format `gs://<bucket>/<path>`. Trailing wildcard in the
// path is allowed.
string url = 1;
}
FileSet file_set = 1;
// Max number of bytes to scan from a file. If a scanned file's size is bigger
// than this value then the rest of the bytes are omitted.
int64 bytes_limit_per_file = 4;
}
// Options defining BigQuery table and row identifiers.
message BigQueryOptions {
// Complete BigQuery table reference.
BigQueryTable table_reference = 1;
// References to fields uniquely identifying rows within the table.
// Nested fields in the format, like `person.birthdate.year`, are allowed.
repeated FieldId identifying_fields = 2;
}
// Shared message indicating Cloud storage type.
message StorageConfig {
// Configuration of the timespan of the items to include in scanning.
// Currently only supported when inspecting Google Cloud Storage and BigQuery.
message TimespanConfig {
// Exclude files older than this value.
google.protobuf.Timestamp start_time = 1;
// Exclude files newer than this value.
// If set to zero, no upper time limit is applied.
google.protobuf.Timestamp end_time = 2;
// When the job is started by a JobTrigger we will automatically figure out
// a valid start_time to avoid scanning files that have not been modified
// since the last time the JobTrigger executed. This will be based on the
// time of the execution of the last run of the JobTrigger.
bool enable_auto_population_of_timespan_config = 4;
}
oneof type {
// Google Cloud Datastore options specification.
DatastoreOptions datastore_options = 2;
// Google Cloud Storage options specification.
CloudStorageOptions cloud_storage_options = 3;
// BigQuery options specification.
BigQueryOptions big_query_options = 4;
}
TimespanConfig timespan_config = 6;
}
// Row key for identifying a record in BigQuery table.
message BigQueryKey {
// Complete BigQuery table reference.
BigQueryTable table_reference = 1;
// Absolute number of the row from the beginning of the table at the time
// of scanning.
int64 row_number = 2;
}
// Record key for a finding in a Cloud Storage file.
message CloudStorageKey {
// Path to the file.
string file_path = 1;
// Byte offset of the referenced data in the file.
int64 start_offset = 2;
}
// Record key for a finding in Cloud Datastore.
message DatastoreKey {
// Datastore entity key.
Key entity_key = 1;
}
// A unique identifier for a Datastore entity.
// If a key's partition ID or any of its path kinds or names are
// reserved/read-only, the key is reserved/read-only.
// A reserved/read-only key is forbidden in certain documented contexts.
message Key {
// A (kind, ID/name) pair used to construct a key path.
//
// If either name or ID is set, the element is complete.
// If neither is set, the element is incomplete.
message PathElement {
// The kind of the entity.
// A kind matching regex `__.*__` is reserved/read-only.
// A kind must not contain more than 1500 bytes when UTF-8 encoded.
// Cannot be `""`.
string kind = 1;
// The type of ID.
oneof id_type {
// The auto-allocated ID of the entity.
// Never equal to zero. Values less than zero are discouraged and may not
// be supported in the future.
int64 id = 2;
// The name of the entity.
// A name matching regex `__.*__` is reserved/read-only.
// A name must not be more than 1500 bytes when UTF-8 encoded.
// Cannot be `""`.
string name = 3;
}
}
// Entities are partitioned into subsets, currently identified by a project
// ID and namespace ID.
// Queries are scoped to a single partition.
PartitionId partition_id = 1;
// The entity path.
// An entity path consists of one or more elements composed of a kind and a
// string or numerical identifier, which identify entities. The first
// element identifies a _root entity_, the second element identifies
// a _child_ of the root entity, the third element identifies a child of the
// second entity, and so forth. The entities identified by all prefixes of
// the path are called the element's _ancestors_.
//
// A path can never be empty, and a path can have at most 100 elements.
repeated PathElement path = 2;
}
// Message for a unique key indicating a record that contains a finding.
message RecordKey {
oneof type {
CloudStorageKey cloud_storage_key = 1;
DatastoreKey datastore_key = 2;
BigQueryKey big_query_key = 3;
}
}
// Message defining the location of a BigQuery table. A table is uniquely
// identified by its project_id, dataset_id, and table_name. Within a query
// a table is often referenced with a string in the format of:
// `<project_id>:<dataset_id>.<table_id>` or
// `<project_id>.<dataset_id>.<table_id>`.
message BigQueryTable {
// The Google Cloud Platform project ID of the project containing the table.
// If omitted, project ID is inferred from the API call.
string project_id = 1;
// Dataset ID of the table.
string dataset_id = 2;
// Name of the table.
string table_id = 3;
}
// An entity in a dataset is a field or set of fields that correspond to a
// single person. For example, in medical records the `EntityId` might be
// a patient identifier, or for financial records it might be an account
// identifier. This message is used when generalizations or analysis must be
// consistent across multiple rows pertaining to the same entity.
message EntityId {
// Composite key indicating which field contains the entity identifier.
FieldId field = 1;
}
// Categorization of results based on how likely they are to represent a match,
// based on the number of elements they contain which imply a match.
enum Likelihood {
// Default value; information with all likelihoods is included.
LIKELIHOOD_UNSPECIFIED = 0;
// Few matching elements.
VERY_UNLIKELY = 1;
UNLIKELY = 2;
// Some matching elements.
POSSIBLE = 3;
LIKELY = 4;
// Many matching elements.
VERY_LIKELY = 5;
}