Class StreamingPullResponse (1.131.0)

public final class StreamingPullResponse extends GeneratedMessageV3 implements StreamingPullResponseOrBuilder

Response for the StreamingPull method. This response is used to stream messages from the server to the client.

Protobuf type google.pubsub.v1.StreamingPullResponse

Static Fields

ACKNOWLEDGE_CONFIRMATION_FIELD_NUMBER

public static final int ACKNOWLEDGE_CONFIRMATION_FIELD_NUMBER
Field Value
Type Description
int

MODIFY_ACK_DEADLINE_CONFIRMATION_FIELD_NUMBER

public static final int MODIFY_ACK_DEADLINE_CONFIRMATION_FIELD_NUMBER
Field Value
Type Description
int

RECEIVED_MESSAGES_FIELD_NUMBER

public static final int RECEIVED_MESSAGES_FIELD_NUMBER
Field Value
Type Description
int

SUBSCRIPTION_PROPERTIES_FIELD_NUMBER

public static final int SUBSCRIPTION_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StreamingPullResponse getDefaultInstance()
Returns
Type Description
StreamingPullResponse

getDescriptor()

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

newBuilder()

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

newBuilder(StreamingPullResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAcknowledgeConfirmation()

public StreamingPullResponse.AcknowledgeConfirmation getAcknowledgeConfirmation()

Optional. This field will only be set if enable_exactly_once_delivery is set to true.

.google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamingPullResponse.AcknowledgeConfirmation

The acknowledgeConfirmation.

getAcknowledgeConfirmationOrBuilder()

public StreamingPullResponse.AcknowledgeConfirmationOrBuilder getAcknowledgeConfirmationOrBuilder()

Optional. This field will only be set if enable_exactly_once_delivery is set to true.

.google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamingPullResponse.AcknowledgeConfirmationOrBuilder

getDefaultInstanceForType()

public StreamingPullResponse getDefaultInstanceForType()
Returns
Type Description
StreamingPullResponse

getModifyAckDeadlineConfirmation()

public StreamingPullResponse.ModifyAckDeadlineConfirmation getModifyAckDeadlineConfirmation()

Optional. This field will only be set if enable_exactly_once_delivery is set to true.

.google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamingPullResponse.ModifyAckDeadlineConfirmation

The modifyAckDeadlineConfirmation.

getModifyAckDeadlineConfirmationOrBuilder()

public StreamingPullResponse.ModifyAckDeadlineConfirmationOrBuilder getModifyAckDeadlineConfirmationOrBuilder()

Optional. This field will only be set if enable_exactly_once_delivery is set to true.

.google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamingPullResponse.ModifyAckDeadlineConfirmationOrBuilder

getParserForType()

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

getReceivedMessages(int index)

public ReceivedMessage getReceivedMessages(int index)

Optional. Received Pub/Sub messages. This will not be empty.

repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ReceivedMessage

getReceivedMessagesCount()

public int getReceivedMessagesCount()

Optional. Received Pub/Sub messages. This will not be empty.

repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getReceivedMessagesList()

public List<ReceivedMessage> getReceivedMessagesList()

Optional. Received Pub/Sub messages. This will not be empty.

repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ReceivedMessage>

getReceivedMessagesOrBuilder(int index)

public ReceivedMessageOrBuilder getReceivedMessagesOrBuilder(int index)

Optional. Received Pub/Sub messages. This will not be empty.

repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ReceivedMessageOrBuilder

getReceivedMessagesOrBuilderList()

public List<? extends ReceivedMessageOrBuilder> getReceivedMessagesOrBuilderList()

Optional. Received Pub/Sub messages. This will not be empty.

repeated .google.pubsub.v1.ReceivedMessage received_messages = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.pubsub.v1.ReceivedMessageOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubscriptionProperties()

public StreamingPullResponse.SubscriptionProperties getSubscriptionProperties()

Optional. Properties associated with this subscription.

.google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamingPullResponse.SubscriptionProperties

The subscriptionProperties.

getSubscriptionPropertiesOrBuilder()

public StreamingPullResponse.SubscriptionPropertiesOrBuilder getSubscriptionPropertiesOrBuilder()

Optional. Properties associated with this subscription.

.google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StreamingPullResponse.SubscriptionPropertiesOrBuilder

hasAcknowledgeConfirmation()

public boolean hasAcknowledgeConfirmation()

Optional. This field will only be set if enable_exactly_once_delivery is set to true.

.google.pubsub.v1.StreamingPullResponse.AcknowledgeConfirmation acknowledge_confirmation = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the acknowledgeConfirmation field is set.

hasModifyAckDeadlineConfirmation()

public boolean hasModifyAckDeadlineConfirmation()

Optional. This field will only be set if enable_exactly_once_delivery is set to true.

.google.pubsub.v1.StreamingPullResponse.ModifyAckDeadlineConfirmation modify_ack_deadline_confirmation = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the modifyAckDeadlineConfirmation field is set.

hasSubscriptionProperties()

public boolean hasSubscriptionProperties()

Optional. Properties associated with this subscription.

.google.pubsub.v1.StreamingPullResponse.SubscriptionProperties subscription_properties = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the subscriptionProperties 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 StreamingPullResponse.Builder newBuilderForType()
Returns
Type Description
StreamingPullResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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