Class StructuredMessage (0.16.0)
0.92.0 (latest)
0.91.0
0.89.0
0.87.0
0.86.0
0.85.0
0.84.0
0.82.0
0.80.0
0.79.0
0.78.0
0.77.0
0.76.0
0.74.0
0.72.0
0.71.0
0.68.0
0.67.0
0.66.0
0.64.0
0.63.0
0.62.0
0.61.0
0.60.0
0.59.0
0.58.0
0.57.0
0.56.0
0.55.0
0.53.0
0.52.0
0.51.0
0.50.0
0.49.0
0.48.0
0.47.0
0.46.0
0.45.0
0.44.0
0.43.0
0.41.0
0.40.0
0.39.0
0.38.0
0.37.0
0.36.0
0.35.0
0.34.0
0.33.0
0.32.0
0.31.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.5.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
MESSAGE_TEXT_FIELD_NUMBER
public static final int MESSAGE_TEXT_FIELD_NUMBER
Field Value
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static StructuredMessage getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static StructuredMessage . Builder newBuilder ()
Returns
newBuilder(StructuredMessage prototype)
public static StructuredMessage . Builder newBuilder ( StructuredMessage prototype )
Parameter
Returns
public static StructuredMessage parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static StructuredMessage parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static StructuredMessage parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static StructuredMessage parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static StructuredMessage parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static StructuredMessage parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static StructuredMessage parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static StructuredMessage parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static StructuredMessage parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<StructuredMessage> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public StructuredMessage getDefaultInstanceForType ()
Returns
getMessageKey()
public String getMessageKey ()
Identifier for this message type. Used by external systems to
internationalize or personalize message.
string message_key = 2;
Returns
Type Description
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
Type Description
ByteString The bytes for messageKey.
getMessageText()
public String getMessageText ()
Human-readable version of message.
string message_text = 1;
Returns
Type Description
String The messageText.
getMessageTextBytes()
public ByteString getMessageTextBytes ()
Human-readable version of message.
string message_text = 1;
Returns
Type Description
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
Name Description
indexint
Returns
getParametersCount()
public int getParametersCount ()
The structured data associated with this message.
repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;
Returns
getParametersList()
public List<StructuredMessage . Parameter > getParametersList ()
The structured data associated with this message.
repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;
Returns
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
Name Description
indexint
Returns
getParametersOrBuilderList()
public List <? extends StructuredMessage . ParameterOrBuilder > getParametersOrBuilderList ()
The structured data associated with this message.
repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;
Returns
Type Description
List <? extends com.google.dataflow.v1beta3.StructuredMessage.ParameterOrBuilder >
getParserForType()
public Parser<StructuredMessage> getParserForType ()
Returns
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public StructuredMessage . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredMessage . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public StructuredMessage . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-31 UTC."],[],[]]
