Enum RequestOptions.Priority

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<RequestOptions.Priority>
    Enclosing class:
    RequestOptions

    public static enum RequestOptions.Priority
    extends Enum<RequestOptions.Priority>
    implements com.google.protobuf.ProtocolMessageEnum
     The relative priority for requests. Note that priority is not applicable
     for [BeginTransaction][google.spanner.v1.Spanner.BeginTransaction].
    
     The priority acts as a hint to the Cloud Spanner scheduler and does not
     guarantee priority or order of execution. For example:
    
     * Some parts of a write operation always execute at `PRIORITY_HIGH`,
       regardless of the specified priority. This may cause you to see an
       increase in high priority workload even when executing a low priority
       request. This can also potentially cause a priority inversion where a
       lower priority request will be fulfilled ahead of a higher priority
       request.
     * If a transaction contains multiple operations with different priorities,
       Cloud Spanner does not guarantee to process the higher priority
       operations first. There may be other constraints to satisfy, such as
       order of operations.
     
    Protobuf enum google.spanner.v1.RequestOptions.Priority
    • Enum Constant Detail

      • PRIORITY_UNSPECIFIED

        public static final RequestOptions.Priority PRIORITY_UNSPECIFIED
         `PRIORITY_UNSPECIFIED` is equivalent to `PRIORITY_HIGH`.
         
        PRIORITY_UNSPECIFIED = 0;
      • PRIORITY_LOW

        public static final RequestOptions.Priority PRIORITY_LOW
         This specifies that the request is low priority.
         
        PRIORITY_LOW = 1;
      • PRIORITY_MEDIUM

        public static final RequestOptions.Priority PRIORITY_MEDIUM
         This specifies that the request is medium priority.
         
        PRIORITY_MEDIUM = 2;
      • PRIORITY_HIGH

        public static final RequestOptions.Priority PRIORITY_HIGH
         This specifies that the request is high priority.
         
        PRIORITY_HIGH = 3;
    • Field Detail

      • PRIORITY_UNSPECIFIED_VALUE

        public static final int PRIORITY_UNSPECIFIED_VALUE
         `PRIORITY_UNSPECIFIED` is equivalent to `PRIORITY_HIGH`.
         
        PRIORITY_UNSPECIFIED = 0;
        See Also:
        Constant Field Values
      • PRIORITY_LOW_VALUE

        public static final int PRIORITY_LOW_VALUE
         This specifies that the request is low priority.
         
        PRIORITY_LOW = 1;
        See Also:
        Constant Field Values
      • PRIORITY_MEDIUM_VALUE

        public static final int PRIORITY_MEDIUM_VALUE
         This specifies that the request is medium priority.
         
        PRIORITY_MEDIUM = 2;
        See Also:
        Constant Field Values
      • PRIORITY_HIGH_VALUE

        public static final int PRIORITY_HIGH_VALUE
         This specifies that the request is high priority.
         
        PRIORITY_HIGH = 3;
        See Also:
        Constant Field Values
    • Method Detail

      • values

        public static RequestOptions.Priority[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (RequestOptions.Priority c : RequestOptions.Priority.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RequestOptions.Priority 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 RequestOptions.Priority 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 RequestOptions.Priority 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<RequestOptions.Priority> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
      • valueOf

        public static RequestOptions.Priority 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