Class ReceiveEventsRequest.SetupRequest (0.3.0) 

public static final class ReceiveEventsRequest.SetupRequest extends GeneratedMessageV3 implements ReceiveEventsRequest.SetupRequestOrBuilder

SetupRequest is the first message sent to the service to setup the RPC connection.

Protobuf type google.cloud.visionai.v1.ReceiveEventsRequest.SetupRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ReceiveEventsRequest.SetupRequest

Static Fields

CLUSTER_FIELD_NUMBER

public static final int CLUSTER_FIELD_NUMBER
Field Value
Type Description
int

CONTROLLED_MODE_FIELD_NUMBER

public static final int CONTROLLED_MODE_FIELD_NUMBER
Field Value
Type Description
int

HEARTBEAT_INTERVAL_FIELD_NUMBER

public static final int HEARTBEAT_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

RECEIVER_FIELD_NUMBER

public static final int RECEIVER_FIELD_NUMBER
Field Value
Type Description
int

STREAM_FIELD_NUMBER

public static final int STREAM_FIELD_NUMBER
Field Value
Type Description
int

WRITES_DONE_GRACE_PERIOD_FIELD_NUMBER

public static final int WRITES_DONE_GRACE_PERIOD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReceiveEventsRequest.SetupRequest getDefaultInstance()
Returns
Type Description
ReceiveEventsRequest.SetupRequest

getDescriptor()

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

newBuilder()

public static ReceiveEventsRequest.SetupRequest.Builder newBuilder()
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

newBuilder(ReceiveEventsRequest.SetupRequest prototype)

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

parseDelimitedFrom(InputStream input)

public static ReceiveEventsRequest.SetupRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReceiveEventsRequest.SetupRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ReceiveEventsRequest.SetupRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReceiveEventsRequest.SetupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ReceiveEventsRequest.SetupRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReceiveEventsRequest.SetupRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ReceiveEventsRequest.SetupRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReceiveEventsRequest.SetupRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ReceiveEventsRequest.SetupRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReceiveEventsRequest.SetupRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ReceiveEventsRequest.SetupRequest> parser()
Returns
Type Description
Parser<SetupRequest>

Methods

equals(Object obj)

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

getCluster()

public String getCluster()

The cluster name.

string cluster = 1;

Returns
Type Description
String

The cluster.

getClusterBytes()

public ByteString getClusterBytes()

The cluster name.

string cluster = 1;

Returns
Type Description
ByteString

The bytes for cluster.

getControlledMode()

public ControlledMode getControlledMode()

Controller mode configuration for receiving events from the server.

.google.cloud.visionai.v1.ControlledMode controlled_mode = 4;

Returns
Type Description
ControlledMode

The controlledMode.

getControlledModeOrBuilder()

public ControlledModeOrBuilder getControlledModeOrBuilder()

Controller mode configuration for receiving events from the server.

.google.cloud.visionai.v1.ControlledMode controlled_mode = 4;

Returns
Type Description
ControlledModeOrBuilder

getDefaultInstanceForType()

public ReceiveEventsRequest.SetupRequest getDefaultInstanceForType()
Returns
Type Description
ReceiveEventsRequest.SetupRequest

getHeartbeatInterval()

public Duration getHeartbeatInterval()

The maximum duration of server silence before the client determines the server unreachable.

The client must either receive an Event update or a heart beat message before this duration expires; otherwise, the client will automatically cancel the current connection and retry.

.google.protobuf.Duration heartbeat_interval = 5;

Returns
Type Description
Duration

The heartbeatInterval.

getHeartbeatIntervalOrBuilder()

public DurationOrBuilder getHeartbeatIntervalOrBuilder()

The maximum duration of server silence before the client determines the server unreachable.

The client must either receive an Event update or a heart beat message before this duration expires; otherwise, the client will automatically cancel the current connection and retry.

.google.protobuf.Duration heartbeat_interval = 5;

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<ReceiveEventsRequest.SetupRequest> getParserForType()
Returns
Type Description
Parser<SetupRequest>
Overrides

getReceiver()

public String getReceiver()

A name for the receiver to self-identify.

This is used to keep track of a receiver's read progress.

string receiver = 3;

Returns
Type Description
String

The receiver.

getReceiverBytes()

public ByteString getReceiverBytes()

A name for the receiver to self-identify.

This is used to keep track of a receiver's read progress.

string receiver = 3;

Returns
Type Description
ByteString

The bytes for receiver.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStream()

public String getStream()

The stream name. The service will return the events for the given stream.

string stream = 2;

Returns
Type Description
String

The stream.

getStreamBytes()

public ByteString getStreamBytes()

The stream name. The service will return the events for the given stream.

string stream = 2;

Returns
Type Description
ByteString

The bytes for stream.

getWritesDoneGracePeriod()

public Duration getWritesDoneGracePeriod()

The grace period after which a writes_done_request is issued, that a WritesDone is expected from the client.

The server is free to cancel the RPC should this expire.

A system default will be chosen if unset.

.google.protobuf.Duration writes_done_grace_period = 6;

Returns
Type Description
Duration

The writesDoneGracePeriod.

getWritesDoneGracePeriodOrBuilder()

public DurationOrBuilder getWritesDoneGracePeriodOrBuilder()

The grace period after which a writes_done_request is issued, that a WritesDone is expected from the client.

The server is free to cancel the RPC should this expire.

A system default will be chosen if unset.

.google.protobuf.Duration writes_done_grace_period = 6;

Returns
Type Description
DurationOrBuilder

hasControlledMode()

public boolean hasControlledMode()

Controller mode configuration for receiving events from the server.

.google.cloud.visionai.v1.ControlledMode controlled_mode = 4;

Returns
Type Description
boolean

Whether the controlledMode field is set.

hasHeartbeatInterval()

public boolean hasHeartbeatInterval()

The maximum duration of server silence before the client determines the server unreachable.

The client must either receive an Event update or a heart beat message before this duration expires; otherwise, the client will automatically cancel the current connection and retry.

.google.protobuf.Duration heartbeat_interval = 5;

Returns
Type Description
boolean

Whether the heartbeatInterval field is set.

hasWritesDoneGracePeriod()

public boolean hasWritesDoneGracePeriod()

The grace period after which a writes_done_request is issued, that a WritesDone is expected from the client.

The server is free to cancel the RPC should this expire.

A system default will be chosen if unset.

.google.protobuf.Duration writes_done_grace_period = 6;

Returns
Type Description
boolean

Whether the writesDoneGracePeriod 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 ReceiveEventsRequest.SetupRequest.Builder newBuilderForType()
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ReceiveEventsRequest.SetupRequest.Builder toBuilder()
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

writeTo(CodedOutputStream output)

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