Class ReceiveEventsRequest.SetupRequest.Builder (0.2.0)

public static final class ReceiveEventsRequest.SetupRequest.Builder extends GeneratedMessageV3.Builder<ReceiveEventsRequest.SetupRequest.Builder> 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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ReceiveEventsRequest.SetupRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
Overrides

build()

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

buildPartial()

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

clear()

public ReceiveEventsRequest.SetupRequest.Builder clear()
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
Overrides

clearCluster()

public ReceiveEventsRequest.SetupRequest.Builder clearCluster()

The cluster name.

string cluster = 1;

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

This builder for chaining.

clearControlledMode()

public ReceiveEventsRequest.SetupRequest.Builder clearControlledMode()

Controller mode configuration for receiving events from the server.

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

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ReceiveEventsRequest.SetupRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
Overrides

clearHeartbeatInterval()

public ReceiveEventsRequest.SetupRequest.Builder clearHeartbeatInterval()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public ReceiveEventsRequest.SetupRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
Overrides

clearReceiver()

public ReceiveEventsRequest.SetupRequest.Builder clearReceiver()

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

This builder for chaining.

clearStream()

public ReceiveEventsRequest.SetupRequest.Builder clearStream()

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

string stream = 2;

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

This builder for chaining.

clearWritesDoneGracePeriod()

public ReceiveEventsRequest.SetupRequest.Builder clearWritesDoneGracePeriod()

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

clone()

public ReceiveEventsRequest.SetupRequest.Builder clone()
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
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.

getControlledModeBuilder()

public ControlledMode.Builder getControlledModeBuilder()

Controller mode configuration for receiving events from the server.

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

Returns
Type Description
ControlledMode.Builder

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

getDescriptorForType()

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

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.

getHeartbeatIntervalBuilder()

public Duration.Builder getHeartbeatIntervalBuilder()

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
Builder

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

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.

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.

getWritesDoneGracePeriodBuilder()

public Duration.Builder getWritesDoneGracePeriodBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeControlledMode(ControlledMode value)

public ReceiveEventsRequest.SetupRequest.Builder mergeControlledMode(ControlledMode value)

Controller mode configuration for receiving events from the server.

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

Parameter
Name Description
value ControlledMode
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

mergeFrom(ReceiveEventsRequest.SetupRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeHeartbeatInterval(Duration value)

public ReceiveEventsRequest.SetupRequest.Builder mergeHeartbeatInterval(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ReceiveEventsRequest.SetupRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
Overrides

mergeWritesDoneGracePeriod(Duration value)

public ReceiveEventsRequest.SetupRequest.Builder mergeWritesDoneGracePeriod(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

setCluster(String value)

public ReceiveEventsRequest.SetupRequest.Builder setCluster(String value)

The cluster name.

string cluster = 1;

Parameter
Name Description
value String

The cluster to set.

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

This builder for chaining.

setClusterBytes(ByteString value)

public ReceiveEventsRequest.SetupRequest.Builder setClusterBytes(ByteString value)

The cluster name.

string cluster = 1;

Parameter
Name Description
value ByteString

The bytes for cluster to set.

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

This builder for chaining.

setControlledMode(ControlledMode value)

public ReceiveEventsRequest.SetupRequest.Builder setControlledMode(ControlledMode value)

Controller mode configuration for receiving events from the server.

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

Parameter
Name Description
value ControlledMode
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

setControlledMode(ControlledMode.Builder builderForValue)

public ReceiveEventsRequest.SetupRequest.Builder setControlledMode(ControlledMode.Builder builderForValue)

Controller mode configuration for receiving events from the server.

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

Parameter
Name Description
builderForValue ControlledMode.Builder
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ReceiveEventsRequest.SetupRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
Overrides

setHeartbeatInterval(Duration value)

public ReceiveEventsRequest.SetupRequest.Builder setHeartbeatInterval(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

setHeartbeatInterval(Duration.Builder builderForValue)

public ReceiveEventsRequest.SetupRequest.Builder setHeartbeatInterval(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

setReceiver(String value)

public ReceiveEventsRequest.SetupRequest.Builder setReceiver(String value)

A name for the receiver to self-identify.

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

string receiver = 3;

Parameter
Name Description
value String

The receiver to set.

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

This builder for chaining.

setReceiverBytes(ByteString value)

public ReceiveEventsRequest.SetupRequest.Builder setReceiverBytes(ByteString value)

A name for the receiver to self-identify.

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

string receiver = 3;

Parameter
Name Description
value ByteString

The bytes for receiver to set.

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ReceiveEventsRequest.SetupRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
Overrides

setStream(String value)

public ReceiveEventsRequest.SetupRequest.Builder setStream(String value)

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

string stream = 2;

Parameter
Name Description
value String

The stream to set.

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

This builder for chaining.

setStreamBytes(ByteString value)

public ReceiveEventsRequest.SetupRequest.Builder setStreamBytes(ByteString value)

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

string stream = 2;

Parameter
Name Description
value ByteString

The bytes for stream to set.

Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ReceiveEventsRequest.SetupRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder
Overrides

setWritesDoneGracePeriod(Duration value)

public ReceiveEventsRequest.SetupRequest.Builder setWritesDoneGracePeriod(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder

setWritesDoneGracePeriod(Duration.Builder builderForValue)

public ReceiveEventsRequest.SetupRequest.Builder setWritesDoneGracePeriod(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ReceiveEventsRequest.SetupRequest.Builder