google-cloud-dlp 0.1.0 → 0.2.0

data/lib/google/cloud/dlp/v2/doc/google/privacy/dlp/v2/storage.rb

@@ -0,0 +1,365 @@
+# Copyright 2018 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.
+
+module Google
+  module Privacy
+    module Dlp
+      module V2
+        # Type of information detected by the API.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Name of the information type.
+        class InfoType; end
+
+        # Custom information type provided by the user. Used to find domain-specific
+        # sensitive information configurable to the data in question.
+        # @!attribute [rw] info_type
+        #   @return [Google::Privacy::Dlp::V2::InfoType]
+        #     Info type configuration. All custom info types must have configurations
+        #     that do not conflict with built-in info types or other custom info types.
+        # @!attribute [rw] likelihood
+        #   @return [Google::Privacy::Dlp::V2::Likelihood]
+        #     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.
+        # @!attribute [rw] dictionary
+        #   @return [Google::Privacy::Dlp::V2::CustomInfoType::Dictionary]
+        #     Dictionary-based custom info type.
+        # @!attribute [rw] regex
+        #   @return [Google::Privacy::Dlp::V2::CustomInfoType::Regex]
+        #     Regex-based custom info type.
+        # @!attribute [rw] surrogate_type
+        #   @return [Google::Privacy::Dlp::V2::CustomInfoType::SurrogateType]
+        #     Surrogate info type.
+        # @!attribute [rw] detection_rules
+        #   @return [Array<Google::Privacy::Dlp::V2::CustomInfoType::DetectionRule>]
+        #     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.
+        class 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.
+          # @!attribute [rw] word_list
+          #   @return [Google::Privacy::Dlp::V2::CustomInfoType::Dictionary::WordList]
+          #     List of words or phrases to search for.
+          class Dictionary
+            # Message defining a list of words or phrases to search for in the data.
+            # @!attribute [rw] words
+            #   @return [Array<String>]
+            #     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]
+            class WordList; end
+          end
+
+          # Message defining a custom regular expression.
+          # @!attribute [rw] pattern
+          #   @return [String]
+          #     Pattern defining the regular expression.
+          class Regex; end
+
+          # Message for detecting output from deidentification transformations
+          # such as
+          # [+CryptoReplaceFfxFpeConfig+](https://cloud.google.com/dlp/docs/reference/rest/v2/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+.
+          class SurrogateType; end
+
+          # 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.
+          # @!attribute [rw] hotword_rule
+          #   @return [Google::Privacy::Dlp::V2::CustomInfoType::DetectionRule::HotwordRule]
+          #     Hotword-based detection rule.
+          class DetectionRule
+            # Message for specifying a window around a finding to apply a detection
+            # rule.
+            # @!attribute [rw] window_before
+            #   @return [Integer]
+            #     Number of characters before the finding to consider.
+            # @!attribute [rw] window_after
+            #   @return [Integer]
+            #     Number of characters after the finding to consider.
+            class Proximity; end
+
+            # Message for specifying an adjustment to the likelihood of a finding as
+            # part of a detection rule.
+            # @!attribute [rw] fixed_likelihood
+            #   @return [Google::Privacy::Dlp::V2::Likelihood]
+            #     Set the likelihood of a finding to a fixed value.
+            # @!attribute [rw] relative_likelihood
+            #   @return [Integer]
+            #     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+.
+            class LikelihoodAdjustment; end
+
+            # Detection rule that adjusts the likelihood of findings within a certain
+            # proximity of hotwords.
+            # @!attribute [rw] hotword_regex
+            #   @return [Google::Privacy::Dlp::V2::CustomInfoType::Regex]
+            #     Regex pattern defining what qualifies as a hotword.
+            # @!attribute [rw] proximity
+            #   @return [Google::Privacy::Dlp::V2::CustomInfoType::DetectionRule::Proximity]
+            #     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.
+            # @!attribute [rw] likelihood_adjustment
+            #   @return [Google::Privacy::Dlp::V2::CustomInfoType::DetectionRule::LikelihoodAdjustment]
+            #     Likelihood adjustment to apply to all matching findings.
+            class HotwordRule; end
+          end
+        end
+
+        # General identifier of a data field in a storage service.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Name describing the field.
+        class FieldId; end
+
+        # 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.
+        # @!attribute [rw] project_id
+        #   @return [String]
+        #     The ID of the project to which the entities belong.
+        # @!attribute [rw] namespace_id
+        #   @return [String]
+        #     If not empty, the ID of the namespace to which the entities belong.
+        class PartitionId; end
+
+        # A representation of a Datastore kind.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The name of the kind.
+        class KindExpression; end
+
+        # Options defining a data set within Google Cloud Datastore.
+        # @!attribute [rw] partition_id
+        #   @return [Google::Privacy::Dlp::V2::PartitionId]
+        #     A partition ID identifies a grouping of entities. The grouping is always
+        #     by project and namespace, however the namespace ID may be empty.
+        # @!attribute [rw] kind
+        #   @return [Google::Privacy::Dlp::V2::KindExpression]
+        #     The kind to process.
+        class DatastoreOptions; end
+
+        # Options defining a file or a set of files (path ending with *) within
+        # a Google Cloud Storage bucket.
+        # @!attribute [rw] file_set
+        #   @return [Google::Privacy::Dlp::V2::CloudStorageOptions::FileSet]
+        # @!attribute [rw] bytes_limit_per_file
+        #   @return [Integer]
+        #     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.
+        class CloudStorageOptions
+          # Set of files to scan.
+          # @!attribute [rw] url
+          #   @return [String]
+          #     The url, in the format +gs://<bucket>/<path>+. Trailing wildcard in the
+          #     path is allowed.
+          class FileSet; end
+        end
+
+        # Options defining BigQuery table and row identifiers.
+        # @!attribute [rw] table_reference
+        #   @return [Google::Privacy::Dlp::V2::BigQueryTable]
+        #     Complete BigQuery table reference.
+        # @!attribute [rw] identifying_fields
+        #   @return [Array<Google::Privacy::Dlp::V2::FieldId>]
+        #     References to fields uniquely identifying rows within the table.
+        #     Nested fields in the format, like +person.birthdate.year+, are allowed.
+        class BigQueryOptions; end
+
+        # Shared message indicating Cloud storage type.
+        # @!attribute [rw] datastore_options
+        #   @return [Google::Privacy::Dlp::V2::DatastoreOptions]
+        #     Google Cloud Datastore options specification.
+        # @!attribute [rw] cloud_storage_options
+        #   @return [Google::Privacy::Dlp::V2::CloudStorageOptions]
+        #     Google Cloud Storage options specification.
+        # @!attribute [rw] big_query_options
+        #   @return [Google::Privacy::Dlp::V2::BigQueryOptions]
+        #     BigQuery options specification.
+        # @!attribute [rw] timespan_config
+        #   @return [Google::Privacy::Dlp::V2::StorageConfig::TimespanConfig]
+        class StorageConfig
+          # Configuration of the timespan of the items to include in scanning.
+          # Currently only supported when inspecting Google Cloud Storage and BigQuery.
+          # @!attribute [rw] start_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Exclude files older than this value.
+          # @!attribute [rw] end_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     Exclude files newer than this value.
+          #     If set to zero, no upper time limit is applied.
+          # @!attribute [rw] timestamp_field
+          #   @return [Google::Privacy::Dlp::V2::FieldId]
+          #     Specification of the field containing the timestamp of scanned items.
+          #     Required for data sources like Datastore or BigQuery.
+          #     The valid data types of the timestamp field are:
+          #     for BigQuery - timestamp, date, datetime;
+          #     for Datastore - timestamp.
+          #     Datastore entity will be scanned if the timestamp property does not exist
+          #     or its value is empty or invalid.
+          # @!attribute [rw] enable_auto_population_of_timespan_config
+          #   @return [true, false]
+          #     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.
+          class TimespanConfig; end
+        end
+
+        # Row key for identifying a record in BigQuery table.
+        # @!attribute [rw] table_reference
+        #   @return [Google::Privacy::Dlp::V2::BigQueryTable]
+        #     Complete BigQuery table reference.
+        # @!attribute [rw] row_number
+        #   @return [Integer]
+        #     Absolute number of the row from the beginning of the table at the time
+        #     of scanning.
+        class BigQueryKey; end
+
+        # Record key for a finding in Cloud Datastore.
+        # @!attribute [rw] entity_key
+        #   @return [Google::Privacy::Dlp::V2::Key]
+        #     Datastore entity key.
+        class DatastoreKey; end
+
+        # 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.
+        # @!attribute [rw] partition_id
+        #   @return [Google::Privacy::Dlp::V2::PartitionId]
+        #     Entities are partitioned into subsets, currently identified by a project
+        #     ID and namespace ID.
+        #     Queries are scoped to a single partition.
+        # @!attribute [rw] path
+        #   @return [Array<Google::Privacy::Dlp::V2::Key::PathElement>]
+        #     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.
+        class 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.
+          # @!attribute [rw] kind
+          #   @return [String]
+          #     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 +""+.
+          # @!attribute [rw] id
+          #   @return [Integer]
+          #     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.
+          # @!attribute [rw] name
+          #   @return [String]
+          #     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 +""+.
+          class PathElement; end
+        end
+
+        # Message for a unique key indicating a record that contains a finding.
+        # @!attribute [rw] datastore_key
+        #   @return [Google::Privacy::Dlp::V2::DatastoreKey]
+        # @!attribute [rw] big_query_key
+        #   @return [Google::Privacy::Dlp::V2::BigQueryKey]
+        class RecordKey; end
+
+        # 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>+.
+        # @!attribute [rw] project_id
+        #   @return [String]
+        #     The Google Cloud Platform project ID of the project containing the table.
+        #     If omitted, project ID is inferred from the API call.
+        # @!attribute [rw] dataset_id
+        #   @return [String]
+        #     Dataset ID of the table.
+        # @!attribute [rw] table_id
+        #   @return [String]
+        #     Name of the table.
+        class BigQueryTable; end
+
+        # 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.
+        module 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
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dlp/v2/doc/google/protobuf/any.rb

@@ -0,0 +1,124 @@
+# Copyright 2018 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.
+
+module Google
+  module Protobuf
+    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # The JSON representation of an +Any+ value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field +@type+ which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # +value+ which holds the custom JSON in addition to the +@type+
+    # field. Example (for message {Google::Protobuf::Duration}):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name whose content describes the type of the
+    #     serialized protocol buffer message.
+    #
+    #     For URLs which use the scheme +http+, +https+, or no scheme, the
+    #     following restrictions and interpretations apply:
+    #
+    #     * If no scheme is provided, +https+ is assumed.
+    #     * The last segment of the URL's path must represent the fully
+    #       qualified name of the type (as in +path/google.protobuf.Duration+).
+    #       The name should be in a canonical form (e.g., leading "." is
+    #       not accepted).
+    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end