org.yamcs.api.FieldBehavior Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/api/annotations.proto

package org.yamcs.api;

/**
 * Protobuf enum {@code yamcs.api.FieldBehavior}
 */
public enum FieldBehavior
    implements com.google.protobuf.ProtocolMessageEnum {
  /**
   *    * Default. Do not use.
   * 
   *
   * FIELD_BEHAVIOR_UNSPECIFIED = 0;
   */
  FIELD_BEHAVIOR_UNSPECIFIED(0),
  /**
   *    * Marks a field as secret. Services, such as audit logging, may use
   * this as a hint for masking or hiding this field.
   * 
   *
   * SECRET = 1;
   */
  SECRET(1),
  ;

  /**
   *    * Default. Do not use.
   * 
   *
   * FIELD_BEHAVIOR_UNSPECIFIED = 0;
   */
  public static final int FIELD_BEHAVIOR_UNSPECIFIED_VALUE = 0;
  /**
   *    * Marks a field as secret. Services, such as audit logging, may use
   * this as a hint for masking or hiding this field.
   * 
   *
   * SECRET = 1;
   */
  public static final int SECRET_VALUE = 1;


  public final int getNumber() {
    return value;
  }

  /**
   * @param value The numeric wire value of the corresponding enum entry.
   * @return The enum associated with the given numeric wire value.
   * @deprecated Use {@link #forNumber(int)} instead.
   */
  @java.lang.Deprecated
  public static FieldBehavior valueOf(int value) {
    return forNumber(value);
  }

  /**
   * @param value The numeric wire value of the corresponding enum entry.
   * @return The enum associated with the given numeric wire value.
   */
  public static FieldBehavior forNumber(int value) {
    switch (value) {
      case 0: return FIELD_BEHAVIOR_UNSPECIFIED;
      case 1: return SECRET;
      default: return null;
    }
  }

  public static com.google.protobuf.Internal.EnumLiteMap
      internalGetValueMap() {
    return internalValueMap;
  }
  private static final com.google.protobuf.Internal.EnumLiteMap<
      FieldBehavior> internalValueMap =
        new com.google.protobuf.Internal.EnumLiteMap() {
          public FieldBehavior findValueByNumber(int number) {
            return FieldBehavior.forNumber(number);
          }
        };

  public final com.google.protobuf.Descriptors.EnumValueDescriptor
      getValueDescriptor() {
    return getDescriptor().getValues().get(ordinal());
  }
  public final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptorForType() {
    return getDescriptor();
  }
  public static final com.google.protobuf.Descriptors.EnumDescriptor
      getDescriptor() {
    return org.yamcs.api.AnnotationsProto.getDescriptor().getEnumTypes().get(0);
  }

  private static final FieldBehavior[] VALUES = values();

  public static FieldBehavior valueOf(
      com.google.protobuf.Descriptors.EnumValueDescriptor desc) {
    if (desc.getType() != getDescriptor()) {
      throw new java.lang.IllegalArgumentException(
        "EnumValueDescriptor is not for this type.");
    }
    return VALUES[desc.getIndex()];
  }

  private final int value;

  private FieldBehavior(int value) {
    this.value = value;
  }

  // @@protoc_insertion_point(enum_scope:yamcs.api.FieldBehavior)
}