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

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

Retrohunt is an execution of a Rule over a time range in the past.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#execution_interval

def execution_interval() -> ::Google::Type::Interval
Returns
  • (::Google::Type::Interval) — Output only. The start and end time of the retrohunt execution. If the retrohunt is not yet finished, the end time of the interval will not be populated.

#name

def name() -> ::String
Returns
  • (::String) — The resource name of the retrohunt. Retrohunt is the child of a rule revision. {rule} in the format below is structured as {rule_id@revision_id}. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The resource name of the retrohunt. Retrohunt is the child of a rule revision. {rule} in the format below is structured as {rule_id@revision_id}. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}
Returns
  • (::String) — The resource name of the retrohunt. Retrohunt is the child of a rule revision. {rule} in the format below is structured as {rule_id@revision_id}. Format: projects/{project}/locations/{location}/instances/{instance}/rules/{rule}/retrohunts/{retrohunt}

#process_interval

def process_interval() -> ::Google::Type::Interval
Returns

#process_interval=

def process_interval=(value) -> ::Google::Type::Interval
Parameter
  • value (::Google::Type::Interval) — Required. The start and end time of the event time range this retrohunt processes.
Returns

#progress_percentage

def progress_percentage() -> ::Float
Returns
  • (::Float) — Output only. Percent progress of the retrohunt towards completion, from 0.00 to 100.00.

#state

def state() -> ::Google::Cloud::Chronicle::V1::Retrohunt::State
Returns