google-cloud-web_risk-v1beta1 0.1.0

data/proto_docs/google/cloud/webrisk/v1beta1/webrisk.rb

@@ -0,0 +1,307 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module WebRisk
+      module V1beta1
+        # Describes an API diff request.
+        # @!attribute [rw] threat_type
+        #   @return [Google::Cloud::WebRisk::V1beta1::ThreatType]
+        #     The ThreatList to update.
+        # @!attribute [rw] version_token
+        #   @return [String]
+        #     The current version token of the client for the requested list (the
+        #     client version that was received from the last successful diff).
+        # @!attribute [rw] constraints
+        #   @return [Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffRequest::Constraints]
+        #     Required. The constraints associated with this request.
+        class ComputeThreatListDiffRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # The constraints for this diff.
+          # @!attribute [rw] max_diff_entries
+          #   @return [Integer]
+          #     The maximum size in number of entries. The diff will not contain more
+          #     entries than this value.  This should be a power of 2 between 2**10 and
+          #     2**20.  If zero, no diff size limit is set.
+          # @!attribute [rw] max_database_entries
+          #   @return [Integer]
+          #     Sets the maximum number of entries that the client is willing to have
+          #     in the local database. This should be a power of 2 between 2**10 and
+          #     2**20. If zero, no database size limit is set.
+          # @!attribute [rw] supported_compressions
+          #   @return [Array<Google::Cloud::WebRisk::V1beta1::CompressionType>]
+          #     The compression types supported by the client.
+          class Constraints
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # @!attribute [rw] response_type
+        #   @return [Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse::ResponseType]
+        #     The type of response. This may indicate that an action must be taken by the
+        #     client when the response is received.
+        # @!attribute [rw] additions
+        #   @return [Google::Cloud::WebRisk::V1beta1::ThreatEntryAdditions]
+        #     A set of entries to add to a local threat type's list.
+        # @!attribute [rw] removals
+        #   @return [Google::Cloud::WebRisk::V1beta1::ThreatEntryRemovals]
+        #     A set of entries to remove from a local threat type's list.
+        #     This field may be empty.
+        # @!attribute [rw] new_version_token
+        #   @return [String]
+        #     The new opaque client version token.
+        # @!attribute [rw] checksum
+        #   @return [Google::Cloud::WebRisk::V1beta1::ComputeThreatListDiffResponse::Checksum]
+        #     The expected SHA256 hash of the client state; that is, of the sorted list
+        #     of all hashes present in the database after applying the provided diff.
+        #     If the client state doesn't match the expected state, the client must
+        #     disregard this diff and retry later.
+        # @!attribute [rw] recommended_next_diff
+        #   @return [Google::Protobuf::Timestamp]
+        #     The soonest the client should wait before issuing any diff
+        #     request. Querying sooner is unlikely to produce a meaningful diff.
+        #     Waiting longer is acceptable considering the use case.
+        #     If this field is not set clients may update as soon as they want.
+        class ComputeThreatListDiffResponse
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # The expected state of a client's local database.
+          # @!attribute [rw] sha256
+          #   @return [String]
+          #     The SHA256 hash of the client state; that is, of the sorted list of all
+          #     hashes present in the database.
+          class Checksum
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The type of response sent to the client.
+          module ResponseType
+            # Unknown.
+            RESPONSE_TYPE_UNSPECIFIED = 0
+
+            # Partial updates are applied to the client's existing local database.
+            DIFF = 1
+
+            # Full updates resets the client's entire local database. This means
+            # that either the client had no state, was seriously out-of-date,
+            # or the client is believed to be corrupt.
+            RESET = 2
+          end
+        end
+
+        # Request to check URI entries against threatLists.
+        # @!attribute [rw] uri
+        #   @return [String]
+        #     Required. The URI to be checked for matches.
+        # @!attribute [rw] threat_types
+        #   @return [Array<Google::Cloud::WebRisk::V1beta1::ThreatType>]
+        #     Required. The ThreatLists to search in.
+        class SearchUrisRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] threat
+        #   @return [Google::Cloud::WebRisk::V1beta1::SearchUrisResponse::ThreatUri]
+        #     The threat list matches. This may be empty if the URI is on no list.
+        class SearchUrisResponse
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Contains threat information on a matching uri.
+          # @!attribute [rw] threat_types
+          #   @return [Array<Google::Cloud::WebRisk::V1beta1::ThreatType>]
+          #     The ThreatList this threat belongs to.
+          # @!attribute [rw] expire_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     The cache lifetime for the returned match. Clients must not cache this
+          #     response past this timestamp to avoid false positives.
+          class ThreatUri
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Request to return full hashes matched by the provided hash prefixes.
+        # @!attribute [rw] hash_prefix
+        #   @return [String]
+        #     A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
+        #     hash. For JSON requests, this field is base64-encoded.
+        # @!attribute [rw] threat_types
+        #   @return [Array<Google::Cloud::WebRisk::V1beta1::ThreatType>]
+        #     Required. The ThreatLists to search in.
+        class SearchHashesRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # @!attribute [rw] threats
+        #   @return [Array<Google::Cloud::WebRisk::V1beta1::SearchHashesResponse::ThreatHash>]
+        #     The full hashes that matched the requested prefixes.
+        #     The hash will be populated in the key.
+        # @!attribute [rw] negative_expire_time
+        #   @return [Google::Protobuf::Timestamp]
+        #     For requested entities that did not match the threat list, how long to
+        #     cache the response until.
+        class SearchHashesResponse
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Contains threat information on a matching hash.
+          # @!attribute [rw] threat_types
+          #   @return [Array<Google::Cloud::WebRisk::V1beta1::ThreatType>]
+          #     The ThreatList this threat belongs to.
+          #     This must contain at least one entry.
+          # @!attribute [rw] hash
+          #   @return [String]
+          #     A 32 byte SHA256 hash. This field is in binary format. For JSON
+          #     requests, hashes are base64-encoded.
+          # @!attribute [rw] expire_time
+          #   @return [Google::Protobuf::Timestamp]
+          #     The cache lifetime for the returned match. Clients must not cache this
+          #     response past this timestamp to avoid false positives.
+          class ThreatHash
+            include Google::Protobuf::MessageExts
+            extend Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Contains the set of entries to add to a local database.
+        # May contain a combination of compressed and raw data in a single response.
+        # @!attribute [rw] raw_hashes
+        #   @return [Array<Google::Cloud::WebRisk::V1beta1::RawHashes>]
+        #     The raw SHA256-formatted entries.
+        #     Repeated to allow returning sets of hashes with different prefix sizes.
+        # @!attribute [rw] rice_hashes
+        #   @return [Google::Cloud::WebRisk::V1beta1::RiceDeltaEncoding]
+        #     The encoded 4-byte prefixes of SHA256-formatted entries, using a
+        #     Golomb-Rice encoding. The hashes are converted to uint32, sorted in
+        #     ascending order, then delta encoded and stored as encoded_data.
+        class ThreatEntryAdditions
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Contains the set of entries to remove from a local database.
+        # @!attribute [rw] raw_indices
+        #   @return [Google::Cloud::WebRisk::V1beta1::RawIndices]
+        #     The raw removal indices for a local list.
+        # @!attribute [rw] rice_indices
+        #   @return [Google::Cloud::WebRisk::V1beta1::RiceDeltaEncoding]
+        #     The encoded local, lexicographically-sorted list indices, using a
+        #     Golomb-Rice encoding. Used for sending compressed removal indices. The
+        #     removal indices (uint32) are sorted in ascending order, then delta encoded
+        #     and stored as encoded_data.
+        class ThreatEntryRemovals
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A set of raw indices to remove from a local list.
+        # @!attribute [rw] indices
+        #   @return [Array<Integer>]
+        #     The indices to remove from a lexicographically-sorted local list.
+        class RawIndices
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The uncompressed threat entries in hash format.
+        # Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4
+        # bytes, but some hashes are lengthened if they collide with the hash of a
+        # popular URI.
+        #
+        # Used for sending ThreatEntryAdditons to clients that do not support
+        # compression, or when sending non-4-byte hashes to clients that do support
+        # compression.
+        # @!attribute [rw] prefix_size
+        #   @return [Integer]
+        #     The number of bytes for each prefix encoded below.  This field can be
+        #     anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
+        # @!attribute [rw] raw_hashes
+        #   @return [String]
+        #     The hashes, in binary format, concatenated into one long string. Hashes are
+        #     sorted in lexicographic order. For JSON API users, hashes are
+        #     base64-encoded.
+        class RawHashes
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or
+        # compressed removal indices.
+        # @!attribute [rw] first_value
+        #   @return [Integer]
+        #     The offset of the first entry in the encoded data, or, if only a single
+        #     integer was encoded, that single integer's value. If the field is empty or
+        #     missing, assume zero.
+        # @!attribute [rw] rice_parameter
+        #   @return [Integer]
+        #     The Golomb-Rice parameter, which is a number between 2 and 28. This field
+        #     is missing (that is, zero) if `num_entries` is zero.
+        # @!attribute [rw] entry_count
+        #   @return [Integer]
+        #     The number of entries that are delta encoded in the encoded data. If only a
+        #     single integer was encoded, this will be zero and the single value will be
+        #     stored in `first_value`.
+        # @!attribute [rw] encoded_data
+        #   @return [String]
+        #     The encoded deltas that are encoded using the Golomb-Rice coder.
+        class RiceDeltaEncoding
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The type of threat. This maps dirrectly to the threat list a threat may
+        # belong to.
+        module ThreatType
+          # Unknown.
+          THREAT_TYPE_UNSPECIFIED = 0
+
+          # Malware targeting any platform.
+          MALWARE = 1
+
+          # Social engineering targeting any platform.
+          SOCIAL_ENGINEERING = 2
+
+          # Unwanted software targeting any platform.
+          UNWANTED_SOFTWARE = 3
+        end
+
+        # The ways in which threat entry sets can be compressed.
+        module CompressionType
+          # Unknown.
+          COMPRESSION_TYPE_UNSPECIFIED = 0
+
+          # Raw, uncompressed data.
+          RAW = 1
+
+          # Rice-Golomb encoded data.
+          RICE = 2
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/protobuf/timestamp.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Protobuf
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The 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](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+    #
+    # # 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. A proto3 JSON serializer should always use UTC (as indicated by
+    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
+    # able to accept both UTC and other timezones (as indicated by an offset).
+    #
+    # 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://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
+    # ) 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
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: google-cloud-web_risk-v1beta1
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Google LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gapic-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.24.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Web Risk is an enterprise security product that lets your client applications
+  check URLs against Google's constantly updated lists of unsafe web resources.
+email: googleapis-packages@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- AUTHENTICATION.md
+- LICENSE.md
+- README.md
+- lib/google-cloud-web_risk-v1beta1.rb
+- lib/google/cloud/web_risk/v1beta1.rb
+- lib/google/cloud/web_risk/v1beta1/version.rb
+- lib/google/cloud/web_risk/v1beta1/web_risk_service.rb
+- lib/google/cloud/web_risk/v1beta1/web_risk_service/client.rb
+- lib/google/cloud/web_risk/v1beta1/web_risk_service/credentials.rb
+- lib/google/cloud/webrisk/v1beta1/webrisk_pb.rb
+- lib/google/cloud/webrisk/v1beta1/webrisk_services_pb.rb
+- proto_docs/README.md
+- proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/resource.rb
+- proto_docs/google/cloud/webrisk/v1beta1/webrisk.rb
+- proto_docs/google/protobuf/timestamp.rb
+homepage: https://github.com/googleapis/google-cloud-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: API Client library for the Web Risk V1beta1 API
+test_files: []