Chronicle V1 API - Class Google::Cloud::Chronicle::V1::Watchlist (v0.1.0)

Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::Watchlist.

A watchlist is a list of entities that allows for bulk operations over the included entities.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description of the watchlist.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description of the watchlist.
Returns
  • (::String) — Optional. Description of the watchlist.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).
Returns
  • (::String) — Required. Display name of the watchlist. Note that it must be at least one character and less than 63 characters (https://google.aip.dev/148).

#entity_count

def entity_count() -> ::Google::Cloud::Chronicle::V1::Watchlist::EntityCount
Returns

#entity_population_mechanism

def entity_population_mechanism() -> ::Google::Cloud::Chronicle::V1::Watchlist::EntityPopulationMechanism
Returns

#entity_population_mechanism=

def entity_population_mechanism=(value) -> ::Google::Cloud::Chronicle::V1::Watchlist::EntityPopulationMechanism
Parameter
Returns

#multiplying_factor

def multiplying_factor() -> ::Float
Returns
  • (::Float) — Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.

#multiplying_factor=

def multiplying_factor=(value) -> ::Float
Parameter
  • value (::Float) — Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
Returns
  • (::Float) — Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}
Returns
  • (::String) — Identifier. Resource name of the watchlist. Format: projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist}

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#watchlist_user_preferences

def watchlist_user_preferences() -> ::Google::Cloud::Chronicle::V1::WatchlistUserPreferences
Returns

#watchlist_user_preferences=

def watchlist_user_preferences=(value) -> ::Google::Cloud::Chronicle::V1::WatchlistUserPreferences
Parameter
Returns