1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
|
# Copyright 2015 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.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module SafebrowsingV4
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
# `Empty` is empty JSON object ````.
class GoogleProtobufEmpty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# The expected state of a client's local database.
class GoogleSecuritySafebrowsingV4Checksum
include Google::Apis::Core::Hashable
# The SHA256 hash of the client state; that is, of the sorted list of all hashes
# present in the database.
# Corresponds to the JSON property `sha256`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :sha256
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@sha256 = args[:sha256] if args.key?(:sha256)
end
end
# The client metadata associated with Safe Browsing API requests.
class GoogleSecuritySafebrowsingV4ClientInfo
include Google::Apis::Core::Hashable
# A client ID that (hopefully) uniquely identifies the client implementation of
# the Safe Browsing API.
# Corresponds to the JSON property `clientId`
# @return [String]
attr_accessor :client_id
# The version of the client implementation.
# Corresponds to the JSON property `clientVersion`
# @return [String]
attr_accessor :client_version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client_id = args[:client_id] if args.key?(:client_id)
@client_version = args[:client_version] if args.key?(:client_version)
end
end
# Describes a Safe Browsing API update request. Clients can request updates for
# multiple lists in a single request. NOTE: Field index 2 is unused. NEXT: 5
class GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest
include Google::Apis::Core::Hashable
# The client metadata associated with Safe Browsing API requests.
# Corresponds to the JSON property `client`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ClientInfo]
attr_accessor :client
# The requested threat list updates.
# Corresponds to the JSON property `listUpdateRequests`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest>]
attr_accessor :list_update_requests
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client = args[:client] if args.key?(:client)
@list_update_requests = args[:list_update_requests] if args.key?(:list_update_requests)
end
end
# A single list update request.
class GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest
include Google::Apis::Core::Hashable
# The constraints for this update.
# Corresponds to the JSON property `constraints`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints]
attr_accessor :constraints
# The type of platform at risk by entries present in the list.
# Corresponds to the JSON property `platformType`
# @return [String]
attr_accessor :platform_type
# The current state of the client for the requested list (the encrypted client
# state that was received from the last successful list update).
# Corresponds to the JSON property `state`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :state
# The types of entries present in the list.
# Corresponds to the JSON property `threatEntryType`
# @return [String]
attr_accessor :threat_entry_type
# The type of threat posed by entries present in the list.
# Corresponds to the JSON property `threatType`
# @return [String]
attr_accessor :threat_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@constraints = args[:constraints] if args.key?(:constraints)
@platform_type = args[:platform_type] if args.key?(:platform_type)
@state = args[:state] if args.key?(:state)
@threat_entry_type = args[:threat_entry_type] if args.key?(:threat_entry_type)
@threat_type = args[:threat_type] if args.key?(:threat_type)
end
end
# The constraints for this update.
class GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints
include Google::Apis::Core::Hashable
# A client's physical location, expressed as a ISO 31166-1 alpha-2 region code.
# Corresponds to the JSON property `deviceLocation`
# @return [String]
attr_accessor :device_location
# Requests the lists for a specific language. Expects ISO 639 alpha-2 format.
# Corresponds to the JSON property `language`
# @return [String]
attr_accessor :language
# Sets the maximum number of entries that the client is willing to have in the
# local database for the specified list. This should be a power of 2 between 2**
# 10 and 2**20. If zero, no database size limit is set.
# Corresponds to the JSON property `maxDatabaseEntries`
# @return [Fixnum]
attr_accessor :max_database_entries
# The maximum size in number of entries. The update will not contain more
# entries than this value. This should be a power of 2 between 2**10 and 2**20.
# If zero, no update size limit is set.
# Corresponds to the JSON property `maxUpdateEntries`
# @return [Fixnum]
attr_accessor :max_update_entries
# Requests the list for a specific geographic location. If not set the server
# may pick that value based on the user's IP address. Expects ISO 3166-1 alpha-2
# format.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# The compression types supported by the client.
# Corresponds to the JSON property `supportedCompressions`
# @return [Array<String>]
attr_accessor :supported_compressions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@device_location = args[:device_location] if args.key?(:device_location)
@language = args[:language] if args.key?(:language)
@max_database_entries = args[:max_database_entries] if args.key?(:max_database_entries)
@max_update_entries = args[:max_update_entries] if args.key?(:max_update_entries)
@region = args[:region] if args.key?(:region)
@supported_compressions = args[:supported_compressions] if args.key?(:supported_compressions)
end
end
#
class GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse
include Google::Apis::Core::Hashable
# The list updates requested by the clients.
# Corresponds to the JSON property `listUpdateResponses`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse>]
attr_accessor :list_update_responses
# The minimum duration the client must wait before issuing any update request.
# If this field is not set clients may update as soon as they want.
# Corresponds to the JSON property `minimumWaitDuration`
# @return [String]
attr_accessor :minimum_wait_duration
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@list_update_responses = args[:list_update_responses] if args.key?(:list_update_responses)
@minimum_wait_duration = args[:minimum_wait_duration] if args.key?(:minimum_wait_duration)
end
end
# An update to an individual list.
class GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse
include Google::Apis::Core::Hashable
# A set of entries to add to a local threat type's list. Repeated to allow for a
# combination of compressed and raw data to be sent in a single response.
# Corresponds to the JSON property `additions`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatEntrySet>]
attr_accessor :additions
# The expected state of a client's local database.
# Corresponds to the JSON property `checksum`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4Checksum]
attr_accessor :checksum
# The new client state, in encrypted format. Opaque to clients.
# Corresponds to the JSON property `newClientState`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :new_client_state
# The platform type for which data is returned.
# Corresponds to the JSON property `platformType`
# @return [String]
attr_accessor :platform_type
# A set of entries to remove from a local threat type's list. In practice, this
# field is empty or contains exactly one ThreatEntrySet.
# Corresponds to the JSON property `removals`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatEntrySet>]
attr_accessor :removals
# The type of response. This may indicate that an action is required by the
# client when the response is received.
# Corresponds to the JSON property `responseType`
# @return [String]
attr_accessor :response_type
# The format of the threats.
# Corresponds to the JSON property `threatEntryType`
# @return [String]
attr_accessor :threat_entry_type
# The threat type for which data is returned.
# Corresponds to the JSON property `threatType`
# @return [String]
attr_accessor :threat_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@additions = args[:additions] if args.key?(:additions)
@checksum = args[:checksum] if args.key?(:checksum)
@new_client_state = args[:new_client_state] if args.key?(:new_client_state)
@platform_type = args[:platform_type] if args.key?(:platform_type)
@removals = args[:removals] if args.key?(:removals)
@response_type = args[:response_type] if args.key?(:response_type)
@threat_entry_type = args[:threat_entry_type] if args.key?(:threat_entry_type)
@threat_type = args[:threat_type] if args.key?(:threat_type)
end
end
# Request to return full hashes matched by the provided hash prefixes.
class GoogleSecuritySafebrowsingV4FindFullHashesRequest
include Google::Apis::Core::Hashable
# The client metadata associated with Safe Browsing API requests.
# Corresponds to the JSON property `apiClient`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ClientInfo]
attr_accessor :api_client
# The client metadata associated with Safe Browsing API requests.
# Corresponds to the JSON property `client`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ClientInfo]
attr_accessor :client
# The current client states for each of the client's local threat lists.
# Corresponds to the JSON property `clientStates`
# @return [Array<String>]
attr_accessor :client_states
# The information regarding one or more threats that a client submits when
# checking for matches in threat lists.
# Corresponds to the JSON property `threatInfo`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatInfo]
attr_accessor :threat_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@api_client = args[:api_client] if args.key?(:api_client)
@client = args[:client] if args.key?(:client)
@client_states = args[:client_states] if args.key?(:client_states)
@threat_info = args[:threat_info] if args.key?(:threat_info)
end
end
#
class GoogleSecuritySafebrowsingV4FindFullHashesResponse
include Google::Apis::Core::Hashable
# The full hashes that matched the requested prefixes.
# Corresponds to the JSON property `matches`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatMatch>]
attr_accessor :matches
# The minimum duration the client must wait before issuing any find hashes
# request. If this field is not set, clients can issue a request as soon as they
# want.
# Corresponds to the JSON property `minimumWaitDuration`
# @return [String]
attr_accessor :minimum_wait_duration
# For requested entities that did not match the threat list, how long to cache
# the response.
# Corresponds to the JSON property `negativeCacheDuration`
# @return [String]
attr_accessor :negative_cache_duration
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@matches = args[:matches] if args.key?(:matches)
@minimum_wait_duration = args[:minimum_wait_duration] if args.key?(:minimum_wait_duration)
@negative_cache_duration = args[:negative_cache_duration] if args.key?(:negative_cache_duration)
end
end
# Request to check entries against lists.
class GoogleSecuritySafebrowsingV4FindThreatMatchesRequest
include Google::Apis::Core::Hashable
# The client metadata associated with Safe Browsing API requests.
# Corresponds to the JSON property `client`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ClientInfo]
attr_accessor :client
# The information regarding one or more threats that a client submits when
# checking for matches in threat lists.
# Corresponds to the JSON property `threatInfo`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatInfo]
attr_accessor :threat_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client = args[:client] if args.key?(:client)
@threat_info = args[:threat_info] if args.key?(:threat_info)
end
end
#
class GoogleSecuritySafebrowsingV4FindThreatMatchesResponse
include Google::Apis::Core::Hashable
# The threat list matches.
# Corresponds to the JSON property `matches`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatMatch>]
attr_accessor :matches
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@matches = args[:matches] if args.key?(:matches)
end
end
#
class GoogleSecuritySafebrowsingV4ListThreatListsResponse
include Google::Apis::Core::Hashable
# The lists available for download by the client.
# Corresponds to the JSON property `threatLists`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatListDescriptor>]
attr_accessor :threat_lists
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@threat_lists = args[:threat_lists] if args.key?(:threat_lists)
end
end
# The uncompressed threat entries in hash format of a particular prefix length.
# 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 URL. Used for sending ThreatEntrySet to clients that do not support
# compression, or when sending non-4-byte hashes to clients that do support
# compression.
class GoogleSecuritySafebrowsingV4RawHashes
include Google::Apis::Core::Hashable
# The number of bytes for each prefix encoded below. This field can be anywhere
# from 4 (shortest prefix) to 32 (full SHA256 hash).
# Corresponds to the JSON property `prefixSize`
# @return [Fixnum]
attr_accessor :prefix_size
# The hashes, in binary format, concatenated into one long string. Hashes are
# sorted in lexicographic order. For JSON API users, hashes are base64-encoded.
# Corresponds to the JSON property `rawHashes`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :raw_hashes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@prefix_size = args[:prefix_size] if args.key?(:prefix_size)
@raw_hashes = args[:raw_hashes] if args.key?(:raw_hashes)
end
end
# A set of raw indices to remove from a local list.
class GoogleSecuritySafebrowsingV4RawIndices
include Google::Apis::Core::Hashable
# The indices to remove from a lexicographically-sorted local list.
# Corresponds to the JSON property `indices`
# @return [Array<Fixnum>]
attr_accessor :indices
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@indices = args[:indices] if args.key?(:indices)
end
end
# The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or
# compressed removal indices.
class GoogleSecuritySafebrowsingV4RiceDeltaEncoding
include Google::Apis::Core::Hashable
# The encoded deltas that are encoded using the Golomb-Rice coder.
# Corresponds to the JSON property `encodedData`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :encoded_data
# 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.
# Corresponds to the JSON property `firstValue`
# @return [Fixnum]
attr_accessor :first_value
# 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`.
# Corresponds to the JSON property `numEntries`
# @return [Fixnum]
attr_accessor :num_entries
# The Golomb-Rice parameter, which is a number between 2 and 28. This field is
# missing (that is, zero) if `num_entries` is zero.
# Corresponds to the JSON property `riceParameter`
# @return [Fixnum]
attr_accessor :rice_parameter
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@encoded_data = args[:encoded_data] if args.key?(:encoded_data)
@first_value = args[:first_value] if args.key?(:first_value)
@num_entries = args[:num_entries] if args.key?(:num_entries)
@rice_parameter = args[:rice_parameter] if args.key?(:rice_parameter)
end
end
# An individual threat; for example, a malicious URL or its hash representation.
# Only one of these fields should be set.
class GoogleSecuritySafebrowsingV4ThreatEntry
include Google::Apis::Core::Hashable
# The digest of an executable in SHA256 format. The API supports both binary and
# hex digests. For JSON requests, digests are base64-encoded.
# Corresponds to the JSON property `digest`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :digest
# A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash.
# This field is in binary format. For JSON requests, hashes are base64-encoded.
# Corresponds to the JSON property `hash`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :hash_prop
# A URL.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@digest = args[:digest] if args.key?(:digest)
@hash_prop = args[:hash_prop] if args.key?(:hash_prop)
@url = args[:url] if args.key?(:url)
end
end
# The metadata associated with a specific threat entry. The client is expected
# to know the metadata key/value pairs associated with each threat type.
class GoogleSecuritySafebrowsingV4ThreatEntryMetadata
include Google::Apis::Core::Hashable
# The metadata entries.
# Corresponds to the JSON property `entries`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry>]
attr_accessor :entries
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@entries = args[:entries] if args.key?(:entries)
end
end
# A single metadata entry.
class GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry
include Google::Apis::Core::Hashable
# The metadata entry key. For JSON requests, the key is base64-encoded.
# Corresponds to the JSON property `key`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :key
# The metadata entry value. For JSON requests, the value is base64-encoded.
# Corresponds to the JSON property `value`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
# A set of threats that should be added or removed from a client's local
# database.
class GoogleSecuritySafebrowsingV4ThreatEntrySet
include Google::Apis::Core::Hashable
# The compression type for the entries in this set.
# Corresponds to the JSON property `compressionType`
# @return [String]
attr_accessor :compression_type
# The uncompressed threat entries in hash format of a particular prefix length.
# 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 URL. Used for sending ThreatEntrySet to clients that do not support
# compression, or when sending non-4-byte hashes to clients that do support
# compression.
# Corresponds to the JSON property `rawHashes`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4RawHashes]
attr_accessor :raw_hashes
# A set of raw indices to remove from a local list.
# Corresponds to the JSON property `rawIndices`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4RawIndices]
attr_accessor :raw_indices
# The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or
# compressed removal indices.
# Corresponds to the JSON property `riceHashes`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4RiceDeltaEncoding]
attr_accessor :rice_hashes
# The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or
# compressed removal indices.
# Corresponds to the JSON property `riceIndices`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4RiceDeltaEncoding]
attr_accessor :rice_indices
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@compression_type = args[:compression_type] if args.key?(:compression_type)
@raw_hashes = args[:raw_hashes] if args.key?(:raw_hashes)
@raw_indices = args[:raw_indices] if args.key?(:raw_indices)
@rice_hashes = args[:rice_hashes] if args.key?(:rice_hashes)
@rice_indices = args[:rice_indices] if args.key?(:rice_indices)
end
end
#
class GoogleSecuritySafebrowsingV4ThreatHit
include Google::Apis::Core::Hashable
# The client metadata associated with Safe Browsing API requests.
# Corresponds to the JSON property `clientInfo`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ClientInfo]
attr_accessor :client_info
# An individual threat; for example, a malicious URL or its hash representation.
# Only one of these fields should be set.
# Corresponds to the JSON property `entry`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatEntry]
attr_accessor :entry
# The platform type reported.
# Corresponds to the JSON property `platformType`
# @return [String]
attr_accessor :platform_type
# The resources related to the threat hit.
# Corresponds to the JSON property `resources`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatHitThreatSource>]
attr_accessor :resources
# The threat type reported.
# Corresponds to the JSON property `threatType`
# @return [String]
attr_accessor :threat_type
# Details about the user that encountered the threat.
# Corresponds to the JSON property `userInfo`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatHitUserInfo]
attr_accessor :user_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client_info = args[:client_info] if args.key?(:client_info)
@entry = args[:entry] if args.key?(:entry)
@platform_type = args[:platform_type] if args.key?(:platform_type)
@resources = args[:resources] if args.key?(:resources)
@threat_type = args[:threat_type] if args.key?(:threat_type)
@user_info = args[:user_info] if args.key?(:user_info)
end
end
# A single resource related to a threat hit.
class GoogleSecuritySafebrowsingV4ThreatHitThreatSource
include Google::Apis::Core::Hashable
# Referrer of the resource. Only set if the referrer is available.
# Corresponds to the JSON property `referrer`
# @return [String]
attr_accessor :referrer
# The remote IP of the resource in ASCII format. Either IPv4 or IPv6.
# Corresponds to the JSON property `remoteIp`
# @return [String]
attr_accessor :remote_ip
# The type of source reported.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# The URL of the resource.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@referrer = args[:referrer] if args.key?(:referrer)
@remote_ip = args[:remote_ip] if args.key?(:remote_ip)
@type = args[:type] if args.key?(:type)
@url = args[:url] if args.key?(:url)
end
end
# Details about the user that encountered the threat.
class GoogleSecuritySafebrowsingV4ThreatHitUserInfo
include Google::Apis::Core::Hashable
# The UN M.49 region code associated with the user's location.
# Corresponds to the JSON property `regionCode`
# @return [String]
attr_accessor :region_code
# Unique user identifier defined by the client.
# Corresponds to the JSON property `userId`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :user_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@region_code = args[:region_code] if args.key?(:region_code)
@user_id = args[:user_id] if args.key?(:user_id)
end
end
# The information regarding one or more threats that a client submits when
# checking for matches in threat lists.
class GoogleSecuritySafebrowsingV4ThreatInfo
include Google::Apis::Core::Hashable
# The platform types to be checked.
# Corresponds to the JSON property `platformTypes`
# @return [Array<String>]
attr_accessor :platform_types
# The threat entries to be checked.
# Corresponds to the JSON property `threatEntries`
# @return [Array<Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatEntry>]
attr_accessor :threat_entries
# The entry types to be checked.
# Corresponds to the JSON property `threatEntryTypes`
# @return [Array<String>]
attr_accessor :threat_entry_types
# The threat types to be checked.
# Corresponds to the JSON property `threatTypes`
# @return [Array<String>]
attr_accessor :threat_types
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@platform_types = args[:platform_types] if args.key?(:platform_types)
@threat_entries = args[:threat_entries] if args.key?(:threat_entries)
@threat_entry_types = args[:threat_entry_types] if args.key?(:threat_entry_types)
@threat_types = args[:threat_types] if args.key?(:threat_types)
end
end
# Describes an individual threat list. A list is defined by three parameters:
# the type of threat posed, the type of platform targeted by the threat, and the
# type of entries in the list.
class GoogleSecuritySafebrowsingV4ThreatListDescriptor
include Google::Apis::Core::Hashable
# The platform type targeted by the list's entries.
# Corresponds to the JSON property `platformType`
# @return [String]
attr_accessor :platform_type
# The entry types contained in the list.
# Corresponds to the JSON property `threatEntryType`
# @return [String]
attr_accessor :threat_entry_type
# The threat type posed by the list's entries.
# Corresponds to the JSON property `threatType`
# @return [String]
attr_accessor :threat_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@platform_type = args[:platform_type] if args.key?(:platform_type)
@threat_entry_type = args[:threat_entry_type] if args.key?(:threat_entry_type)
@threat_type = args[:threat_type] if args.key?(:threat_type)
end
end
# A match when checking a threat entry in the Safe Browsing threat lists.
class GoogleSecuritySafebrowsingV4ThreatMatch
include Google::Apis::Core::Hashable
# The cache lifetime for the returned match. Clients must not cache this
# response for more than this duration to avoid false positives.
# Corresponds to the JSON property `cacheDuration`
# @return [String]
attr_accessor :cache_duration
# The platform type matching this threat.
# Corresponds to the JSON property `platformType`
# @return [String]
attr_accessor :platform_type
# An individual threat; for example, a malicious URL or its hash representation.
# Only one of these fields should be set.
# Corresponds to the JSON property `threat`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatEntry]
attr_accessor :threat
# The metadata associated with a specific threat entry. The client is expected
# to know the metadata key/value pairs associated with each threat type.
# Corresponds to the JSON property `threatEntryMetadata`
# @return [Google::Apis::SafebrowsingV4::GoogleSecuritySafebrowsingV4ThreatEntryMetadata]
attr_accessor :threat_entry_metadata
# The threat entry type matching this threat.
# Corresponds to the JSON property `threatEntryType`
# @return [String]
attr_accessor :threat_entry_type
# The threat type matching this threat.
# Corresponds to the JSON property `threatType`
# @return [String]
attr_accessor :threat_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cache_duration = args[:cache_duration] if args.key?(:cache_duration)
@platform_type = args[:platform_type] if args.key?(:platform_type)
@threat = args[:threat] if args.key?(:threat)
@threat_entry_metadata = args[:threat_entry_metadata] if args.key?(:threat_entry_metadata)
@threat_entry_type = args[:threat_entry_type] if args.key?(:threat_entry_type)
@threat_type = args[:threat_type] if args.key?(:threat_type)
end
end
end
end
end
|