public static final class ReceivedMessage.Builder extends GeneratedMessageV3.Builder<ReceivedMessage.Builder> implements ReceivedMessageOrBuilderA message and its corresponding acknowledgment ID.
Protobuf type google.pubsub.v1.ReceivedMessage
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ReceivedMessage.BuilderImplements
ReceivedMessageOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReceivedMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
build()
public ReceivedMessage build()| Returns | |
|---|---|
| Type | Description |
ReceivedMessage | |
buildPartial()
public ReceivedMessage buildPartial()| Returns | |
|---|---|
| Type | Description |
ReceivedMessage | |
clear()
public ReceivedMessage.Builder clear()| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
clearAckId()
public ReceivedMessage.Builder clearAckId()This ID can be used to acknowledge the received message.
string ack_id = 1;
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | This builder for chaining. |
clearDeliveryAttempt()
public ReceivedMessage.Builder clearDeliveryAttempt()The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.
More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message.
A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library.
Upon the first delivery of a given message, delivery_attempt will have a
value of 1. The value is calculated at best effort and is approximate.
If a DeadLetterPolicy is not set on the subscription, this will be 0.
int32 delivery_attempt = 3;
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ReceivedMessage.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
clearMessage()
public ReceivedMessage.Builder clearMessage()The message.
.google.pubsub.v1.PubsubMessage message = 2;
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public ReceivedMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
clone()
public ReceivedMessage.Builder clone()| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
getAckId()
public String getAckId()This ID can be used to acknowledge the received message.
string ack_id = 1;
| Returns | |
|---|---|
| Type | Description |
String | The ackId. |
getAckIdBytes()
public ByteString getAckIdBytes()This ID can be used to acknowledge the received message.
string ack_id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for ackId. |
getDefaultInstanceForType()
public ReceivedMessage getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ReceivedMessage | |
getDeliveryAttempt()
public int getDeliveryAttempt()The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.
More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message.
A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library.
Upon the first delivery of a given message, delivery_attempt will have a
value of 1. The value is calculated at best effort and is approximate.
If a DeadLetterPolicy is not set on the subscription, this will be 0.
int32 delivery_attempt = 3;
| Returns | |
|---|---|
| Type | Description |
int | The deliveryAttempt. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getMessage()
public PubsubMessage getMessage()The message.
.google.pubsub.v1.PubsubMessage message = 2;
| Returns | |
|---|---|
| Type | Description |
PubsubMessage | The message. |
getMessageBuilder()
public PubsubMessage.Builder getMessageBuilder()The message.
.google.pubsub.v1.PubsubMessage message = 2;
| Returns | |
|---|---|
| Type | Description |
PubsubMessage.Builder | |
getMessageOrBuilder()
public PubsubMessageOrBuilder getMessageOrBuilder()The message.
.google.pubsub.v1.PubsubMessage message = 2;
| Returns | |
|---|---|
| Type | Description |
PubsubMessageOrBuilder | |
hasMessage()
public boolean hasMessage()The message.
.google.pubsub.v1.PubsubMessage message = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the message field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ReceivedMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ReceivedMessage.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
mergeFrom(ReceivedMessage other)
public ReceivedMessage.Builder mergeFrom(ReceivedMessage other)| Parameter | |
|---|---|
| Name | Description |
other | ReceivedMessage |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
mergeMessage(PubsubMessage value)
public ReceivedMessage.Builder mergeMessage(PubsubMessage value)The message.
.google.pubsub.v1.PubsubMessage message = 2;
| Parameter | |
|---|---|
| Name | Description |
value | PubsubMessage |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ReceivedMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
setAckId(String value)
public ReceivedMessage.Builder setAckId(String value)This ID can be used to acknowledge the received message.
string ack_id = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe ackId to set. |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | This builder for chaining. |
setAckIdBytes(ByteString value)
public ReceivedMessage.Builder setAckIdBytes(ByteString value)This ID can be used to acknowledge the received message.
string ack_id = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for ackId to set. |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | This builder for chaining. |
setDeliveryAttempt(int value)
public ReceivedMessage.Builder setDeliveryAttempt(int value)The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.
More precisely, this is 1 + (number of NACKs) + (number of ack_deadline exceeds) for this message.
A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library.
Upon the first delivery of a given message, delivery_attempt will have a
value of 1. The value is calculated at best effort and is approximate.
If a DeadLetterPolicy is not set on the subscription, this will be 0.
int32 delivery_attempt = 3;
| Parameter | |
|---|---|
| Name | Description |
value | intThe deliveryAttempt to set. |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ReceivedMessage.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
setMessage(PubsubMessage value)
public ReceivedMessage.Builder setMessage(PubsubMessage value)The message.
.google.pubsub.v1.PubsubMessage message = 2;
| Parameter | |
|---|---|
| Name | Description |
value | PubsubMessage |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
setMessage(PubsubMessage.Builder builderForValue)
public ReceivedMessage.Builder setMessage(PubsubMessage.Builder builderForValue)The message.
.google.pubsub.v1.PubsubMessage message = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | PubsubMessage.Builder |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReceivedMessage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ReceivedMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ReceivedMessage.Builder | |