Class ControlledMode (0.1.0)

public final class ControlledMode extends GeneratedMessageV3 implements ControlledModeOrBuilder

The options for receiver under the controlled mode.

Protobuf type google.cloud.visionai.v1.ControlledMode

Static Fields

FALLBACK_STARTING_OFFSET_FIELD_NUMBER

public static final int FALLBACK_STARTING_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

STARTING_LOGICAL_OFFSET_FIELD_NUMBER

public static final int STARTING_LOGICAL_OFFSET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ControlledMode getDefaultInstance()
Returns
Type Description
ControlledMode

getDescriptor()

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

newBuilder()

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

newBuilder(ControlledMode prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ControlledMode getDefaultInstanceForType()
Returns
Type Description
ControlledMode

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.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 ControlledMode.Builder newBuilderForType()
Returns
Type Description
ControlledMode.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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