Package com.google.cloud.retail.v2alpha

Enum Model.PeriodicTuningState

java.lang.Object
java.lang.Enum<Model.PeriodicTuningState>
com.google.cloud.retail.v2alpha.Model.PeriodicTuningState
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Model.PeriodicTuningState>
Enclosing class:
Model
public static enum Model.PeriodicTuningState extends Enum<Model.PeriodicTuningState> implements com.google.protobuf.ProtocolMessageEnum
 Describes whether periodic tuning is enabled for this model
 or not. Periodic tuning is scheduled at most every three months. You can
 start a tuning process manually by using the `TuneModel`
 method, which starts a tuning process immediately and resets the quarterly
 schedule. Enabling or disabling periodic tuning does not affect any
 current tuning processes.
Protobuf enum google.cloud.retail.v2alpha.Model.PeriodicTuningState

  • Enum Constant Details

    • PERIODIC_TUNING_STATE_UNSPECIFIED

      public static final Model.PeriodicTuningState PERIODIC_TUNING_STATE_UNSPECIFIED
       Unspecified default value, should never be explicitly set.
      PERIODIC_TUNING_STATE_UNSPECIFIED = 0;

    • PERIODIC_TUNING_DISABLED

      public static final Model.PeriodicTuningState PERIODIC_TUNING_DISABLED
       The model has periodic tuning disabled. Tuning
 can be reenabled by calling the `EnableModelPeriodicTuning`
 method or by calling the `TuneModel` method.
      PERIODIC_TUNING_DISABLED = 1;

    • ALL_TUNING_DISABLED

      public static final Model.PeriodicTuningState ALL_TUNING_DISABLED
       The model cannot be tuned with periodic tuning OR the
 `TuneModel` method. Hide the options in customer UI and
 reject any requests through the backend self serve API.
      ALL_TUNING_DISABLED = 3;

    • PERIODIC_TUNING_ENABLED

      public static final Model.PeriodicTuningState PERIODIC_TUNING_ENABLED
       The model has periodic tuning enabled. Tuning
 can be disabled by calling the `DisableModelPeriodicTuning`
 method.
      PERIODIC_TUNING_ENABLED = 2;

    • UNRECOGNIZED

      public static final Model.PeriodicTuningState UNRECOGNIZED

  • Field Details

    • PERIODIC_TUNING_STATE_UNSPECIFIED_VALUE

      public static final int PERIODIC_TUNING_STATE_UNSPECIFIED_VALUE
       Unspecified default value, should never be explicitly set.
      PERIODIC_TUNING_STATE_UNSPECIFIED = 0;
      See Also:

    • PERIODIC_TUNING_DISABLED_VALUE

      public static final int PERIODIC_TUNING_DISABLED_VALUE
       The model has periodic tuning disabled. Tuning
 can be reenabled by calling the `EnableModelPeriodicTuning`
 method or by calling the `TuneModel` method.
      PERIODIC_TUNING_DISABLED = 1;
      See Also:

    • ALL_TUNING_DISABLED_VALUE

      public static final int ALL_TUNING_DISABLED_VALUE
       The model cannot be tuned with periodic tuning OR the
 `TuneModel` method. Hide the options in customer UI and
 reject any requests through the backend self serve API.
      ALL_TUNING_DISABLED = 3;
      See Also:

    • PERIODIC_TUNING_ENABLED_VALUE

      public static final int PERIODIC_TUNING_ENABLED_VALUE
       The model has periodic tuning enabled. Tuning
 can be disabled by calling the `DisableModelPeriodicTuning`
 method.
      PERIODIC_TUNING_ENABLED = 2;
      See Also:

  • Method Details

    • values

      public static Model.PeriodicTuningState[] 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 Model.PeriodicTuningState 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 Model.PeriodicTuningState 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 Model.PeriodicTuningState 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<Model.PeriodicTuningState> 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 Model.PeriodicTuningState 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