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

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

clearField(Descriptors.FieldDescriptor field)

public StructuredMessage.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
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

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

getDefaultInstanceForType()

public StructuredMessage getDefaultInstanceForType()
Returns
Type Description
StructuredMessage

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StructuredMessage.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StructuredMessage.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredMessage.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredMessage.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StructuredMessage.Builder
Overrides