Class Retrohunt (0.2.0)

public final class Retrohunt extends GeneratedMessageV3 implements RetrohuntOrBuilder

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

Protobuf type google.cloud.chronicle.v1.Retrohunt

Implements

RetrohuntOrBuilder

Static Fields

EXECUTION_INTERVAL_FIELD_NUMBER

public static final int EXECUTION_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROCESS_INTERVAL_FIELD_NUMBER

public static final int PROCESS_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_PERCENTAGE_FIELD_NUMBER

public static final int PROGRESS_PERCENTAGE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Retrohunt getDefaultInstance()
Returns
Type Description
Retrohunt

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Retrohunt.Builder newBuilder()
Returns
Type Description
Retrohunt.Builder

newBuilder(Retrohunt prototype)

public static Retrohunt.Builder newBuilder(Retrohunt prototype)
Parameter
Name Description
prototype Retrohunt
Returns
Type Description
Retrohunt.Builder

parseDelimitedFrom(InputStream input)

public static Retrohunt parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Retrohunt
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Retrohunt parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Retrohunt
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Retrohunt parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Retrohunt
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Retrohunt parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Retrohunt
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Retrohunt parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Retrohunt
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Retrohunt parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Retrohunt
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Retrohunt parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Retrohunt
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Retrohunt parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Retrohunt
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Retrohunt parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Retrohunt
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Retrohunt parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Retrohunt
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Retrohunt parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Retrohunt
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Retrohunt parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Retrohunt
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Retrohunt> parser()
Returns
Type Description
Parser<Retrohunt>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Retrohunt getDefaultInstanceForType()
Returns
Type Description
Retrohunt

getExecutionInterval()

public Interval getExecutionInterval()

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.

.google.type.Interval execution_interval = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Interval

The executionInterval.

getExecutionIntervalOrBuilder()

public IntervalOrBuilder getExecutionIntervalOrBuilder()

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.

.google.type.Interval execution_interval = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.IntervalOrBuilder

getName()

public String getName()

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}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Retrohunt> getParserForType()
Returns
Type Description
Parser<Retrohunt>
Overrides

getProcessInterval()

public Interval getProcessInterval()

Required. The start and end time of the event time range this retrohunt processes.

.google.type.Interval process_interval = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.Interval

The processInterval.

getProcessIntervalOrBuilder()

public IntervalOrBuilder getProcessIntervalOrBuilder()

Required. The start and end time of the event time range this retrohunt processes.

.google.type.Interval process_interval = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
com.google.type.IntervalOrBuilder

getProgressPercentage()

public float getProgressPercentage()

Output only. Percent progress of the retrohunt towards completion, from 0.00 to 100.00.

float progress_percentage = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The progressPercentage.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public Retrohunt.State getState()

Output only. The state of the retrohunt.

.google.cloud.chronicle.v1.Retrohunt.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Retrohunt.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the retrohunt.

.google.cloud.chronicle.v1.Retrohunt.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasExecutionInterval()

public boolean hasExecutionInterval()

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.

.google.type.Interval execution_interval = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the executionInterval field is set.

hasProcessInterval()

public boolean hasProcessInterval()

Required. The start and end time of the event time range this retrohunt processes.

.google.type.Interval process_interval = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the processInterval field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Retrohunt.Builder newBuilderForType()
Returns
Type Description
Retrohunt.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Retrohunt.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Retrohunt.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Retrohunt.Builder toBuilder()
Returns
Type Description
Retrohunt.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException