Chronicle V1 API - Class Google::Backstory::FindingVariable (v1.4.0)

1.4.0 (latest) 1.3.0 1.2.0 1.1.0 1.0.1 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.1 0.2.0 0.1.0

Reference documentation and code samples for the Chronicle V1 API class Google::Backstory::FindingVariable.

A structure that holds the value and associated metadata for values extracted while producing a Finding.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#bool_seq

def bool_seq() -> ::Google::Backstory::BoolSequence

Returns

• (::Google::Backstory::BoolSequence) — The value in boolsequence format.

  Note: The following fields are mutually exclusive: bool_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bool_seq=

def bool_seq=(value) -> ::Google::Backstory::BoolSequence

Parameter

• value (::Google::Backstory::BoolSequence) — The value in boolsequence format.

  Note: The following fields are mutually exclusive: bool_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Backstory::BoolSequence) — The value in boolsequence format.

  Note: The following fields are mutually exclusive: bool_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bool_val

def bool_val() -> ::Boolean

Returns

• (::Boolean) — The value in boolean format.

  Note: The following fields are mutually exclusive: bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bool_val=

def bool_val=(value) -> ::Boolean

Parameter

• value (::Boolean) — The value in boolean format.

  Note: The following fields are mutually exclusive: bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Boolean) — The value in boolean format.

  Note: The following fields are mutually exclusive: bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bytes_seq

def bytes_seq() -> ::Google::Backstory::BytesSequence

Returns

• (::Google::Backstory::BytesSequence) — The value in bytessequence format.

  Note: The following fields are mutually exclusive: bytes_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bytes_seq=

def bytes_seq=(value) -> ::Google::Backstory::BytesSequence

Parameter

• value (::Google::Backstory::BytesSequence) — The value in bytessequence format.

  Note: The following fields are mutually exclusive: bytes_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Backstory::BytesSequence) — The value in bytessequence format.

  Note: The following fields are mutually exclusive: bytes_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bytes_val

def bytes_val() -> ::String

Returns

• (::String) — The value in bytes format.

  Note: The following fields are mutually exclusive: bytes_val, bool_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#bytes_val=

def bytes_val=(value) -> ::String

Parameter

• value (::String) — The value in bytes format.

  Note: The following fields are mutually exclusive: bytes_val, bool_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — The value in bytes format.

  Note: The following fields are mutually exclusive: bytes_val, bool_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_seq

def double_seq() -> ::Google::Backstory::DoubleSequence

Returns

• (::Google::Backstory::DoubleSequence) — The value in doublesequence format.

  Note: The following fields are mutually exclusive: double_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_seq=

def double_seq=(value) -> ::Google::Backstory::DoubleSequence

Parameter

• value (::Google::Backstory::DoubleSequence) — The value in doublesequence format.

  Note: The following fields are mutually exclusive: double_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Backstory::DoubleSequence) — The value in doublesequence format.

  Note: The following fields are mutually exclusive: double_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_val

def double_val() -> ::Float

Returns

• (::Float) — The value in double format.

  Note: The following fields are mutually exclusive: double_val, bool_val, bytes_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_val=

def double_val=(value) -> ::Float

Parameter

• value (::Float) — The value in double format.

  Note: The following fields are mutually exclusive: double_val, bool_val, bytes_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Float) — The value in double format.

  Note: The following fields are mutually exclusive: double_val, bool_val, bytes_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#int64_seq

def int64_seq() -> ::Google::Backstory::Int64Sequence

Returns

• (::Google::Backstory::Int64Sequence) — The value in int64sequence format.

  Note: The following fields are mutually exclusive: int64_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#int64_seq=

def int64_seq=(value) -> ::Google::Backstory::Int64Sequence

Parameter

• value (::Google::Backstory::Int64Sequence) — The value in int64sequence format.

  Note: The following fields are mutually exclusive: int64_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Backstory::Int64Sequence) — The value in int64sequence format.

  Note: The following fields are mutually exclusive: int64_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#int64_val

def int64_val() -> ::Integer

Returns

• (::Integer) — The value in int64 format.

  Note: The following fields are mutually exclusive: int64_val, bool_val, bytes_val, double_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#int64_val=

def int64_val=(value) -> ::Integer

Parameter

• value (::Integer) — The value in int64 format.

  Note: The following fields are mutually exclusive: int64_val, bool_val, bytes_val, double_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Integer) — The value in int64 format.

  Note: The following fields are mutually exclusive: int64_val, bool_val, bytes_val, double_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#null_val

def null_val() -> ::Boolean

Returns

• (::Boolean) — Whether the value is null.

  Note: The following fields are mutually exclusive: null_val, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#null_val=

def null_val=(value) -> ::Boolean

Parameter

• value (::Boolean) — Whether the value is null.

  Note: The following fields are mutually exclusive: null_val, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Boolean) — Whether the value is null.

  Note: The following fields are mutually exclusive: null_val, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#source_path

def source_path() -> ::String

Returns

• (::String) — The UDM field path for the field which this value was derived from. Example: principal.user.username

#source_path=

def source_path=(value) -> ::String

Parameter

• value (::String) — The UDM field path for the field which this value was derived from. Example: principal.user.username

Returns

• (::String) — The UDM field path for the field which this value was derived from. Example: principal.user.username

#string_seq

def string_seq() -> ::Google::Backstory::StringSequence

Returns

• (::Google::Backstory::StringSequence) — The value in stringsequence format.

  Note: The following fields are mutually exclusive: string_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#string_seq=

def string_seq=(value) -> ::Google::Backstory::StringSequence

Parameter

• value (::Google::Backstory::StringSequence) — The value in stringsequence format.

  Note: The following fields are mutually exclusive: string_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Backstory::StringSequence) — The value in stringsequence format.

  Note: The following fields are mutually exclusive: string_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#string_val

def string_val() -> ::String

Returns

• (::String) — The value in string format. Enum values are returned as strings.

  Note: The following fields are mutually exclusive: string_val, bool_val, bytes_val, double_val, int64_val, uint64_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#string_val=

def string_val=(value) -> ::String

Parameter

• value (::String) — The value in string format. Enum values are returned as strings.

  Note: The following fields are mutually exclusive: string_val, bool_val, bytes_val, double_val, int64_val, uint64_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — The value in string format. Enum values are returned as strings.

  Note: The following fields are mutually exclusive: string_val, bool_val, bytes_val, double_val, int64_val, uint64_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#timestamp_time

def timestamp_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — The value in timestamp format.

  Note: The following fields are mutually exclusive: timestamp_time, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#timestamp_time=

def timestamp_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — The value in timestamp format.

  Note: The following fields are mutually exclusive: timestamp_time, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::Timestamp) — The value in timestamp format.

  Note: The following fields are mutually exclusive: timestamp_time, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#type

def type() -> ::Google::Backstory::FindingVariable::Type

Returns

• (::Google::Backstory::FindingVariable::Type) — The type of the variable.

#type=

def type=(value) -> ::Google::Backstory::FindingVariable::Type

Parameter

• value (::Google::Backstory::FindingVariable::Type) — The type of the variable.

Returns

• (::Google::Backstory::FindingVariable::Type) — The type of the variable.

#uint64_seq

def uint64_seq() -> ::Google::Backstory::Uint64Sequence

Returns

• (::Google::Backstory::Uint64Sequence) — The value in uint64sequence format.

  Note: The following fields are mutually exclusive: uint64_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#uint64_seq=

def uint64_seq=(value) -> ::Google::Backstory::Uint64Sequence

Parameter

• value (::Google::Backstory::Uint64Sequence) — The value in uint64sequence format.

  Note: The following fields are mutually exclusive: uint64_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Backstory::Uint64Sequence) — The value in uint64sequence format.

  Note: The following fields are mutually exclusive: uint64_seq, bool_val, bytes_val, double_val, int64_val, uint64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#uint64_val

def uint64_val() -> ::Integer

Returns

• (::Integer) — The value in uint64 format.

  Note: The following fields are mutually exclusive: uint64_val, bool_val, bytes_val, double_val, int64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#uint64_val=

def uint64_val=(value) -> ::Integer

Parameter

• value (::Integer) — The value in uint64 format.

  Note: The following fields are mutually exclusive: uint64_val, bool_val, bytes_val, double_val, int64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Integer) — The value in uint64 format.

  Note: The following fields are mutually exclusive: uint64_val, bool_val, bytes_val, double_val, int64_val, string_val, timestamp_time, null_val, bool_seq, bytes_seq, double_seq, int64_seq, uint64_seq, string_seq. If a field in that set is populated, all other fields in the set will automatically be cleared.

#value

def value() -> ::String

Returns

• (::String) — The value in string form.

#value=

def value=(value) -> ::String

Parameter

• value (::String) — The value in string form.

Returns

• (::String) — The value in string form.