Class ControlledMode.Builder (0.40.0)

public static final class ControlledMode.Builder extends GeneratedMessage.Builder<ControlledMode.Builder> implements ControlledModeOrBuilder

The options for receiver under the controlled mode.

Protobuf type google.cloud.visionai.v1.ControlledMode

Static Methods

getDescriptor()

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

Methods

build()

public ControlledMode build()
Returns
Type Description
ControlledMode

buildPartial()

public ControlledMode buildPartial()
Returns
Type Description
ControlledMode

clear()

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

clearFallbackStartingOffset()

public ControlledMode.Builder clearFallbackStartingOffset()

This is the logical starting point to fallback upon should the specified starting offset be unavailable.

This can be one of the following values:

"begin": This will read from the earliest available message.

"end": This will read only future messages.

string fallback_starting_offset = 2;

Returns
Type Description
ControlledMode.Builder

This builder for chaining.

clearStartingLogicalOffset()

public ControlledMode.Builder clearStartingLogicalOffset()

This can be set to the following logical starting points:

"begin": This will read from the earliest available message.

"most-recent": This will read from the latest available message.

"end": This will read only future messages.

"stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.

string starting_logical_offset = 1;

Returns
Type Description
ControlledMode.Builder

This builder for chaining.

clearStartingOffset()

public ControlledMode.Builder clearStartingOffset()
Returns
Type Description
ControlledMode.Builder

getDefaultInstanceForType()

public ControlledMode getDefaultInstanceForType()
Returns
Type Description
ControlledMode

getDescriptorForType()

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

getFallbackStartingOffset()

public String getFallbackStartingOffset()

This is the logical starting point to fallback upon should the specified starting offset be unavailable.

This can be one of the following values:

"begin": This will read from the earliest available message.

"end": This will read only future messages.

string fallback_starting_offset = 2;

Returns
Type Description
String

The fallbackStartingOffset.

getFallbackStartingOffsetBytes()

public ByteString getFallbackStartingOffsetBytes()

This is the logical starting point to fallback upon should the specified starting offset be unavailable.

This can be one of the following values:

"begin": This will read from the earliest available message.

"end": This will read only future messages.

string fallback_starting_offset = 2;

Returns
Type Description
ByteString

The bytes for fallbackStartingOffset.

getStartingLogicalOffset()

public String getStartingLogicalOffset()

This can be set to the following logical starting points:

"begin": This will read from the earliest available message.

"most-recent": This will read from the latest available message.

"end": This will read only future messages.

"stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.

string starting_logical_offset = 1;

Returns
Type Description
String

The startingLogicalOffset.

getStartingLogicalOffsetBytes()

public ByteString getStartingLogicalOffsetBytes()

This can be set to the following logical starting points:

"begin": This will read from the earliest available message.

"most-recent": This will read from the latest available message.

"end": This will read only future messages.

"stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.

string starting_logical_offset = 1;

Returns
Type Description
ByteString

The bytes for startingLogicalOffset.

getStartingOffsetCase()

public ControlledMode.StartingOffsetCase getStartingOffsetCase()
Returns
Type Description
ControlledMode.StartingOffsetCase

hasStartingLogicalOffset()

public boolean hasStartingLogicalOffset()

This can be set to the following logical starting points:

"begin": This will read from the earliest available message.

"most-recent": This will read from the latest available message.

"end": This will read only future messages.

"stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.

string starting_logical_offset = 1;

Returns
Type Description
boolean

Whether the startingLogicalOffset field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ControlledMode other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFallbackStartingOffset(String value)

public ControlledMode.Builder setFallbackStartingOffset(String value)

This is the logical starting point to fallback upon should the specified starting offset be unavailable.

This can be one of the following values:

"begin": This will read from the earliest available message.

"end": This will read only future messages.

string fallback_starting_offset = 2;

Parameter
Name Description
value String

The fallbackStartingOffset to set.

Returns
Type Description
ControlledMode.Builder

This builder for chaining.

setFallbackStartingOffsetBytes(ByteString value)

public ControlledMode.Builder setFallbackStartingOffsetBytes(ByteString value)

This is the logical starting point to fallback upon should the specified starting offset be unavailable.

This can be one of the following values:

"begin": This will read from the earliest available message.

"end": This will read only future messages.

string fallback_starting_offset = 2;

Parameter
Name Description
value ByteString

The bytes for fallbackStartingOffset to set.

Returns
Type Description
ControlledMode.Builder

This builder for chaining.

setStartingLogicalOffset(String value)

public ControlledMode.Builder setStartingLogicalOffset(String value)

This can be set to the following logical starting points:

"begin": This will read from the earliest available message.

"most-recent": This will read from the latest available message.

"end": This will read only future messages.

"stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.

string starting_logical_offset = 1;

Parameter
Name Description
value String

The startingLogicalOffset to set.

Returns
Type Description
ControlledMode.Builder

This builder for chaining.

setStartingLogicalOffsetBytes(ByteString value)

public ControlledMode.Builder setStartingLogicalOffsetBytes(ByteString value)

This can be set to the following logical starting points:

"begin": This will read from the earliest available message.

"most-recent": This will read from the latest available message.

"end": This will read only future messages.

"stored": This will resume reads one past the last committed offset. It is the only option that resumes progress; all others jump unilaterally.

string starting_logical_offset = 1;

Parameter
Name Description
value ByteString

The bytes for startingLogicalOffset to set.

Returns
Type Description
ControlledMode.Builder

This builder for chaining.