Enum BranchView

java.lang.Object
java.lang.Enum<BranchView>
com.google.cloud.retail.v2alpha.BranchView
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<BranchView>

@Generated public enum BranchView extends Enum<BranchView> implements com.google.protobuf.ProtocolMessageEnum
 A view that specifies different level of fields of a
 [Branch][google.cloud.retail.v2alpha.Branch] to show in responses.
 
Protobuf enum google.cloud.retail.v2alpha.BranchView
  • Enum Constant Details

    • BRANCH_VIEW_UNSPECIFIED

      public static final BranchView BRANCH_VIEW_UNSPECIFIED
       The value when it's unspecified. This defaults to the BASIC view.
       
      BRANCH_VIEW_UNSPECIFIED = 0;
    • BRANCH_VIEW_BASIC

      public static final BranchView BRANCH_VIEW_BASIC
       Includes basic metadata about the branch, but not statistical fields.
       See documentation of fields of [Branch][google.cloud.retail.v2alpha.Branch]
       to find what fields are excluded from BASIC view.
       
      BRANCH_VIEW_BASIC = 1;
    • BRANCH_VIEW_FULL

      public static final BranchView BRANCH_VIEW_FULL
       Includes all fields of a [Branch][google.cloud.retail.v2alpha.Branch].
       
      BRANCH_VIEW_FULL = 2;
    • UNRECOGNIZED

      public static final BranchView UNRECOGNIZED
  • Field Details

    • BRANCH_VIEW_UNSPECIFIED_VALUE

      public static final int BRANCH_VIEW_UNSPECIFIED_VALUE
       The value when it's unspecified. This defaults to the BASIC view.
       
      BRANCH_VIEW_UNSPECIFIED = 0;
      See Also:
    • BRANCH_VIEW_BASIC_VALUE

      public static final int BRANCH_VIEW_BASIC_VALUE
       Includes basic metadata about the branch, but not statistical fields.
       See documentation of fields of [Branch][google.cloud.retail.v2alpha.Branch]
       to find what fields are excluded from BASIC view.
       
      BRANCH_VIEW_BASIC = 1;
      See Also:
    • BRANCH_VIEW_FULL_VALUE

      public static final int BRANCH_VIEW_FULL_VALUE
       Includes all fields of a [Branch][google.cloud.retail.v2alpha.Branch].
       
      BRANCH_VIEW_FULL = 2;
      See Also:
  • Method Details

    • values

      public static BranchView[] 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 BranchView 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 BranchView 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 BranchView 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<BranchView> 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 BranchView 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