com.google.pubsub.v1

Class PubsubMessage

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.pubsub.v1.PubsubMessage

All Implemented Interfaces:

Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, PubsubMessageOrBuilder, java.io.Serializable

public final class PubsubMessage
extends GeneratedMessage
implements PubsubMessageOrBuilder

Protobuf type google.pubsub.v1.PubsubMessage

 A message data and its attributes. The message payload must not be empty;
 it must contain either a non-empty data field, or at least one attribute.
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PubsubMessage.Builder Protobuf type google.pubsub.v1.PubsubMessage

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

GeneratedMessage.ExtendableBuilder<MessageType extends GeneratedMessage.ExtendableMessage,BuilderType extends GeneratedMessage.ExtendableBuilder>, GeneratedMessage.ExtendableMessage<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.ExtendableMessageOrBuilder<MessageType extends GeneratedMessage.ExtendableMessage>, GeneratedMessage.FieldAccessorTable, GeneratedMessage.GeneratedExtension<ContainingType extends Message,Type>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTES_FIELD_NUMBER
static int	DATA_FIELD_NUMBER
static int	MESSAGE_ID_FIELD_NUMBER
static int	PUBLISH_TIME_FIELD_NUMBER

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Optional attributes for this message.
ByteString	getData() The message payload.
static PubsubMessage	getDefaultInstance()
PubsubMessage	getDefaultInstanceForType() Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getMessageId() ID of this message, assigned by the server when the message is published.
ByteString	getMessageIdBytes() ID of this message, assigned by the server when the message is published.
Parser<PubsubMessage>	getParserForType() Gets the parser for a message of the same type as this message.
Timestamp	getPublishTime() The time at which the message was published, populated by the server when it receives the `Publish` call.
TimestampOrBuilder	getPublishTimeOrBuilder() The time at which the message was published, populated by the server when it receives the `Publish` call.
int	getSerializedSize() Get the number of bytes required to encode this message.
UnknownFieldSet	getUnknownFields() Get the UnknownFieldSet for this message.
boolean	hasPublishTime() The time at which the message was published, populated by the server when it receives the `Publish` call.
boolean	isInitialized() Returns true if all required fields in the message and all embedded messages are set, false otherwise.
static PubsubMessage.Builder	newBuilder()
static PubsubMessage.Builder	newBuilder(PubsubMessage prototype)
PubsubMessage.Builder	newBuilderForType() Constructs a new builder for a message of the same type as this message.
static PubsubMessage	parseDelimitedFrom(java.io.InputStream input)
static PubsubMessage	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(byte[] data)
static PubsubMessage	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(ByteString data)
static PubsubMessage	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(CodedInputStream input)
static PubsubMessage	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static PubsubMessage	parseFrom(java.io.InputStream input)
static PubsubMessage	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<PubsubMessage>	parser()
PubsubMessage.Builder	toBuilder() Constructs a builder initialized with the current message.
void	writeTo(CodedOutputStream output) Serializes the message and writes it to output.

Methods inherited from class com.google.protobuf.GeneratedMessage

getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, newFileScopedGeneratedExtension, newFileScopedGeneratedExtension, newMessageScopedGeneratedExtension, newMessageScopedGeneratedExtension

Methods inherited from class com.google.protobuf.AbstractMessage

equals, findInitializationErrors, getInitializationErrorString, hashCode, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTES_FIELD_NUMBER

public static final int ATTRIBUTES_FIELD_NUMBER

See Also:

Constant Field Values

MESSAGE_ID_FIELD_NUMBER

public static final int MESSAGE_ID_FIELD_NUMBER

See Also:

Constant Field Values

PUBLISH_TIME_FIELD_NUMBER

public static final int PUBLISH_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Description copied from interface: MessageOrBuilder

Get the UnknownFieldSet for this message.

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessage

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

getData

public ByteString getData()

 The message payload. For JSON requests, the value of this field must be
 base64-encoded.
 

Specified by:

getData in interface PubsubMessageOrBuilder

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

 Optional attributes for this message.
 

Specified by:

getAttributes in interface PubsubMessageOrBuilder

getMessageId

public java.lang.String getMessageId()

 ID of this message, assigned by the server when the message is published.
 Guaranteed to be unique within the topic. This value may be read by a
 subscriber that receives a `PubsubMessage` via a `Pull` call or a push
 delivery. It must not be populated by the publisher in a `Publish` call.
 

Specified by:

getMessageId in interface PubsubMessageOrBuilder

getMessageIdBytes

public ByteString getMessageIdBytes()

 ID of this message, assigned by the server when the message is published.
 Guaranteed to be unique within the topic. This value may be read by a
 subscriber that receives a `PubsubMessage` via a `Pull` call or a push
 delivery. It must not be populated by the publisher in a `Publish` call.
 

Specified by:

getMessageIdBytes in interface PubsubMessageOrBuilder

hasPublishTime

public boolean hasPublishTime()

 The time at which the message was published, populated by the server when
 it receives the `Publish` call. It must not be populated by the
 publisher in a `Publish` call.
 

Specified by:

hasPublishTime in interface PubsubMessageOrBuilder

getPublishTime

public Timestamp getPublishTime()

 The time at which the message was published, populated by the server when
 it receives the `Publish` call. It must not be populated by the
 publisher in a `Publish` call.
 

Specified by:

getPublishTime in interface PubsubMessageOrBuilder

getPublishTimeOrBuilder

public TimestampOrBuilder getPublishTimeOrBuilder()

 The time at which the message was published, populated by the server when
 it receives the `Publish` call. It must not be populated by the
 publisher in a `Publish` call.
 

Specified by:

getPublishTimeOrBuilder in interface PubsubMessageOrBuilder

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessage

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Description copied from interface: MessageLite

Serializes the message and writes it to output. This does not flush or close the stream.

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessage

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Description copied from interface: MessageLite

Get the number of bytes required to encode this message. The result is only computed on the first call and memoized after that.

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessage

parseFrom

public static PubsubMessage parseFrom(ByteString data)
                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(ByteString data,
                                      ExtensionRegistryLite extensionRegistry)
                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(byte[] data)
                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(byte[] data,
                                      ExtensionRegistryLite extensionRegistry)
                               throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static PubsubMessage parseFrom(java.io.InputStream input)
                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PubsubMessage parseFrom(java.io.InputStream input,
                                      ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PubsubMessage parseDelimitedFrom(java.io.InputStream input)
                                        throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static PubsubMessage parseDelimitedFrom(java.io.InputStream input,
                                               ExtensionRegistryLite extensionRegistry)
                                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PubsubMessage parseFrom(CodedInputStream input)
                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static PubsubMessage parseFrom(CodedInputStream input,
                                      ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public PubsubMessage.Builder newBuilderForType()

Description copied from interface: MessageLite

Constructs a new builder for a message of the same type as this message.

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static PubsubMessage.Builder newBuilder()

newBuilder

public static PubsubMessage.Builder newBuilder(PubsubMessage prototype)

toBuilder

public PubsubMessage.Builder toBuilder()

Description copied from interface: MessageLite

Constructs a builder initialized with the current message. Use this to derive a new message from the current one.

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

getDefaultInstance

public static PubsubMessage getDefaultInstance()

parser

public static Parser<PubsubMessage> parser()

getParserForType

public Parser<PubsubMessage> getParserForType()

Description copied from interface: MessageLite

Gets the parser for a message of the same type as this message.

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessage

getDefaultInstanceForType

public PubsubMessage getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder