Package mxaccess_gateway.v1

Interface MxaccessGateway.MxStatusProxyOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    MxaccessGateway.MxStatusCategory
    getCategory()
    .mxaccess_gateway.v1.MxStatusCategory category = 2;
    int
    getCategoryValue()
    .mxaccess_gateway.v1.MxStatusCategory category = 2;
    int
    getDetail()
    int32 detail = 4;
    MxaccessGateway.MxStatusSource
    getDetectedBy()
    .mxaccess_gateway.v1.MxStatusSource detected_by = 3;
    int
    getDetectedByValue()
    .mxaccess_gateway.v1.MxStatusSource detected_by = 3;
    String
    getDiagnosticText()
    string diagnostic_text = 7;
    com.google.protobuf.ByteString
    getDiagnosticTextBytes()
    string diagnostic_text = 7;
    int
    getRawCategory()
    int32 raw_category = 5;
    int
    getRawDetectedBy()
    int32 raw_detected_by = 6;
    int
    getSuccess()
    Mirrors the `success` member of the MXAccess MXSTATUS_PROXY struct (a 16-bit signed value in the COM struct, widened to int32 on the wire).

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSuccess

      int getSuccess()
       Mirrors the `success` member of the MXAccess MXSTATUS_PROXY struct
 (a 16-bit signed value in the COM struct, widened to int32 on the
 wire). Despite the name it is NOT a boolean — it is the raw numeric
 indicator the worker reads off the COM struct without reinterpretation.
 It is carried verbatim for diagnostics; the authoritative success/
 failure of the operation is `category` (MX_STATUS_CATEGORY_OK marks
 success), with `detail`, `diagnostic_text`, `raw_category`, and
 `raw_detected_by` describing any non-OK outcome. Clients should branch
 on `category`, not on a specific `success` value.
      int32 success = 1;
      Returns:
      The success.

    • getCategoryValue

      int getCategoryValue()
      .mxaccess_gateway.v1.MxStatusCategory category = 2;
      Returns:
      The enum numeric value on the wire for category.

    • getCategory

      MxaccessGateway.MxStatusCategory getCategory()
      .mxaccess_gateway.v1.MxStatusCategory category = 2;
      Returns:
      The category.

    • getDetectedByValue

      int getDetectedByValue()
      .mxaccess_gateway.v1.MxStatusSource detected_by = 3;
      Returns:
      The enum numeric value on the wire for detectedBy.

    • getDetectedBy

      MxaccessGateway.MxStatusSource getDetectedBy()
      .mxaccess_gateway.v1.MxStatusSource detected_by = 3;
      Returns:
      The detectedBy.

    • getDetail

      int getDetail()
      int32 detail = 4;
      Returns:
      The detail.

    • getRawCategory

      int getRawCategory()
      int32 raw_category = 5;
      Returns:
      The rawCategory.

    • getRawDetectedBy

      int getRawDetectedBy()
      int32 raw_detected_by = 6;
      Returns:
      The rawDetectedBy.

    • getDiagnosticText

      String getDiagnosticText()
      string diagnostic_text = 7;
      Returns:
      The diagnosticText.

    • getDiagnosticTextBytes

      com.google.protobuf.ByteString getDiagnosticTextBytes()
      string diagnostic_text = 7;
      Returns:
      The bytes for diagnosticText.