Package mxaccess_gateway.v1
Class MxaccessGateway.BulkReadResult
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
mxaccess_gateway.v1.MxaccessGateway.BulkReadResult
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable,MxaccessGateway.BulkReadResultOrBuilder
- Enclosing class:
MxaccessGateway
public static final class MxaccessGateway.BulkReadResult
extends com.google.protobuf.GeneratedMessage
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- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classPer-tag result for ReadBulk.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic final com.google.protobuf.Descriptors.Descriptorstring error_message = 10;com.google.protobuf.ByteStringstring error_message = 10;intint32 item_handle = 3;com.google.protobuf.Parser<MxaccessGateway.BulkReadResult> intint32 quality = 7;intintint32 server_handle = 1;com.google.protobuf.Timestamp.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;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;booleanbool was_cached = 5;booleanbool was_successful = 4;inthashCode()boolean.google.protobuf.Timestamp source_timestamp = 8;booleanhasValue().mxaccess_gateway.v1.MxValue value = 6;protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleannewBuilder(MxaccessGateway.BulkReadResult prototype) protected MxaccessGateway.BulkReadResult.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<MxaccessGateway.BulkReadResult> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
SERVER_HANDLE_FIELD_NUMBER
public static final int SERVER_HANDLE_FIELD_NUMBER- See Also:
-
TAG_ADDRESS_FIELD_NUMBER
public static final int TAG_ADDRESS_FIELD_NUMBER- See Also:
-
ITEM_HANDLE_FIELD_NUMBER
public static final int ITEM_HANDLE_FIELD_NUMBER- See Also:
-
WAS_SUCCESSFUL_FIELD_NUMBER
public static final int WAS_SUCCESSFUL_FIELD_NUMBER- See Also:
-
WAS_CACHED_FIELD_NUMBER
public static final int WAS_CACHED_FIELD_NUMBER- See Also:
-
VALUE_FIELD_NUMBER
public static final int VALUE_FIELD_NUMBER- See Also:
-
QUALITY_FIELD_NUMBER
public static final int QUALITY_FIELD_NUMBER- See Also:
-
SOURCE_TIMESTAMP_FIELD_NUMBER
public static final int SOURCE_TIMESTAMP_FIELD_NUMBER- See Also:
-
STATUSES_FIELD_NUMBER
public static final int STATUSES_FIELD_NUMBER- See Also:
-
ERROR_MESSAGE_FIELD_NUMBER
public static final int ERROR_MESSAGE_FIELD_NUMBER- See Also:
-
-
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
-
getServerHandle
public int getServerHandle()int32 server_handle = 1;- Specified by:
getServerHandlein interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The serverHandle.
-
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.
-
getItemHandle
public int getItemHandle()int32 item_handle = 3;- Specified by:
getItemHandlein interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The itemHandle.
-
getWasSuccessful
public boolean getWasSuccessful()bool was_successful = 4;- Specified by:
getWasSuccessfulin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The wasSuccessful.
-
getWasCached
public boolean getWasCached()bool was_cached = 5;- Specified by:
getWasCachedin interfaceMxaccessGateway.BulkReadResultOrBuilder- Returns:
- The wasCached.
-
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.
-
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.
-
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.
-
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
-
getStatusesOrBuilderList
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;- Specified by:
getStatusesOrBuilderListin 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
-
getStatusesOrBuilder
repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 9;- Specified by:
getStatusesOrBuilderin interfaceMxaccessGateway.BulkReadResultOrBuilder
-
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.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static MxaccessGateway.BulkReadResult parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static MxaccessGateway.BulkReadResult parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static MxaccessGateway.BulkReadResult parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static MxaccessGateway.BulkReadResult.Builder newBuilder(MxaccessGateway.BulkReadResult prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected MxaccessGateway.BulkReadResult.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-