Class StructuredMessage (0.37.0)

public final class StructuredMessage extends GeneratedMessageV3 implements StructuredMessageOrBuilder

A rich message format, including a human readable string, a key for identifying the message, and structured data associated with the message for programmatic consumption.

Protobuf type google.dataflow.v1beta3.StructuredMessage

Static Fields

MESSAGE_KEY_FIELD_NUMBER

public static final int MESSAGE_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

MESSAGE_TEXT_FIELD_NUMBER

public static final int MESSAGE_TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StructuredMessage getDefaultInstance()
Returns
TypeDescription
StructuredMessage

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static StructuredMessage.Builder newBuilder()
Returns
TypeDescription
StructuredMessage.Builder

newBuilder(StructuredMessage prototype)

public static StructuredMessage.Builder newBuilder(StructuredMessage prototype)
Parameter
NameDescription
prototypeStructuredMessage
Returns
TypeDescription
StructuredMessage.Builder

parseDelimitedFrom(InputStream input)

public static StructuredMessage parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StructuredMessage parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StructuredMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StructuredMessage parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StructuredMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StructuredMessage parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StructuredMessage parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StructuredMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StructuredMessage parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StructuredMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredMessage
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StructuredMessage> parser()
Returns
TypeDescription
Parser<StructuredMessage>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public StructuredMessage getDefaultInstanceForType()
Returns
TypeDescription
StructuredMessage

getMessageKey()

public String getMessageKey()

Identifier for this message type. Used by external systems to internationalize or personalize message.

string message_key = 2;

Returns
TypeDescription
String

The messageKey.

getMessageKeyBytes()

public ByteString getMessageKeyBytes()

Identifier for this message type. Used by external systems to internationalize or personalize message.

string message_key = 2;

Returns
TypeDescription
ByteString

The bytes for messageKey.

getMessageText()

public String getMessageText()

Human-readable version of message.

string message_text = 1;

Returns
TypeDescription
String

The messageText.

getMessageTextBytes()

public ByteString getMessageTextBytes()

Human-readable version of message.

string message_text = 1;

Returns
TypeDescription
ByteString

The bytes for messageText.

getParameters(int index)

public StructuredMessage.Parameter getParameters(int index)

The structured data associated with this message.

repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
StructuredMessage.Parameter

getParametersCount()

public int getParametersCount()

The structured data associated with this message.

repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;

Returns
TypeDescription
int

getParametersList()

public List<StructuredMessage.Parameter> getParametersList()

The structured data associated with this message.

repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;

Returns
TypeDescription
List<Parameter>

getParametersOrBuilder(int index)

public StructuredMessage.ParameterOrBuilder getParametersOrBuilder(int index)

The structured data associated with this message.

repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
StructuredMessage.ParameterOrBuilder

getParametersOrBuilderList()

public List<? extends StructuredMessage.ParameterOrBuilder> getParametersOrBuilderList()

The structured data associated with this message.

repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;

Returns
TypeDescription
List<? extends com.google.dataflow.v1beta3.StructuredMessage.ParameterOrBuilder>

getParserForType()

public Parser<StructuredMessage> getParserForType()
Returns
TypeDescription
Parser<StructuredMessage>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StructuredMessage.Builder newBuilderForType()
Returns
TypeDescription
StructuredMessage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StructuredMessage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StructuredMessage.Builder toBuilder()
Returns
TypeDescription
StructuredMessage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException