Package com.google.cloud.documentai.v1

Enum Document.Provenance.OperationType

java.lang.Object
java.lang.Enum<Document.Provenance.OperationType>
com.google.cloud.documentai.v1.Document.Provenance.OperationType
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Document.Provenance.OperationType>
Enclosing class:
Document.Provenance
public static enum Document.Provenance.OperationType extends Enum<Document.Provenance.OperationType> implements com.google.protobuf.ProtocolMessageEnum
 If a processor or agent does an explicit operation on existing elements.
Protobuf enum google.cloud.documentai.v1.Document.Provenance.OperationType

  • Enum Constant Details

    • OPERATION_TYPE_UNSPECIFIED

      public static final Document.Provenance.OperationType OPERATION_TYPE_UNSPECIFIED
       Operation type unspecified. If no operation is specified a provenance
 entry is simply used to match against a `parent`.
      OPERATION_TYPE_UNSPECIFIED = 0;

    • ADD

      public static final Document.Provenance.OperationType ADD
       Add an element.
      ADD = 1;

    • REMOVE

      public static final Document.Provenance.OperationType REMOVE
       Remove an element identified by `parent`.
      REMOVE = 2;

    • UPDATE

      public static final Document.Provenance.OperationType UPDATE
       Updates any fields within the given provenance scope of the message. It
 overwrites the fields rather than replacing them.  Use this when you
 want to update a field value of an entity without also updating all the
 child properties.
      UPDATE = 7;

    • REPLACE

      public static final Document.Provenance.OperationType REPLACE
       Currently unused. Replace an element identified by `parent`.
      REPLACE = 3;

    • EVAL_REQUESTED

      @Deprecated public static final Document.Provenance.OperationType EVAL_REQUESTED
      Deprecated.
       Deprecated. Request human review for the element identified by
 `parent`.
      EVAL_REQUESTED = 4 [deprecated = true];

    • EVAL_APPROVED

      @Deprecated public static final Document.Provenance.OperationType EVAL_APPROVED
      Deprecated.
       Deprecated. Element is reviewed and approved at human review,
 confidence will be set to 1.0.
      EVAL_APPROVED = 5 [deprecated = true];

    • EVAL_SKIPPED

      @Deprecated public static final Document.Provenance.OperationType EVAL_SKIPPED
      Deprecated.
       Deprecated. Element is skipped in the validation process.
      EVAL_SKIPPED = 6 [deprecated = true];

    • UNRECOGNIZED

      public static final Document.Provenance.OperationType UNRECOGNIZED

  • Field Details

    • OPERATION_TYPE_UNSPECIFIED_VALUE

      public static final int OPERATION_TYPE_UNSPECIFIED_VALUE
       Operation type unspecified. If no operation is specified a provenance
 entry is simply used to match against a `parent`.
      OPERATION_TYPE_UNSPECIFIED = 0;
      See Also:

    • ADD_VALUE

      public static final int ADD_VALUE
       Add an element.
      ADD = 1;
      See Also:

    • REMOVE_VALUE

      public static final int REMOVE_VALUE
       Remove an element identified by `parent`.
      REMOVE = 2;
      See Also:

    • UPDATE_VALUE

      public static final int UPDATE_VALUE
       Updates any fields within the given provenance scope of the message. It
 overwrites the fields rather than replacing them.  Use this when you
 want to update a field value of an entity without also updating all the
 child properties.
      UPDATE = 7;
      See Also:

    • REPLACE_VALUE

      public static final int REPLACE_VALUE
       Currently unused. Replace an element identified by `parent`.
      REPLACE = 3;
      See Also:

    • EVAL_REQUESTED_VALUE

      @Deprecated public static final int EVAL_REQUESTED_VALUE
      Deprecated.
       Deprecated. Request human review for the element identified by
 `parent`.
      EVAL_REQUESTED = 4 [deprecated = true];
      See Also:

    • EVAL_APPROVED_VALUE

      @Deprecated public static final int EVAL_APPROVED_VALUE
      Deprecated.
       Deprecated. Element is reviewed and approved at human review,
 confidence will be set to 1.0.
      EVAL_APPROVED = 5 [deprecated = true];
      See Also:

    • EVAL_SKIPPED_VALUE

      @Deprecated public static final int EVAL_SKIPPED_VALUE
      Deprecated.
       Deprecated. Element is skipped in the validation process.
      EVAL_SKIPPED = 6 [deprecated = true];
      See Also:

  • Method Details

    • values

      public static Document.Provenance.OperationType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Document.Provenance.OperationType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum

    • valueOf

      @Deprecated public static Document.Provenance.OperationType valueOf(int value)
      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • forNumber

      public static Document.Provenance.OperationType forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.

    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<Document.Provenance.OperationType> internalGetValueMap()

    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static Document.Provenance.OperationType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null