Package mxaccess_gateway.v1

Interface MxaccessGateway.MxCommandReplyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MxaccessGateway.MxCommandReply, MxaccessGateway.MxCommandReply.Builder
Enclosing class:
MxaccessGateway
public static interface MxaccessGateway.MxCommandReplyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSessionId

      String getSessionId()
      string session_id = 1;
      Returns:
      The sessionId.

    • getSessionIdBytes

      com.google.protobuf.ByteString getSessionIdBytes()
      string session_id = 1;
      Returns:
      The bytes for sessionId.

    • getCorrelationId

      String getCorrelationId()
      string correlation_id = 2;
      Returns:
      The correlationId.

    • getCorrelationIdBytes

      com.google.protobuf.ByteString getCorrelationIdBytes()
      string correlation_id = 2;
      Returns:
      The bytes for correlationId.

    • getKindValue

      int getKindValue()
      .mxaccess_gateway.v1.MxCommandKind kind = 3;
      Returns:
      The enum numeric value on the wire for kind.

    • getKind

      MxaccessGateway.MxCommandKind getKind()
      .mxaccess_gateway.v1.MxCommandKind kind = 3;
      Returns:
      The kind.

    • hasProtocolStatus

      boolean hasProtocolStatus()
      .mxaccess_gateway.v1.ProtocolStatus protocol_status = 4;
      Returns:
      Whether the protocolStatus field is set.

    • getProtocolStatus

      MxaccessGateway.ProtocolStatus getProtocolStatus()
      .mxaccess_gateway.v1.ProtocolStatus protocol_status = 4;
      Returns:
      The protocolStatus.

    • getProtocolStatusOrBuilder

      MxaccessGateway.ProtocolStatusOrBuilder getProtocolStatusOrBuilder()
      .mxaccess_gateway.v1.ProtocolStatus protocol_status = 4;

    • hasHresult

      boolean hasHresult()
       HRESULT captured from MXAccess or a COM exception. This remains separate
 from gateway protocol status so MXAccess parity details are not hidden by
 transport failures.
      optional int32 hresult = 5;
      Returns:
      Whether the hresult field is set.

    • getHresult

      int getHresult()
       HRESULT captured from MXAccess or a COM exception. This remains separate
 from gateway protocol status so MXAccess parity details are not hidden by
 transport failures.
      optional int32 hresult = 5;
      Returns:
      The hresult.

    • hasReturnValue

      boolean hasReturnValue()
      .mxaccess_gateway.v1.MxValue return_value = 6;
      Returns:
      Whether the returnValue field is set.

    • getReturnValue

      MxaccessGateway.MxValue getReturnValue()
      .mxaccess_gateway.v1.MxValue return_value = 6;
      Returns:
      The returnValue.

    • getReturnValueOrBuilder

      MxaccessGateway.MxValueOrBuilder getReturnValueOrBuilder()
      .mxaccess_gateway.v1.MxValue return_value = 6;

    • getStatusesList

      List<MxaccessGateway.MxStatusProxy> getStatusesList()
      repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 7;

    • getStatuses

      MxaccessGateway.MxStatusProxy getStatuses(int index)
      repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 7;

    • getStatusesCount

      int getStatusesCount()
      repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 7;

    • getStatusesOrBuilderList

      List<? extends MxaccessGateway.MxStatusProxyOrBuilder> getStatusesOrBuilderList()
      repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 7;

    • getStatusesOrBuilder

      MxaccessGateway.MxStatusProxyOrBuilder getStatusesOrBuilder(int index)
      repeated .mxaccess_gateway.v1.MxStatusProxy statuses = 7;

    • getDiagnosticMessage

      String getDiagnosticMessage()
      string diagnostic_message = 8;
      Returns:
      The diagnosticMessage.

    • getDiagnosticMessageBytes

      com.google.protobuf.ByteString getDiagnosticMessageBytes()
      string diagnostic_message = 8;
      Returns:
      The bytes for diagnosticMessage.

    • hasRegister

      boolean hasRegister()
      .mxaccess_gateway.v1.RegisterReply register = 20;
      Returns:
      Whether the register field is set.

    • getRegister

      MxaccessGateway.RegisterReply getRegister()
      .mxaccess_gateway.v1.RegisterReply register = 20;
      Returns:
      The register.

    • getRegisterOrBuilder

      MxaccessGateway.RegisterReplyOrBuilder getRegisterOrBuilder()
      .mxaccess_gateway.v1.RegisterReply register = 20;

    • hasAddItem

      boolean hasAddItem()
      .mxaccess_gateway.v1.AddItemReply add_item = 21;
      Returns:
      Whether the addItem field is set.

    • getAddItem

      MxaccessGateway.AddItemReply getAddItem()
      .mxaccess_gateway.v1.AddItemReply add_item = 21;
      Returns:
      The addItem.

    • getAddItemOrBuilder

      MxaccessGateway.AddItemReplyOrBuilder getAddItemOrBuilder()
      .mxaccess_gateway.v1.AddItemReply add_item = 21;

    • hasAddItem2

      boolean hasAddItem2()
      .mxaccess_gateway.v1.AddItem2Reply add_item2 = 22;
      Returns:
      Whether the addItem2 field is set.

    • getAddItem2

      MxaccessGateway.AddItem2Reply getAddItem2()
      .mxaccess_gateway.v1.AddItem2Reply add_item2 = 22;
      Returns:
      The addItem2.

    • getAddItem2OrBuilder

      MxaccessGateway.AddItem2ReplyOrBuilder getAddItem2OrBuilder()
      .mxaccess_gateway.v1.AddItem2Reply add_item2 = 22;

    • hasAddBufferedItem

      boolean hasAddBufferedItem()
      .mxaccess_gateway.v1.AddBufferedItemReply add_buffered_item = 23;
      Returns:
      Whether the addBufferedItem field is set.

    • getAddBufferedItem

      MxaccessGateway.AddBufferedItemReply getAddBufferedItem()
      .mxaccess_gateway.v1.AddBufferedItemReply add_buffered_item = 23;
      Returns:
      The addBufferedItem.

    • getAddBufferedItemOrBuilder

      MxaccessGateway.AddBufferedItemReplyOrBuilder getAddBufferedItemOrBuilder()
      .mxaccess_gateway.v1.AddBufferedItemReply add_buffered_item = 23;

    • hasSuspend

      boolean hasSuspend()
      .mxaccess_gateway.v1.SuspendReply suspend = 24;
      Returns:
      Whether the suspend field is set.

    • getSuspend

      MxaccessGateway.SuspendReply getSuspend()
      .mxaccess_gateway.v1.SuspendReply suspend = 24;
      Returns:
      The suspend.

    • getSuspendOrBuilder

      MxaccessGateway.SuspendReplyOrBuilder getSuspendOrBuilder()
      .mxaccess_gateway.v1.SuspendReply suspend = 24;

    • hasActivate

      boolean hasActivate()
      .mxaccess_gateway.v1.ActivateReply activate = 25;
      Returns:
      Whether the activate field is set.

    • getActivate

      MxaccessGateway.ActivateReply getActivate()
      .mxaccess_gateway.v1.ActivateReply activate = 25;
      Returns:
      The activate.

    • getActivateOrBuilder

      MxaccessGateway.ActivateReplyOrBuilder getActivateOrBuilder()
      .mxaccess_gateway.v1.ActivateReply activate = 25;

    • hasAuthenticateUser

      boolean hasAuthenticateUser()
      .mxaccess_gateway.v1.AuthenticateUserReply authenticate_user = 26;
      Returns:
      Whether the authenticateUser field is set.

    • getAuthenticateUser

      MxaccessGateway.AuthenticateUserReply getAuthenticateUser()
      .mxaccess_gateway.v1.AuthenticateUserReply authenticate_user = 26;
      Returns:
      The authenticateUser.

    • getAuthenticateUserOrBuilder

      MxaccessGateway.AuthenticateUserReplyOrBuilder getAuthenticateUserOrBuilder()
      .mxaccess_gateway.v1.AuthenticateUserReply authenticate_user = 26;

    • hasArchestraUserToId

      boolean hasArchestraUserToId()
      .mxaccess_gateway.v1.ArchestrAUserToIdReply archestra_user_to_id = 27;
      Returns:
      Whether the archestraUserToId field is set.

    • getArchestraUserToId

      MxaccessGateway.ArchestrAUserToIdReply getArchestraUserToId()
      .mxaccess_gateway.v1.ArchestrAUserToIdReply archestra_user_to_id = 27;
      Returns:
      The archestraUserToId.

    • getArchestraUserToIdOrBuilder

      MxaccessGateway.ArchestrAUserToIdReplyOrBuilder getArchestraUserToIdOrBuilder()
      .mxaccess_gateway.v1.ArchestrAUserToIdReply archestra_user_to_id = 27;

    • hasAddItemBulk

      boolean hasAddItemBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply add_item_bulk = 28;
      Returns:
      Whether the addItemBulk field is set.

    • getAddItemBulk

      MxaccessGateway.BulkSubscribeReply getAddItemBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply add_item_bulk = 28;
      Returns:
      The addItemBulk.

    • getAddItemBulkOrBuilder

      MxaccessGateway.BulkSubscribeReplyOrBuilder getAddItemBulkOrBuilder()
      .mxaccess_gateway.v1.BulkSubscribeReply add_item_bulk = 28;

    • hasAdviseItemBulk

      boolean hasAdviseItemBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply advise_item_bulk = 29;
      Returns:
      Whether the adviseItemBulk field is set.

    • getAdviseItemBulk

      MxaccessGateway.BulkSubscribeReply getAdviseItemBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply advise_item_bulk = 29;
      Returns:
      The adviseItemBulk.

    • getAdviseItemBulkOrBuilder

      MxaccessGateway.BulkSubscribeReplyOrBuilder getAdviseItemBulkOrBuilder()
      .mxaccess_gateway.v1.BulkSubscribeReply advise_item_bulk = 29;

    • hasRemoveItemBulk

      boolean hasRemoveItemBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply remove_item_bulk = 30;
      Returns:
      Whether the removeItemBulk field is set.

    • getRemoveItemBulk

      MxaccessGateway.BulkSubscribeReply getRemoveItemBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply remove_item_bulk = 30;
      Returns:
      The removeItemBulk.

    • getRemoveItemBulkOrBuilder

      MxaccessGateway.BulkSubscribeReplyOrBuilder getRemoveItemBulkOrBuilder()
      .mxaccess_gateway.v1.BulkSubscribeReply remove_item_bulk = 30;

    • hasUnAdviseItemBulk

      boolean hasUnAdviseItemBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply un_advise_item_bulk = 31;
      Returns:
      Whether the unAdviseItemBulk field is set.

    • getUnAdviseItemBulk

      MxaccessGateway.BulkSubscribeReply getUnAdviseItemBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply un_advise_item_bulk = 31;
      Returns:
      The unAdviseItemBulk.

    • getUnAdviseItemBulkOrBuilder

      MxaccessGateway.BulkSubscribeReplyOrBuilder getUnAdviseItemBulkOrBuilder()
      .mxaccess_gateway.v1.BulkSubscribeReply un_advise_item_bulk = 31;

    • hasSubscribeBulk

      boolean hasSubscribeBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply subscribe_bulk = 32;
      Returns:
      Whether the subscribeBulk field is set.

    • getSubscribeBulk

      MxaccessGateway.BulkSubscribeReply getSubscribeBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply subscribe_bulk = 32;
      Returns:
      The subscribeBulk.

    • getSubscribeBulkOrBuilder

      MxaccessGateway.BulkSubscribeReplyOrBuilder getSubscribeBulkOrBuilder()
      .mxaccess_gateway.v1.BulkSubscribeReply subscribe_bulk = 32;

    • hasUnsubscribeBulk

      boolean hasUnsubscribeBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply unsubscribe_bulk = 33;
      Returns:
      Whether the unsubscribeBulk field is set.

    • getUnsubscribeBulk

      MxaccessGateway.BulkSubscribeReply getUnsubscribeBulk()
      .mxaccess_gateway.v1.BulkSubscribeReply unsubscribe_bulk = 33;
      Returns:
      The unsubscribeBulk.

    • getUnsubscribeBulkOrBuilder

      MxaccessGateway.BulkSubscribeReplyOrBuilder getUnsubscribeBulkOrBuilder()
      .mxaccess_gateway.v1.BulkSubscribeReply unsubscribe_bulk = 33;

    • hasAcknowledgeAlarm

      boolean hasAcknowledgeAlarm()
       Reply payload for BOTH MX_COMMAND_KIND_ACKNOWLEDGE_ALARM (by GUID)
 and MX_COMMAND_KIND_ACKNOWLEDGE_ALARM_BY_NAME. There is intentionally
 no by-name-specific reply case: the by-name ack carries no outcome
 detail beyond the native ack return code, so the worker reuses this
 `acknowledge_alarm` payload for both command kinds (the worker's
 MxAccessCommandExecutor sets `acknowledge_alarm` for the by-name arm
 too). Consumers must dispatch on MxCommandReply.kind, not on the
 payload case, to tell the two acks apart. The top-level `hresult`
 mirrors AcknowledgeAlarmReplyPayload.native_status and is preferred.
      .mxaccess_gateway.v1.AcknowledgeAlarmReplyPayload acknowledge_alarm = 34;
      Returns:
      Whether the acknowledgeAlarm field is set.

    • getAcknowledgeAlarm

      MxaccessGateway.AcknowledgeAlarmReplyPayload getAcknowledgeAlarm()
       Reply payload for BOTH MX_COMMAND_KIND_ACKNOWLEDGE_ALARM (by GUID)
 and MX_COMMAND_KIND_ACKNOWLEDGE_ALARM_BY_NAME. There is intentionally
 no by-name-specific reply case: the by-name ack carries no outcome
 detail beyond the native ack return code, so the worker reuses this
 `acknowledge_alarm` payload for both command kinds (the worker's
 MxAccessCommandExecutor sets `acknowledge_alarm` for the by-name arm
 too). Consumers must dispatch on MxCommandReply.kind, not on the
 payload case, to tell the two acks apart. The top-level `hresult`
 mirrors AcknowledgeAlarmReplyPayload.native_status and is preferred.
      .mxaccess_gateway.v1.AcknowledgeAlarmReplyPayload acknowledge_alarm = 34;
      Returns:
      The acknowledgeAlarm.

    • getAcknowledgeAlarmOrBuilder

      MxaccessGateway.AcknowledgeAlarmReplyPayloadOrBuilder getAcknowledgeAlarmOrBuilder()
       Reply payload for BOTH MX_COMMAND_KIND_ACKNOWLEDGE_ALARM (by GUID)
 and MX_COMMAND_KIND_ACKNOWLEDGE_ALARM_BY_NAME. There is intentionally
 no by-name-specific reply case: the by-name ack carries no outcome
 detail beyond the native ack return code, so the worker reuses this
 `acknowledge_alarm` payload for both command kinds (the worker's
 MxAccessCommandExecutor sets `acknowledge_alarm` for the by-name arm
 too). Consumers must dispatch on MxCommandReply.kind, not on the
 payload case, to tell the two acks apart. The top-level `hresult`
 mirrors AcknowledgeAlarmReplyPayload.native_status and is preferred.
      .mxaccess_gateway.v1.AcknowledgeAlarmReplyPayload acknowledge_alarm = 34;

    • hasQueryActiveAlarms

      boolean hasQueryActiveAlarms()
      .mxaccess_gateway.v1.QueryActiveAlarmsReplyPayload query_active_alarms = 35;
      Returns:
      Whether the queryActiveAlarms field is set.

    • getQueryActiveAlarms

      MxaccessGateway.QueryActiveAlarmsReplyPayload getQueryActiveAlarms()
      .mxaccess_gateway.v1.QueryActiveAlarmsReplyPayload query_active_alarms = 35;
      Returns:
      The queryActiveAlarms.

    • getQueryActiveAlarmsOrBuilder

      MxaccessGateway.QueryActiveAlarmsReplyPayloadOrBuilder getQueryActiveAlarmsOrBuilder()
      .mxaccess_gateway.v1.QueryActiveAlarmsReplyPayload query_active_alarms = 35;

    • hasWriteBulk

      boolean hasWriteBulk()
      .mxaccess_gateway.v1.BulkWriteReply write_bulk = 36;
      Returns:
      Whether the writeBulk field is set.

    • getWriteBulk

      MxaccessGateway.BulkWriteReply getWriteBulk()
      .mxaccess_gateway.v1.BulkWriteReply write_bulk = 36;
      Returns:
      The writeBulk.

    • getWriteBulkOrBuilder

      MxaccessGateway.BulkWriteReplyOrBuilder getWriteBulkOrBuilder()
      .mxaccess_gateway.v1.BulkWriteReply write_bulk = 36;

    • hasWrite2Bulk

      boolean hasWrite2Bulk()
      .mxaccess_gateway.v1.BulkWriteReply write2_bulk = 37;
      Returns:
      Whether the write2Bulk field is set.

    • getWrite2Bulk

      MxaccessGateway.BulkWriteReply getWrite2Bulk()
      .mxaccess_gateway.v1.BulkWriteReply write2_bulk = 37;
      Returns:
      The write2Bulk.

    • getWrite2BulkOrBuilder

      MxaccessGateway.BulkWriteReplyOrBuilder getWrite2BulkOrBuilder()
      .mxaccess_gateway.v1.BulkWriteReply write2_bulk = 37;

    • hasWriteSecuredBulk

      boolean hasWriteSecuredBulk()
      .mxaccess_gateway.v1.BulkWriteReply write_secured_bulk = 38;
      Returns:
      Whether the writeSecuredBulk field is set.

    • getWriteSecuredBulk

      MxaccessGateway.BulkWriteReply getWriteSecuredBulk()
      .mxaccess_gateway.v1.BulkWriteReply write_secured_bulk = 38;
      Returns:
      The writeSecuredBulk.

    • getWriteSecuredBulkOrBuilder

      MxaccessGateway.BulkWriteReplyOrBuilder getWriteSecuredBulkOrBuilder()
      .mxaccess_gateway.v1.BulkWriteReply write_secured_bulk = 38;

    • hasWriteSecured2Bulk

      boolean hasWriteSecured2Bulk()
      .mxaccess_gateway.v1.BulkWriteReply write_secured2_bulk = 39;
      Returns:
      Whether the writeSecured2Bulk field is set.

    • getWriteSecured2Bulk

      MxaccessGateway.BulkWriteReply getWriteSecured2Bulk()
      .mxaccess_gateway.v1.BulkWriteReply write_secured2_bulk = 39;
      Returns:
      The writeSecured2Bulk.

    • getWriteSecured2BulkOrBuilder

      MxaccessGateway.BulkWriteReplyOrBuilder getWriteSecured2BulkOrBuilder()
      .mxaccess_gateway.v1.BulkWriteReply write_secured2_bulk = 39;

    • hasReadBulk

      boolean hasReadBulk()
      .mxaccess_gateway.v1.BulkReadReply read_bulk = 40;
      Returns:
      Whether the readBulk field is set.

    • getReadBulk

      MxaccessGateway.BulkReadReply getReadBulk()
      .mxaccess_gateway.v1.BulkReadReply read_bulk = 40;
      Returns:
      The readBulk.

    • getReadBulkOrBuilder

      MxaccessGateway.BulkReadReplyOrBuilder getReadBulkOrBuilder()
      .mxaccess_gateway.v1.BulkReadReply read_bulk = 40;

    • hasSessionState

      boolean hasSessionState()
      .mxaccess_gateway.v1.SessionStateReply session_state = 100;
      Returns:
      Whether the sessionState field is set.

    • getSessionState

      MxaccessGateway.SessionStateReply getSessionState()
      .mxaccess_gateway.v1.SessionStateReply session_state = 100;
      Returns:
      The sessionState.

    • getSessionStateOrBuilder

      MxaccessGateway.SessionStateReplyOrBuilder getSessionStateOrBuilder()
      .mxaccess_gateway.v1.SessionStateReply session_state = 100;

    • hasWorkerInfo

      boolean hasWorkerInfo()
      .mxaccess_gateway.v1.WorkerInfoReply worker_info = 101;
      Returns:
      Whether the workerInfo field is set.

    • getWorkerInfo

      MxaccessGateway.WorkerInfoReply getWorkerInfo()
      .mxaccess_gateway.v1.WorkerInfoReply worker_info = 101;
      Returns:
      The workerInfo.

    • getWorkerInfoOrBuilder

      MxaccessGateway.WorkerInfoReplyOrBuilder getWorkerInfoOrBuilder()
      .mxaccess_gateway.v1.WorkerInfoReply worker_info = 101;

    • hasDrainEvents

      boolean hasDrainEvents()
      .mxaccess_gateway.v1.DrainEventsReply drain_events = 102;
      Returns:
      Whether the drainEvents field is set.

    • getDrainEvents

      MxaccessGateway.DrainEventsReply getDrainEvents()
      .mxaccess_gateway.v1.DrainEventsReply drain_events = 102;
      Returns:
      The drainEvents.

    • getDrainEventsOrBuilder

      MxaccessGateway.DrainEventsReplyOrBuilder getDrainEventsOrBuilder()
      .mxaccess_gateway.v1.DrainEventsReply drain_events = 102;

    • getPayloadCase

      MxaccessGateway.MxCommandReply.PayloadCase getPayloadCase()