Package io.camunda.zeebe.protocol.record.value

Class ImmutableVariableDocumentRecordValue.Builder

java.lang.Object

io.camunda.zeebe.protocol.record.value.ImmutableVariableDocumentRecordValue.Builder

Enclosing class:

ImmutableVariableDocumentRecordValue

public static final class ImmutableVariableDocumentRecordValue.Builder
extends Object

Builds instances of type ImmutableVariableDocumentRecordValue. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableVariableDocumentRecordValue	build()	Builds a new ImmutableVariableDocumentRecordValue.
ImmutableVariableDocumentRecordValue.Builder	clear()	Clear the builder to the initial state.
final ImmutableVariableDocumentRecordValue.Builder	from(RecordValueWithVariables instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.RecordValueWithVariables instance.
final ImmutableVariableDocumentRecordValue.Builder	from(TenantOwned instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.TenantOwned instance.
final ImmutableVariableDocumentRecordValue.Builder	from(VariableDocumentRecordValue instance)	Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.VariableDocumentRecordValue instance.
final ImmutableVariableDocumentRecordValue.Builder	putAllVariables(Map<String,? extends Object> entries)	Put all mappings from the specified map as entries to variables map.
final ImmutableVariableDocumentRecordValue.Builder	putVariable(String key, Object value)	Put one entry to the variables map.
final ImmutableVariableDocumentRecordValue.Builder	putVariable(Map.Entry<String,? extends Object> entry)	Put one entry to the variables map.
final ImmutableVariableDocumentRecordValue.Builder	withScopeKey(long scopeKey)	Initializes the value for the scopeKey attribute.
final ImmutableVariableDocumentRecordValue.Builder	withTenantId(String tenantId)	Initializes the value for the tenantId attribute.
final ImmutableVariableDocumentRecordValue.Builder	withUpdateSemantics(VariableDocumentUpdateSemantic updateSemantics)	Initializes the value for the updateSemantics attribute.
final ImmutableVariableDocumentRecordValue.Builder	withVariables(Map<String,? extends Object> entries)	Sets or replaces all mappings from the specified map as entries for the variables map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public final ImmutableVariableDocumentRecordValue.Builder from(VariableDocumentRecordValue instance)

Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.VariableDocumentRecordValue instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableVariableDocumentRecordValue.Builder from(TenantOwned instance)

Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.value.TenantOwned instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableVariableDocumentRecordValue.Builder from(RecordValueWithVariables instance)

Fill a builder with attribute values from the provided io.camunda.zeebe.protocol.record.RecordValueWithVariables instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

putVariable

public final ImmutableVariableDocumentRecordValue.Builder putVariable(String key,
 Object value)

Put one entry to the variables map.

Parameters:

key - The key in the variables map

value - The associated value in the variables map

Returns:

this builder for use in a chained invocation

putVariable

public final ImmutableVariableDocumentRecordValue.Builder putVariable(Map.Entry<String,? extends Object> entry)

Put one entry to the variables map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

withVariables

public final ImmutableVariableDocumentRecordValue.Builder withVariables(Map<String,? extends Object> entries)

Sets or replaces all mappings from the specified map as entries for the variables map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the variables map

Returns:

this builder for use in a chained invocation

putAllVariables

public final ImmutableVariableDocumentRecordValue.Builder putAllVariables(Map<String,? extends Object> entries)

Put all mappings from the specified map as entries to variables map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the variables map

Returns:

this builder for use in a chained invocation

withTenantId

public final ImmutableVariableDocumentRecordValue.Builder withTenantId(String tenantId)

Initializes the value for the tenantId attribute.

Parameters:

tenantId - The value for tenantId (can be null)

Returns:

this builder for use in a chained invocation

withScopeKey

public final ImmutableVariableDocumentRecordValue.Builder withScopeKey(long scopeKey)

Initializes the value for the scopeKey attribute.

Parameters:

scopeKey - The value for scopeKey

Returns:

this builder for use in a chained invocation

withUpdateSemantics

public final ImmutableVariableDocumentRecordValue.Builder withUpdateSemantics(VariableDocumentUpdateSemantic updateSemantics)

Initializes the value for the updateSemantics attribute.

Parameters:

updateSemantics - The value for updateSemantics (can be null)

Returns:

this builder for use in a chained invocation

clear

public ImmutableVariableDocumentRecordValue.Builder clear()

Clear the builder to the initial state.

Returns:

this builder for use in a chained invocation

build

public ImmutableVariableDocumentRecordValue build()

Builds a new ImmutableVariableDocumentRecordValue.

Returns:

An immutable instance of VariableDocumentRecordValue

Throws:

IllegalStateException - if any required attributes are missing