com.google.pubsub.v1

Class ReceivedMessage.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

com.google.pubsub.v1.ReceivedMessage.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ReceivedMessageOrBuilder, Cloneable

Enclosing class:

ReceivedMessage

public static final class ReceivedMessage.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>
implements ReceivedMessageOrBuilder

 A message and its corresponding acknowledgment ID.
 

Protobuf type google.pubsub.v1.ReceivedMessage

Method Summary

Modifier and Type	Method and Description
ReceivedMessage.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ReceivedMessage	build()
ReceivedMessage	buildPartial()
ReceivedMessage.Builder	clear()
ReceivedMessage.Builder	clearAckId() This ID can be used to acknowledge the received message.
ReceivedMessage.Builder	clearDeliveryAttempt() The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.
ReceivedMessage.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ReceivedMessage.Builder	clearMessage() The message.
ReceivedMessage.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ReceivedMessage.Builder	clone()
String	getAckId() This ID can be used to acknowledge the received message.
com.google.protobuf.ByteString	getAckIdBytes() This ID can be used to acknowledge the received message.
ReceivedMessage	getDefaultInstanceForType()
int	getDeliveryAttempt() The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
PubsubMessage	getMessage() The message.
PubsubMessage.Builder	getMessageBuilder() The message.
PubsubMessageOrBuilder	getMessageOrBuilder() The message.
boolean	hasMessage() The message.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ReceivedMessage.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ReceivedMessage.Builder	mergeFrom(com.google.protobuf.Message other)
ReceivedMessage.Builder	mergeFrom(ReceivedMessage other)
ReceivedMessage.Builder	mergeMessage(PubsubMessage value) The message.
ReceivedMessage.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ReceivedMessage.Builder	setAckId(String value) This ID can be used to acknowledge the received message.
ReceivedMessage.Builder	setAckIdBytes(com.google.protobuf.ByteString value) This ID can be used to acknowledge the received message.
ReceivedMessage.Builder	setDeliveryAttempt(int value) The approximate number of times that Cloud Pub/Sub has attempted to deliver the associated message to a subscriber.
ReceivedMessage.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ReceivedMessage.Builder	setMessage(PubsubMessage.Builder builderForValue) The message.
ReceivedMessage.Builder	setMessage(PubsubMessage value) The message.
ReceivedMessage.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ReceivedMessage.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

clear

public ReceivedMessage.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

getDefaultInstanceForType

public ReceivedMessage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ReceivedMessage build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ReceivedMessage buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ReceivedMessage.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

setField

public ReceivedMessage.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

clearField

public ReceivedMessage.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

clearOneof

public ReceivedMessage.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

setRepeatedField

public ReceivedMessage.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

addRepeatedField

public ReceivedMessage.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

mergeFrom

public ReceivedMessage.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReceivedMessage.Builder>

mergeFrom

public ReceivedMessage.Builder mergeFrom(ReceivedMessage other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

mergeFrom

public ReceivedMessage.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ReceivedMessage.Builder>

Throws:

IOException

getAckId

public String getAckId()

 This ID can be used to acknowledge the received message.
 

string ack_id = 1;

Specified by:

getAckId in interface ReceivedMessageOrBuilder

Returns:

The ackId.

getAckIdBytes

public com.google.protobuf.ByteString getAckIdBytes()

 This ID can be used to acknowledge the received message.
 

string ack_id = 1;

Specified by:

getAckIdBytes in interface ReceivedMessageOrBuilder

Returns:

The bytes for ackId.

setAckId

public ReceivedMessage.Builder setAckId(String value)

 This ID can be used to acknowledge the received message.
 

string ack_id = 1;

Parameters:

value - The ackId to set.

Returns:

This builder for chaining.

clearAckId

public ReceivedMessage.Builder clearAckId()

 This ID can be used to acknowledge the received message.
 

string ack_id = 1;

Returns:

This builder for chaining.

setAckIdBytes

public ReceivedMessage.Builder setAckIdBytes(com.google.protobuf.ByteString value)

 This ID can be used to acknowledge the received message.
 

string ack_id = 1;

Parameters:

value - The bytes for ackId to set.

Returns:

This builder for chaining.

hasMessage

public boolean hasMessage()

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

Specified by:

hasMessage in interface ReceivedMessageOrBuilder

Returns:

Whether the message field is set.

getMessage

public PubsubMessage getMessage()

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

Specified by:

getMessage in interface ReceivedMessageOrBuilder

Returns:

The message.

setMessage

public ReceivedMessage.Builder setMessage(PubsubMessage value)

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

setMessage

public ReceivedMessage.Builder setMessage(PubsubMessage.Builder builderForValue)

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

mergeMessage

public ReceivedMessage.Builder mergeMessage(PubsubMessage value)

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

clearMessage

public ReceivedMessage.Builder clearMessage()

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

getMessageBuilder

public PubsubMessage.Builder getMessageBuilder()

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

getMessageOrBuilder

public PubsubMessageOrBuilder getMessageOrBuilder()

 The message.
 

.google.pubsub.v1.PubsubMessage message = 2;

Specified by:

getMessageOrBuilder in interface ReceivedMessageOrBuilder

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;

Specified by:

getDeliveryAttempt in interface ReceivedMessageOrBuilder

Returns:

The deliveryAttempt.

setDeliveryAttempt

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;

Parameters:

value - The deliveryAttempt to set.

Returns:

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:

This builder for chaining.

setUnknownFields

public final ReceivedMessage.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>

mergeUnknownFields

public final ReceivedMessage.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ReceivedMessage.Builder>