Package mxaccess_gateway.v1

Interface MxaccessGateway.AcknowledgeAlarmReplyOrBuilder

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

  • Method Details

    • 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.

    • hasProtocolStatus

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

    • getProtocolStatus

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

    • getProtocolStatusOrBuilder

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

    • hasHresult

      boolean hasHresult()
       Native ack return code echoed from the worker. The worker carries the
 ack outcome as a single int32 (AcknowledgeAlarmReplyPayload.native_status,
 = AlarmAckByName / AlarmAckByGUID return code; 0 = success); the gateway's
 WorkerAlarmRpcDispatcher copies that value here. This is the authoritative
 ack-outcome field for the public RPC. Absent only when the worker reply
 omitted the value entirely (a protocol violation).
      optional int32 hresult = 4;
      Returns:
      Whether the hresult field is set.

    • getHresult

      int getHresult()
       Native ack return code echoed from the worker. The worker carries the
 ack outcome as a single int32 (AcknowledgeAlarmReplyPayload.native_status,
 = AlarmAckByName / AlarmAckByGUID return code; 0 = success); the gateway's
 WorkerAlarmRpcDispatcher copies that value here. This is the authoritative
 ack-outcome field for the public RPC. Absent only when the worker reply
 omitted the value entirely (a protocol violation).
      optional int32 hresult = 4;
      Returns:
      The hresult.

    • hasStatus

      boolean hasStatus()
       Reserved for a structured MxStatusProxy view of the ack outcome. The
 worker by-name/by-GUID ack path produces only the int32 return code
 (see `hresult`), so the current gateway leaves this field UNSET on every
 reply. Clients must read `hresult` (and `protocol_status`) for the ack
 result and must not depend on `status` being populated.
      .mxaccess_gateway.v1.MxStatusProxy status = 5;
      Returns:
      Whether the status field is set.

    • getStatus

      MxaccessGateway.MxStatusProxy getStatus()
       Reserved for a structured MxStatusProxy view of the ack outcome. The
 worker by-name/by-GUID ack path produces only the int32 return code
 (see `hresult`), so the current gateway leaves this field UNSET on every
 reply. Clients must read `hresult` (and `protocol_status`) for the ack
 result and must not depend on `status` being populated.
      .mxaccess_gateway.v1.MxStatusProxy status = 5;
      Returns:
      The status.

    • getStatusOrBuilder

      MxaccessGateway.MxStatusProxyOrBuilder getStatusOrBuilder()
       Reserved for a structured MxStatusProxy view of the ack outcome. The
 worker by-name/by-GUID ack path produces only the int32 return code
 (see `hresult`), so the current gateway leaves this field UNSET on every
 reply. Clients must read `hresult` (and `protocol_status`) for the ack
 result and must not depend on `status` being populated.
      .mxaccess_gateway.v1.MxStatusProxy status = 5;

    • getDiagnosticMessage

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

    • getDiagnosticMessageBytes

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