google-cloud-dlp 0.1.0

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

@@ -0,0 +1,258 @@
+# Copyright 2017 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 V2beta1
+        # 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::V2beta1::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] dictionary
+        #   @return [Google::Privacy::Dlp::V2beta1::CustomInfoType::Dictionary]
+        #     Dictionary-based 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::V2beta1::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
+        end
+
+        # General identifier of a data field in a storage service.
+        # @!attribute [rw] column_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
+
+        # A reference to a property relative to the Datastore kind expressions.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The name of the property.
+        #     If name includes "."s, it may be interpreted as a property name path.
+        class PropertyReference; end
+
+        # A representation of a Datastore property in a projection.
+        # @!attribute [rw] property
+        #   @return [Google::Privacy::Dlp::V2beta1::PropertyReference]
+        #     The property to project.
+        class Projection; end
+
+        # Options defining a data set within Google Cloud Datastore.
+        # @!attribute [rw] partition_id
+        #   @return [Google::Privacy::Dlp::V2beta1::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::V2beta1::KindExpression]
+        #     The kind to process.
+        # @!attribute [rw] projection
+        #   @return [Array<Google::Privacy::Dlp::V2beta1::Projection>]
+        #     Properties to scan. If none are specified, all properties will be scanned
+        #     by default.
+        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::V2beta1::CloudStorageOptions::FileSet]
+        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
+
+        # A location in Cloud Storage.
+        # @!attribute [rw] path
+        #   @return [String]
+        #     The url, in the format of +gs://bucket/<path>+.
+        class CloudStoragePath; end
+
+        # Options defining BigQuery table and row identifiers.
+        # @!attribute [rw] table_reference
+        #   @return [Google::Privacy::Dlp::V2beta1::BigQueryTable]
+        #     Complete BigQuery table reference.
+        # @!attribute [rw] identifying_fields
+        #   @return [Array<Google::Privacy::Dlp::V2beta1::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::V2beta1::DatastoreOptions]
+        #     Google Cloud Datastore options specification.
+        # @!attribute [rw] cloud_storage_options
+        #   @return [Google::Privacy::Dlp::V2beta1::CloudStorageOptions]
+        #     Google Cloud Storage options specification.
+        # @!attribute [rw] big_query_options
+        #   @return [Google::Privacy::Dlp::V2beta1::BigQueryOptions]
+        #     BigQuery options specification.
+        class StorageConfig; end
+
+        # Record key for a finding in a Cloud Storage file.
+        # @!attribute [rw] file_path
+        #   @return [String]
+        #     Path to the file.
+        # @!attribute [rw] start_offset
+        #   @return [Integer]
+        #     Byte offset of the referenced data in the file.
+        class CloudStorageKey; end
+
+        # Record key for a finding in Cloud Datastore.
+        # @!attribute [rw] entity_key
+        #   @return [Google::Privacy::Dlp::V2beta1::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::V2beta1::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::V2beta1::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] cloud_storage_key
+        #   @return [Google::Privacy::Dlp::V2beta1::CloudStorageKey]
+        # @!attribute [rw] datastore_key
+        #   @return [Google::Privacy::Dlp::V2beta1::DatastoreKey]
+        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
+
+        # 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.
+        # @!attribute [rw] field
+        #   @return [Google::Privacy::Dlp::V2beta1::FieldId]
+        #     Composite key indicating which field contains the entity identifier.
+        class EntityId; end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# Copyright 2017 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

data/lib/google/cloud/dlp/v2beta1/doc/google/protobuf/timestamp.rb

@@ -0,0 +1,106 @@
+# Copyright 2017 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
+    # A Timestamp represents a point in time independent of any time zone
+    # or calendar, represented as seconds and fractions of seconds at
+    # nanosecond resolution in UTC Epoch time. It is encoded using the
+    # Proleptic Gregorian Calendar which extends the Gregorian calendar
+    # backwards to year one. It is encoded assuming all minutes are 60
+    # seconds long, i.e. leap seconds are "smeared" so that no leap second
+    # table is needed for interpretation. Range is from
+    # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
+    # By restricting to that range, we ensure that we can convert to
+    # and from  RFC 3339 date strings.
+    # See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
+    #
+    # = Examples
+    #
+    # Example 1: Compute Timestamp from POSIX +time()+.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    #
+    # Example 5: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
+    # where {year} is always expressed using four digits while {month}, {day},
+    # {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required, though only UTC (as indicated by "Z") is presently supported.
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 01:30 UTC on January 15, 2017.
+    #
+    # In JavaScript, one can convert a Date object to this format using the
+    # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
+    # method. In Python, a standard +datetime.datetime+ object can be converted
+    # to this format using [+strftime+](https://docs.python.org/2/library/time.html#time.strftime)
+    # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
+    # can use the Joda Time's [+ISODateTimeFormat.dateTime()+](
+    # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime())
+    # to obtain a formatter capable of generating timestamps in this format.
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp; end
+  end
+end