Package com.google.cloud.commerce.consumer.procurement.v1

Enum CancelOrderRequest.CancellationPolicy

java.lang.Object
java.lang.Enum<CancelOrderRequest.CancellationPolicy>
com.google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<CancelOrderRequest.CancellationPolicy>
Enclosing class:
CancelOrderRequest
public static enum CancelOrderRequest.CancellationPolicy extends Enum<CancelOrderRequest.CancellationPolicy> implements com.google.protobuf.ProtocolMessageEnum
 Indicates the cancellation policy the customer uses to cancel the order.
Protobuf enum google.cloud.commerce.consumer.procurement.v1.CancelOrderRequest.CancellationPolicy

  • Enum Constant Details

    • CANCELLATION_POLICY_UNSPECIFIED

      public static final CancelOrderRequest.CancellationPolicy CANCELLATION_POLICY_UNSPECIFIED
       If unspecified, cancellation will try to cancel the order, if order
 cannot be immediately cancelled, auto renewal will be turned off.
 However, caller should avoid using the value as it will yield a
 non-deterministic result. This is still supported mainly to maintain
 existing integrated usages and ensure backwards compatibility.
      CANCELLATION_POLICY_UNSPECIFIED = 0;

    • CANCELLATION_POLICY_CANCEL_IMMEDIATELY

      public static final CancelOrderRequest.CancellationPolicy CANCELLATION_POLICY_CANCEL_IMMEDIATELY
       Request will cancel the whole order immediately, if order cannot be
 immediately cancelled, the request will fail.
      CANCELLATION_POLICY_CANCEL_IMMEDIATELY = 1;

    • CANCELLATION_POLICY_CANCEL_AT_TERM_END

      public static final CancelOrderRequest.CancellationPolicy CANCELLATION_POLICY_CANCEL_AT_TERM_END
       Request will cancel the auto renewal, if order is not subscription based,
 the request will fail.
      CANCELLATION_POLICY_CANCEL_AT_TERM_END = 2;

    • UNRECOGNIZED

      public static final CancelOrderRequest.CancellationPolicy UNRECOGNIZED

  • Field Details

    • CANCELLATION_POLICY_UNSPECIFIED_VALUE

      public static final int CANCELLATION_POLICY_UNSPECIFIED_VALUE
       If unspecified, cancellation will try to cancel the order, if order
 cannot be immediately cancelled, auto renewal will be turned off.
 However, caller should avoid using the value as it will yield a
 non-deterministic result. This is still supported mainly to maintain
 existing integrated usages and ensure backwards compatibility.
      CANCELLATION_POLICY_UNSPECIFIED = 0;
      See Also:

    • CANCELLATION_POLICY_CANCEL_IMMEDIATELY_VALUE

      public static final int CANCELLATION_POLICY_CANCEL_IMMEDIATELY_VALUE
       Request will cancel the whole order immediately, if order cannot be
 immediately cancelled, the request will fail.
      CANCELLATION_POLICY_CANCEL_IMMEDIATELY = 1;
      See Also:

    • CANCELLATION_POLICY_CANCEL_AT_TERM_END_VALUE

      public static final int CANCELLATION_POLICY_CANCEL_AT_TERM_END_VALUE
       Request will cancel the auto renewal, if order is not subscription based,
 the request will fail.
      CANCELLATION_POLICY_CANCEL_AT_TERM_END = 2;
      See Also:

  • Method Details

    • values

      public static CancelOrderRequest.CancellationPolicy[] 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 CancelOrderRequest.CancellationPolicy 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 CancelOrderRequest.CancellationPolicy 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 CancelOrderRequest.CancellationPolicy 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<CancelOrderRequest.CancellationPolicy> 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 CancelOrderRequest.CancellationPolicy 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