The maximum duration of server silence before the client determines the
server unreachable.
The client must either receive a Packet or a heart beat message before
this duration expires; otherwise, the client will automatically cancel
the current connection and retry.
The maximum duration of server silence before the client determines the
server unreachable.
The client must either receive a Packet or a heart beat message before
this duration expires; otherwise, the client will automatically cancel
the current connection and retry.
The maximum duration of server silence before the client determines the
server unreachable.
The client must either receive a Packet or a heart beat message before
this duration expires; otherwise, the client will automatically cancel
the current connection and retry.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Interface ReceivePacketsRequest.SetupRequestOrBuilder (0.29.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.29.0 (latest)](/java/docs/reference/google-cloud-visionai/latest/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.27.0](/java/docs/reference/google-cloud-visionai/0.27.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.25.0](/java/docs/reference/google-cloud-visionai/0.25.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.24.0](/java/docs/reference/google-cloud-visionai/0.24.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.21.0](/java/docs/reference/google-cloud-visionai/0.21.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.20.0](/java/docs/reference/google-cloud-visionai/0.20.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.19.0](/java/docs/reference/google-cloud-visionai/0.19.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.17.0](/java/docs/reference/google-cloud-visionai/0.17.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.16.0](/java/docs/reference/google-cloud-visionai/0.16.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.15.0](/java/docs/reference/google-cloud-visionai/0.15.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.14.0](/java/docs/reference/google-cloud-visionai/0.14.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.13.0](/java/docs/reference/google-cloud-visionai/0.13.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.12.0](/java/docs/reference/google-cloud-visionai/0.12.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.11.0](/java/docs/reference/google-cloud-visionai/0.11.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.10.0](/java/docs/reference/google-cloud-visionai/0.10.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.9.0](/java/docs/reference/google-cloud-visionai/0.9.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.8.0](/java/docs/reference/google-cloud-visionai/0.8.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.6.0](/java/docs/reference/google-cloud-visionai/0.6.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.5.0](/java/docs/reference/google-cloud-visionai/0.5.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.4.0](/java/docs/reference/google-cloud-visionai/0.4.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.3.0](/java/docs/reference/google-cloud-visionai/0.3.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.2.0](/java/docs/reference/google-cloud-visionai/0.2.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder)\n- [0.1.0](/java/docs/reference/google-cloud-visionai/0.1.0/com.google.cloud.visionai.v1.ReceivePacketsRequest.SetupRequestOrBuilder) \n\n public static interface ReceivePacketsRequest.SetupRequestOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getConsumerModeCase()\n\n public abstract ReceivePacketsRequest.SetupRequest.ConsumerModeCase getConsumerModeCase()\n\n### getControlledReceiveMode()\n\n public abstract ControlledMode getControlledReceiveMode()\n\nOptions for configuring controlled mode.\n\n`.google.cloud.visionai.v1.ControlledMode controlled_receive_mode = 4;`\n\n### getControlledReceiveModeOrBuilder()\n\n public abstract ControlledModeOrBuilder getControlledReceiveModeOrBuilder()\n\nOptions for configuring controlled mode.\n\n`.google.cloud.visionai.v1.ControlledMode controlled_receive_mode = 4;`\n\n### getEagerReceiveMode()\n\n public abstract EagerMode getEagerReceiveMode()\n\nOptions for configuring eager mode.\n\n`.google.cloud.visionai.v1.EagerMode eager_receive_mode = 3;`\n\n### getEagerReceiveModeOrBuilder()\n\n public abstract EagerModeOrBuilder getEagerReceiveModeOrBuilder()\n\nOptions for configuring eager mode.\n\n`.google.cloud.visionai.v1.EagerMode eager_receive_mode = 3;`\n\n### getHeartbeatInterval()\n\n public abstract Duration getHeartbeatInterval()\n\nThe maximum duration of server silence before the client determines the\nserver unreachable.\n\nThe client must either receive a `Packet` or a heart beat message before\nthis duration expires; otherwise, the client will automatically cancel\nthe current connection and retry.\n\n`.google.protobuf.Duration heartbeat_interval = 5;`\n\n### getHeartbeatIntervalOrBuilder()\n\n public abstract DurationOrBuilder getHeartbeatIntervalOrBuilder()\n\nThe maximum duration of server silence before the client determines the\nserver unreachable.\n\nThe client must either receive a `Packet` or a heart beat message before\nthis duration expires; otherwise, the client will automatically cancel\nthe current connection and retry.\n\n`.google.protobuf.Duration heartbeat_interval = 5;`\n\n### getMetadata()\n\n public abstract RequestMetadata getMetadata()\n\nThe configurations that specify where packets are retrieved.\n\n`.google.cloud.visionai.v1.RequestMetadata metadata = 1;`\n\n### getMetadataOrBuilder()\n\n public abstract RequestMetadataOrBuilder getMetadataOrBuilder()\n\nThe configurations that specify where packets are retrieved.\n\n`.google.cloud.visionai.v1.RequestMetadata metadata = 1;`\n\n### getReceiver()\n\n public abstract String getReceiver()\n\nA name for the receiver to self-identify.\n\nThis is used to keep track of a receiver's read progress.\n\n`string receiver = 2;`\n\n### getReceiverBytes()\n\n public abstract ByteString getReceiverBytes()\n\nA name for the receiver to self-identify.\n\nThis is used to keep track of a receiver's read progress.\n\n`string receiver = 2;`\n\n### getWritesDoneGracePeriod()\n\n public abstract Duration getWritesDoneGracePeriod()\n\nThe grace period after which a `writes_done_request` is issued, that a\n`WritesDone` is expected from the client.\n\nThe server is free to cancel the RPC should this expire.\n\nA system default will be chosen if unset.\n\n`.google.protobuf.Duration writes_done_grace_period = 6;`\n\n### getWritesDoneGracePeriodOrBuilder()\n\n public abstract DurationOrBuilder getWritesDoneGracePeriodOrBuilder()\n\nThe grace period after which a `writes_done_request` is issued, that a\n`WritesDone` is expected from the client.\n\nThe server is free to cancel the RPC should this expire.\n\nA system default will be chosen if unset.\n\n`.google.protobuf.Duration writes_done_grace_period = 6;`\n\n### hasControlledReceiveMode()\n\n public abstract boolean hasControlledReceiveMode()\n\nOptions for configuring controlled mode.\n\n`.google.cloud.visionai.v1.ControlledMode controlled_receive_mode = 4;`\n\n### hasEagerReceiveMode()\n\n public abstract boolean hasEagerReceiveMode()\n\nOptions for configuring eager mode.\n\n`.google.cloud.visionai.v1.EagerMode eager_receive_mode = 3;`\n\n### hasHeartbeatInterval()\n\n public abstract boolean hasHeartbeatInterval()\n\nThe maximum duration of server silence before the client determines the\nserver unreachable.\n\nThe client must either receive a `Packet` or a heart beat message before\nthis duration expires; otherwise, the client will automatically cancel\nthe current connection and retry.\n\n`.google.protobuf.Duration heartbeat_interval = 5;`\n\n### hasMetadata()\n\n public abstract boolean hasMetadata()\n\nThe configurations that specify where packets are retrieved.\n\n`.google.cloud.visionai.v1.RequestMetadata metadata = 1;`\n\n### hasWritesDoneGracePeriod()\n\n public abstract boolean hasWritesDoneGracePeriod()\n\nThe grace period after which a `writes_done_request` is issued, that a\n`WritesDone` is expected from the client.\n\nThe server is free to cancel the RPC should this expire.\n\nA system default will be chosen if unset.\n\n`.google.protobuf.Duration writes_done_grace_period = 6;`"]]