Class Retrohunt.Builder (0.23.0)

public static final class Retrohunt.Builder extends GeneratedMessage.Builder<Retrohunt.Builder> 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 Methods

getDescriptor()

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

Methods

build()

public Retrohunt build()
Returns
Type Description
Retrohunt

buildPartial()

public Retrohunt buildPartial()
Returns
Type Description
Retrohunt

clear()

public Retrohunt.Builder clear()
Returns
Type Description
Retrohunt.Builder
Overrides

clearExecutionInterval()

public Retrohunt.Builder clearExecutionInterval()

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
Retrohunt.Builder

clearName()

public Retrohunt.Builder clearName()

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
Retrohunt.Builder

This builder for chaining.

clearProcessInterval()

public Retrohunt.Builder clearProcessInterval()

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
Retrohunt.Builder

clearProgressPercentage()

public Retrohunt.Builder clearProgressPercentage()

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
Retrohunt.Builder

This builder for chaining.

clearState()

public Retrohunt.Builder clearState()

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

This builder for chaining.

getDefaultInstanceForType()

public Retrohunt getDefaultInstanceForType()
Returns
Type Description
Retrohunt

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExecutionIntervalBuilder()

public Interval.Builder getExecutionIntervalBuilder()

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

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.

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.

getProcessIntervalBuilder()

public Interval.Builder getProcessIntervalBuilder()

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExecutionInterval(Interval value)

public Retrohunt.Builder mergeExecutionInterval(Interval value)

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];

Parameter
Name Description
value com.google.type.Interval
Returns
Type Description
Retrohunt.Builder

mergeFrom(Retrohunt other)

public Retrohunt.Builder mergeFrom(Retrohunt other)
Parameter
Name Description
other Retrohunt
Returns
Type Description
Retrohunt.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Retrohunt.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Retrohunt.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Retrohunt.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Retrohunt.Builder
Overrides

mergeProcessInterval(Interval value)

public Retrohunt.Builder mergeProcessInterval(Interval value)

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];

Parameter
Name Description
value com.google.type.Interval
Returns
Type Description
Retrohunt.Builder

setExecutionInterval(Interval value)

public Retrohunt.Builder setExecutionInterval(Interval value)

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];

Parameter
Name Description
value com.google.type.Interval
Returns
Type Description
Retrohunt.Builder

setExecutionInterval(Interval.Builder builderForValue)

public Retrohunt.Builder setExecutionInterval(Interval.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.type.Interval.Builder
Returns
Type Description
Retrohunt.Builder

setName(String value)

public Retrohunt.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Retrohunt.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Retrohunt.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Retrohunt.Builder

This builder for chaining.

setProcessInterval(Interval value)

public Retrohunt.Builder setProcessInterval(Interval value)

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];

Parameter
Name Description
value com.google.type.Interval
Returns
Type Description
Retrohunt.Builder

setProcessInterval(Interval.Builder builderForValue)

public Retrohunt.Builder setProcessInterval(Interval.Builder builderForValue)

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];

Parameter
Name Description
builderForValue com.google.type.Interval.Builder
Returns
Type Description
Retrohunt.Builder

setProgressPercentage(float value)

public Retrohunt.Builder setProgressPercentage(float value)

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];

Parameter
Name Description
value float

The progressPercentage to set.

Returns
Type Description
Retrohunt.Builder

This builder for chaining.

setState(Retrohunt.State value)

public Retrohunt.Builder setState(Retrohunt.State value)

Output only. The state of the retrohunt.

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

Parameter
Name Description
value Retrohunt.State

The state to set.

Returns
Type Description
Retrohunt.Builder

This builder for chaining.

setStateValue(int value)

public Retrohunt.Builder setStateValue(int value)

Output only. The state of the retrohunt.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
Retrohunt.Builder

This builder for chaining.