- 0.57.0 (latest)
- 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 StructuredMessageOrBuilderA 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StructuredMessageImplements
StructuredMessageOrBuilderStatic 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()| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static StructuredMessage.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
StructuredMessage.Builder | |
newBuilder(StructuredMessage prototype)
public static StructuredMessage.Builder newBuilder(StructuredMessage prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | StructuredMessage |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage.Builder | |
parseDelimitedFrom(InputStream input)
public static StructuredMessage parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static StructuredMessage parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static StructuredMessage parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static StructuredMessage parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static StructuredMessage parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static StructuredMessage parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredMessage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<StructuredMessage> parser()| Returns | |
|---|---|
| Type | Description |
Parser<StructuredMessage> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDefaultInstanceForType()
public StructuredMessage getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StructuredMessage | |
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 |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage.Parameter | |
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;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
List<? extends com.google.dataflow.v1beta3.StructuredMessage.ParameterOrBuilder> | |
getParserForType()
public Parser<StructuredMessage> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<StructuredMessage> | |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public StructuredMessage.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
StructuredMessage.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredMessage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
StructuredMessage.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public StructuredMessage.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
StructuredMessage.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |