Package mxaccess_gateway.v1
Class MxaccessGateway.BulkReadResult.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<MxaccessGateway.BulkReadResult.Builder>
mxaccess_gateway.v1.MxaccessGateway.BulkReadResult.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable,MxaccessGateway.BulkReadResultOrBuilder
- Enclosing class:
- MxaccessGateway.BulkReadResult
public static final class MxaccessGateway.BulkReadResult.Builder
extends com.google.protobuf.GeneratedMessage.Builder<MxaccessGateway.BulkReadResult.Builder>
implements MxaccessGateway.BulkReadResultOrBuilder
Per-tag result for ReadBulk. `was_cached` is true when the value came from an existing live subscription's last OnDataChange (the worker did not touch the subscription); false when the worker took the AddItem + Advise + wait + UnAdvise + RemoveItem snapshot lifecycle itself. On `was_successful = true`, `value`, `quality`, `source_timestamp`, and `statuses` carry the read data (from the cached subscription or the snapshot lifecycle, depending on `was_cached`) and `error_message` is empty. On `was_successful = false`, only `server_handle`, `tag_address`, `item_handle` (when allocated), `was_cached`, and `error_message` are populated; `value`, `quality`, `source_timestamp`, and `statuses` are left at their proto3 defaults (null / 0 / null / empty) and must not be read as data — they are wire-indistinguishable from "value is null with quality bad" data and serve only as absent markers. ReadBulk has no `hresult` field by design (its outcomes are timeout / cache / lifecycle states, not MXAccess COM return codes — see `docs/DesignDecisions.md` "Bulk Command Family"). Per-tag failures populate `error_message` and never raise — callers iterate and inspect each entry.Protobuf type
mxaccess_gateway.v1.BulkReadResult-
Method Summary
Modifier and TypeMethodDescriptionaddAllStatuses(Iterable<? extends MxaccessGateway.MxStatusProxy> values) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;addStatuses(int index, MxaccessGateway.MxStatusProxy value) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;addStatuses(int index, MxaccessGateway.MxStatusProxy.Builder builderForValue) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;addStatuses(MxaccessGateway.MxStatusProxy.Builder builderForValue) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;addStatusesBuilder(int index) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;build()clear()string error_message = 10;int32 item_handle = 3;int32 quality = 7;int32 server_handle = 1;.google.protobuf.Timestamp source_timestamp = 8;repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;string tag_address = 2;.mxaccess_gateway.v1.MxValue value = 6;bool was_cached = 5;bool was_successful = 4;static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorstring error_message = 10;com.google.protobuf.ByteStringstring error_message = 10;intint32 item_handle = 3;intint32 quality = 7;intint32 server_handle = 1;com.google.protobuf.Timestamp.google.protobuf.Timestamp source_timestamp = 8;com.google.protobuf.Timestamp.Builder.google.protobuf.Timestamp source_timestamp = 8;com.google.protobuf.TimestampOrBuilder.google.protobuf.Timestamp source_timestamp = 8;getStatuses(int index) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;getStatusesBuilder(int index) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;intrepeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;getStatusesOrBuilder(int index) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;List<? extends MxaccessGateway.MxStatusProxyOrBuilder>repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;string tag_address = 2;com.google.protobuf.ByteStringstring tag_address = 2;getValue().mxaccess_gateway.v1.MxValue value = 6;.mxaccess_gateway.v1.MxValue value = 6;.mxaccess_gateway.v1.MxValue value = 6;booleanbool was_cached = 5;booleanbool was_successful = 4;boolean.google.protobuf.Timestamp source_timestamp = 8;booleanhasValue().mxaccess_gateway.v1.MxValue value = 6;protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeSourceTimestamp(com.google.protobuf.Timestamp value) .google.protobuf.Timestamp source_timestamp = 8;.mxaccess_gateway.v1.MxValue value = 6;removeStatuses(int index) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;setErrorMessage(String value) string error_message = 10;setErrorMessageBytes(com.google.protobuf.ByteString value) string error_message = 10;setItemHandle(int value) int32 item_handle = 3;setQuality(int value) int32 quality = 7;setServerHandle(int value) int32 server_handle = 1;setSourceTimestamp(com.google.protobuf.Timestamp value) .google.protobuf.Timestamp source_timestamp = 8;setSourceTimestamp(com.google.protobuf.Timestamp.Builder builderForValue) .google.protobuf.Timestamp source_timestamp = 8;setStatuses(int index, MxaccessGateway.MxStatusProxy value) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;setStatuses(int index, MxaccessGateway.MxStatusProxy.Builder builderForValue) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;setTagAddress(String value) string tag_address = 2;setTagAddressBytes(com.google.protobuf.ByteString value) string tag_address = 2;setValue(MxaccessGateway.MxValue value) .mxaccess_gateway.v1.MxValue value = 6;setValue(MxaccessGateway.MxValue.Builder builderForValue) .mxaccess_gateway.v1.MxValue value = 6;setWasCached(boolean value) bool was_cached = 5;setWasSuccessful(boolean value) bool was_successful = 4;Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<MxaccessGateway.BulkReadResult.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<MxaccessGateway.BulkReadResult.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<MxaccessGateway.BulkReadResult.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<MxaccessGateway.BulkReadResult.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<MxaccessGateway.BulkReadResult.Builder>
-
mergeFrom
public MxaccessGateway.BulkReadResult.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<MxaccessGateway.BulkReadResult.Builder>- Throws:
IOException
-
getServerHandle
public int getServerHandle()int32 server_handle = 1;- Specified by:
getServerHandlein interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The serverHandle.
-
setServerHandle
int32 server_handle = 1;- Parameters:
value- The serverHandle to set.- Returns:
- This builder for chaining.
-
clearServerHandle
int32 server_handle = 1;- Returns:
- This builder for chaining.
-
getTagAddress
string tag_address = 2;- Specified by:
getTagAddressin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The tagAddress.
-
getTagAddressBytes
public com.google.protobuf.ByteString getTagAddressBytes()string tag_address = 2;- Specified by:
getTagAddressBytesin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The bytes for tagAddress.
-
setTagAddress
string tag_address = 2;- Parameters:
value- The tagAddress to set.- Returns:
- This builder for chaining.
-
clearTagAddress
string tag_address = 2;- Returns:
- This builder for chaining.
-
setTagAddressBytes
public MxaccessGateway.BulkReadResult.Builder setTagAddressBytes(com.google.protobuf.ByteString value) string tag_address = 2;- Parameters:
value- The bytes for tagAddress to set.- Returns:
- This builder for chaining.
-
getItemHandle
public int getItemHandle()int32 item_handle = 3;- Specified by:
getItemHandlein interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The itemHandle.
-
setItemHandle
int32 item_handle = 3;- Parameters:
value- The itemHandle to set.- Returns:
- This builder for chaining.
-
clearItemHandle
int32 item_handle = 3;- Returns:
- This builder for chaining.
-
getWasSuccessful
public boolean getWasSuccessful()bool was_successful = 4;- Specified by:
getWasSuccessfulin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The wasSuccessful.
-
setWasSuccessful
bool was_successful = 4;- Parameters:
value- The wasSuccessful to set.- Returns:
- This builder for chaining.
-
clearWasSuccessful
bool was_successful = 4;- Returns:
- This builder for chaining.
-
getWasCached
public boolean getWasCached()bool was_cached = 5;- Specified by:
getWasCachedin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The wasCached.
-
setWasCached
bool was_cached = 5;- Parameters:
value- The wasCached to set.- Returns:
- This builder for chaining.
-
clearWasCached
bool was_cached = 5;- Returns:
- This builder for chaining.
-
hasValue
public boolean hasValue().mxaccess_gateway.v1.MxValue value = 6;- Specified by:
hasValuein interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- Whether the value field is set.
-
getValue
.mxaccess_gateway.v1.MxValue value = 6;- Specified by:
getValuein interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The value.
-
setValue
.mxaccess_gateway.v1.MxValue value = 6; -
setValue
public MxaccessGateway.BulkReadResult.Builder setValue(MxaccessGateway.MxValue.Builder builderForValue) .mxaccess_gateway.v1.MxValue value = 6; -
mergeValue
.mxaccess_gateway.v1.MxValue value = 6; -
clearValue
.mxaccess_gateway.v1.MxValue value = 6; -
getValueBuilder
.mxaccess_gateway.v1.MxValue value = 6; -
getValueOrBuilder
.mxaccess_gateway.v1.MxValue value = 6;- Specified by:
getValueOrBuilderin interfaceMxaccessGateway.BulkReadResultOrBuilder
-
getQuality
public int getQuality()int32 quality = 7;- Specified by:
getQualityin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The quality.
-
setQuality
int32 quality = 7;- Parameters:
value- The quality to set.- Returns:
- This builder for chaining.
-
clearQuality
int32 quality = 7;- Returns:
- This builder for chaining.
-
hasSourceTimestamp
public boolean hasSourceTimestamp().google.protobuf.Timestamp source_timestamp = 8;- Specified by:
hasSourceTimestampin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- Whether the sourceTimestamp field is set.
-
getSourceTimestamp
public com.google.protobuf.Timestamp getSourceTimestamp().google.protobuf.Timestamp source_timestamp = 8;- Specified by:
getSourceTimestampin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The sourceTimestamp.
-
setSourceTimestamp
public MxaccessGateway.BulkReadResult.Builder setSourceTimestamp(com.google.protobuf.Timestamp value) .google.protobuf.Timestamp source_timestamp = 8; -
setSourceTimestamp
public MxaccessGateway.BulkReadResult.Builder setSourceTimestamp(com.google.protobuf.Timestamp.Builder builderForValue) .google.protobuf.Timestamp source_timestamp = 8; -
mergeSourceTimestamp
public MxaccessGateway.BulkReadResult.Builder mergeSourceTimestamp(com.google.protobuf.Timestamp value) .google.protobuf.Timestamp source_timestamp = 8; -
clearSourceTimestamp
.google.protobuf.Timestamp source_timestamp = 8; -
getSourceTimestampBuilder
public com.google.protobuf.Timestamp.Builder getSourceTimestampBuilder().google.protobuf.Timestamp source_timestamp = 8; -
getSourceTimestampOrBuilder
public com.google.protobuf.TimestampOrBuilder getSourceTimestampOrBuilder().google.protobuf.Timestamp source_timestamp = 8;- Specified by:
getSourceTimestampOrBuilderin interfaceMxaccessGateway.BulkReadResultOrBuilder
-
getStatusesList
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;- Specified by:
getStatusesListin interfaceMxaccessGateway.BulkReadResultOrBuilder
-
getStatusesCount
public int getStatusesCount()repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;- Specified by:
getStatusesCountin interfaceMxaccessGateway.BulkReadResultOrBuilder
-
getStatuses
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;- Specified by:
getStatusesin interfaceMxaccessGateway.BulkReadResultOrBuilder
-
setStatuses
public MxaccessGateway.BulkReadResult.Builder setStatuses(int index, MxaccessGateway.MxStatusProxy value) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
setStatuses
public MxaccessGateway.BulkReadResult.Builder setStatuses(int index, MxaccessGateway.MxStatusProxy.Builder builderForValue) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
addStatuses
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
addStatuses
public MxaccessGateway.BulkReadResult.Builder addStatuses(int index, MxaccessGateway.MxStatusProxy value) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
addStatuses
public MxaccessGateway.BulkReadResult.Builder addStatuses(MxaccessGateway.MxStatusProxy.Builder builderForValue) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
addStatuses
public MxaccessGateway.BulkReadResult.Builder addStatuses(int index, MxaccessGateway.MxStatusProxy.Builder builderForValue) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
addAllStatuses
public MxaccessGateway.BulkReadResult.Builder addAllStatuses(Iterable<? extends MxaccessGateway.MxStatusProxy> values) repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
clearStatuses
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
removeStatuses
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
getStatusesBuilder
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
getStatusesOrBuilder
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;- Specified by:
getStatusesOrBuilderin interfaceMxaccessGateway.BulkReadResultOrBuilder
-
getStatusesOrBuilderList
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;- Specified by:
getStatusesOrBuilderListin interfaceMxaccessGateway.BulkReadResultOrBuilder
-
addStatusesBuilder
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
addStatusesBuilder
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
getStatusesBuilderList
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9; -
getErrorMessage
string error_message = 10;- Specified by:
getErrorMessagein interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The errorMessage.
-
getErrorMessageBytes
public com.google.protobuf.ByteString getErrorMessageBytes()string error_message = 10;- Specified by:
getErrorMessageBytesin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The bytes for errorMessage.
-
setErrorMessage
string error_message = 10;- Parameters:
value- The errorMessage to set.- Returns:
- This builder for chaining.
-
clearErrorMessage
string error_message = 10;- Returns:
- This builder for chaining.
-
setErrorMessageBytes
public MxaccessGateway.BulkReadResult.Builder setErrorMessageBytes(com.google.protobuf.ByteString value) string error_message = 10;- Parameters:
value- The bytes for errorMessage to set.- Returns:
- This builder for chaining.
-