Class: Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/webrisk/v1/webrisk.rb

Defined Under Namespace

Modules: ResponseType Classes: Checksum

Instance Attribute Summary collapse

Instance Attribute Details

#additions ⇒ ::Google::Cloud::WebRisk::V1::ThreatEntryAdditions

Returns A set of entries to add to a local threat type's list.

Returns:



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
 
# File 'proto_docs/google/cloud/webrisk/v1/webrisk.rb', line 92

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

#checksum ⇒ ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse::Checksum

Returns 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 discard this diff and retry later.

Returns:



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
 
# File 'proto_docs/google/cloud/webrisk/v1/webrisk.rb', line 92

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

#new_version_token ⇒ ::String

Returns The new opaque client version token. This should be retained by the client and passed into the next call of ComputeThreatListDiff as 'version_token'. A separate version token should be stored and used for each threatList.

Returns:

  • (::String) —

    The new opaque client version token. This should be retained by the client and passed into the next call of ComputeThreatListDiff as 'version_token'. A separate version token should be stored and used for each threatList.



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
 
# File 'proto_docs/google/cloud/webrisk/v1/webrisk.rb', line 92

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

#recommended_next_diff ⇒ ::Google::Protobuf::Timestamp

Returns 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.

Returns:

  • (::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.



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
 
# File 'proto_docs/google/cloud/webrisk/v1/webrisk.rb', line 92

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

#removals ⇒ ::Google::Cloud::WebRisk::V1::ThreatEntryRemovals

Returns A set of entries to remove from a local threat type's list. This field may be empty.

Returns:



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
 
# File 'proto_docs/google/cloud/webrisk/v1/webrisk.rb', line 92

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

#response_type ⇒ ::Google::Cloud::WebRisk::V1::ComputeThreatListDiffResponse::ResponseType

Returns The type of response. This may indicate that an action must be taken by the client when the response is received.

Returns:



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
 
# File 'proto_docs/google/cloud/webrisk/v1/webrisk.rb', line 92

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