Send feedback
Class StructuredMessage (0.57.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.57.0 keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
MESSAGE_KEY_FIELD_NUMBER
public static final int MESSAGE_KEY_FIELD_NUMBER
Field Value
Type
Description
int
MESSAGE_TEXT_FIELD_NUMBER
public static final int MESSAGE_TEXT_FIELD_NUMBER
Field Value
Type
Description
int
PARAMETERS_FIELD_NUMBER
public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static StructuredMessage getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static StructuredMessage . Builder newBuilder ()
newBuilder(StructuredMessage prototype)
public static StructuredMessage . Builder newBuilder ( StructuredMessage prototype )
public static StructuredMessage parseDelimitedFrom ( InputStream input )
public static StructuredMessage parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static StructuredMessage parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static StructuredMessage parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static StructuredMessage parseFrom ( CodedInputStream input )
public static StructuredMessage parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static StructuredMessage parseFrom ( InputStream input )
public static StructuredMessage parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static StructuredMessage parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<StructuredMessage> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public StructuredMessage getDefaultInstanceForType ()
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
index
int
getParametersCount()
public int getParametersCount ()
The structured data associated with this message.
repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;
Returns
Type
Description
int
getParametersList()
public List<StructuredMessage . Parameter > getParametersList ()
The structured data associated with this message.
repeated .google.dataflow.v1beta3.StructuredMessage.Parameter parameters = 3;
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
index
int
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 ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public StructuredMessage . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredMessage . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public StructuredMessage . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]