Class StructuredMessage.Builder (0.31.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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.dataflow.v1beta3.StructuredMessage.Parameter>
Returns
TypeDescription
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
NameDescription
valueStructuredMessage.Parameter
Returns
TypeDescription
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
NameDescription
builderForValueStructuredMessage.Parameter.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueStructuredMessage.Parameter
Returns
TypeDescription
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
NameDescription
indexint
builderForValueStructuredMessage.Parameter.Builder
Returns
TypeDescription
StructuredMessage.Builder

addParametersBuilder()

public StructuredMessage.Parameter.Builder addParametersBuilder()

The structured data associated with this message.

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
StructuredMessage.Parameter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredMessage.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StructuredMessage.Builder
Overrides

build()

public StructuredMessage build()
Returns
TypeDescription
StructuredMessage

buildPartial()

public StructuredMessage buildPartial()
Returns
TypeDescription
StructuredMessage

clear()

public StructuredMessage.Builder clear()
Returns
TypeDescription
StructuredMessage.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public StructuredMessage.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StructuredMessage.Builder
Overrides

clearMessageKey()

public StructuredMessage.Builder clearMessageKey()

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

string message_key = 2;

Returns
TypeDescription
StructuredMessage.Builder

This builder for chaining.

clearMessageText()

public StructuredMessage.Builder clearMessageText()

Human-readable version of message.

string message_text = 1;

Returns
TypeDescription
StructuredMessage.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredMessage.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StructuredMessage.Builder
Overrides

clearParameters()

public StructuredMessage.Builder clearParameters()

The structured data associated with this message.

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

Returns
TypeDescription
StructuredMessage.Builder

clone()

public StructuredMessage.Builder clone()
Returns
TypeDescription
StructuredMessage.Builder
Overrides

getDefaultInstanceForType()

public StructuredMessage getDefaultInstanceForType()
Returns
TypeDescription
StructuredMessage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<Builder>

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>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(StructuredMessage other)

public StructuredMessage.Builder mergeFrom(StructuredMessage other)
Parameter
NameDescription
otherStructuredMessage
Returns
TypeDescription
StructuredMessage.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredMessage.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StructuredMessage.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StructuredMessage.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StructuredMessage.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StructuredMessage.Builder
Overrides

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
NameDescription
indexint
Returns
TypeDescription
StructuredMessage.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredMessage.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StructuredMessage.Builder
Overrides

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
NameDescription
valueString

The messageKey to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for messageKey to set.

Returns
TypeDescription
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
NameDescription
valueString

The messageText to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for messageText to set.

Returns
TypeDescription
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
NameDescription
indexint
valueStructuredMessage.Parameter
Returns
TypeDescription
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
NameDescription
indexint
builderForValueStructuredMessage.Parameter.Builder
Returns
TypeDescription
StructuredMessage.Builder

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

public StructuredMessage.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StructuredMessage.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StructuredMessage.Builder
Overrides