Class StructuredMessage.Builder (0.19.0)

Version 0.19.0

• 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 static final class StructuredMessage.Builder extends GeneratedMessageV3.Builder<StructuredMessage.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StructuredMessage.Builder

Implements

StructuredMessageOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllParameters(Iterable<? extends StructuredMessage.Parameter> values)

public StructuredMessage.Builder addAllParameters(Iterable<? extends StructuredMessage.Parameter> values)

The structured data associated with this message.

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

Parameter
Name	Description
values	Iterable<? extends com.google.dataflow.v1beta3.StructuredMessage.Parameter>

Returns
Type	Description
StructuredMessage.Builder

addParameters(StructuredMessage.Parameter value)

public StructuredMessage.Builder addParameters(StructuredMessage.Parameter value)

The structured data associated with this message.

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

Parameter
Name	Description
value	StructuredMessage.Parameter

Returns
Type	Description
StructuredMessage.Builder

addParameters(StructuredMessage.Parameter.Builder builderForValue)

public StructuredMessage.Builder addParameters(StructuredMessage.Parameter.Builder builderForValue)

The structured data associated with this message.

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

Parameter
Name	Description
builderForValue	StructuredMessage.Parameter.Builder

Returns
Type	Description
StructuredMessage.Builder

addParameters(int index, StructuredMessage.Parameter value)

public StructuredMessage.Builder addParameters(int index, StructuredMessage.Parameter value)

The structured data associated with this message.

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

Parameters
Name	Description
index	int
value	StructuredMessage.Parameter

Returns
Type	Description
StructuredMessage.Builder

addParameters(int index, StructuredMessage.Parameter.Builder builderForValue)

public StructuredMessage.Builder addParameters(int index, StructuredMessage.Parameter.Builder builderForValue)

The structured data associated with this message.

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

Parameters
Name	Description
index	int
builderForValue	StructuredMessage.Parameter.Builder

Returns
Type	Description
StructuredMessage.Builder

addParametersBuilder()

public StructuredMessage.Parameter.Builder addParametersBuilder()

The structured data associated with this message.

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

Returns
Type	Description
StructuredMessage.Parameter.Builder

addParametersBuilder(int index)

public StructuredMessage.Parameter.Builder addParametersBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public StructuredMessage build()

Returns
Type	Description
StructuredMessage

buildPartial()

public StructuredMessage buildPartial()

Returns
Type	Description
StructuredMessage

clear()

public StructuredMessage.Builder clear()

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public StructuredMessage.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMessageKey()

public StructuredMessage.Builder clearMessageKey()

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

string message_key = 2;

Returns
Type	Description
StructuredMessage.Builder	This builder for chaining.

clearMessageText()

public StructuredMessage.Builder clearMessageText()

Human-readable version of message.

string message_text = 1;

Returns
Type	Description
StructuredMessage.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParameters()

public StructuredMessage.Builder clearParameters()

The structured data associated with this message.

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

Returns
Type	Description
StructuredMessage.Builder

clone()

public StructuredMessage.Builder clone()

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public StructuredMessage getDefaultInstanceForType()

Returns
Type	Description
StructuredMessage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

getParametersBuilder(int index)

public StructuredMessage.Parameter.Builder getParametersBuilder(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.Builder

getParametersBuilderList()

public List<StructuredMessage.Parameter.Builder> getParametersBuilderList()

The structured data associated with this message.

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

Returns
Type	Description
List<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(StructuredMessage other)

public StructuredMessage.Builder mergeFrom(StructuredMessage other)

Parameter
Name	Description
other	StructuredMessage

Returns
Type	Description
StructuredMessage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StructuredMessage.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public StructuredMessage.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
StructuredMessage.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeParameters(int index)

public StructuredMessage.Builder removeParameters(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.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredMessage.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMessageKey(String value)

public StructuredMessage.Builder setMessageKey(String value)

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

string message_key = 2;

Parameter
Name	Description
value	String The messageKey to set.

Returns
Type	Description
StructuredMessage.Builder	This builder for chaining.

setMessageKeyBytes(ByteString value)

public StructuredMessage.Builder setMessageKeyBytes(ByteString value)

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

string message_key = 2;

Parameter
Name	Description
value	ByteString The bytes for messageKey to set.

Returns
Type	Description
StructuredMessage.Builder	This builder for chaining.

setMessageText(String value)

public StructuredMessage.Builder setMessageText(String value)

Human-readable version of message.

string message_text = 1;

Parameter
Name	Description
value	String The messageText to set.

Returns
Type	Description
StructuredMessage.Builder	This builder for chaining.

setMessageTextBytes(ByteString value)

public StructuredMessage.Builder setMessageTextBytes(ByteString value)

Human-readable version of message.

string message_text = 1;

Parameter
Name	Description
value	ByteString The bytes for messageText to set.

Returns
Type	Description
StructuredMessage.Builder	This builder for chaining.

setParameters(int index, StructuredMessage.Parameter value)

public StructuredMessage.Builder setParameters(int index, StructuredMessage.Parameter value)

The structured data associated with this message.

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

Parameters
Name	Description
index	int
value	StructuredMessage.Parameter

Returns
Type	Description
StructuredMessage.Builder

setParameters(int index, StructuredMessage.Parameter.Builder builderForValue)

public StructuredMessage.Builder setParameters(int index, StructuredMessage.Parameter.Builder builderForValue)

The structured data associated with this message.

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

Parameters
Name	Description
index	int
builderForValue	StructuredMessage.Parameter.Builder

Returns
Type	Description
StructuredMessage.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StructuredMessage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
StructuredMessage.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)