Package com.google.cloud.chronicle.v1

Enum RuleView

java.lang.Object
java.lang.Enum<RuleView>
com.google.cloud.chronicle.v1.RuleView
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<RuleView>
@Generated public enum RuleView extends Enum<RuleView> implements com.google.protobuf.ProtocolMessageEnum
 RuleView indicates the scope of fields to populate when returning the Rule
 resource.
Protobuf enum google.cloud.chronicle.v1.RuleView

  • Enum Constant Details

    • RULE_VIEW_UNSPECIFIED

      public static final RuleView RULE_VIEW_UNSPECIFIED
       The default/unset value.
 The API will default to the BASIC view for ListRules/ListRuleRevisions.
 The API will default to the FULL view for GetRule.
      RULE_VIEW_UNSPECIFIED = 0;

    • BASIC

      public static final RuleView BASIC
       Include basic metadata about the rule, but not the full contents.
 Returned fields include: revision_id, revision_create_time, display_name,
 author, severity, type, allowed_run_frequency,
 near_real_time_live_rule_eligible, etag, and scope.
 This is the default value for ListRules and ListRuleRevisions.
      BASIC = 1;

    • FULL

      public static final RuleView FULL
       Include all fields.
 This is the default value for GetRule.
      FULL = 2;

    • REVISION_METADATA_ONLY

      public static final RuleView REVISION_METADATA_ONLY
       Include basic metadata about the rule's revision only.
 Returned fields include: revision_id and revision_create_time.
      REVISION_METADATA_ONLY = 3;

    • UNRECOGNIZED

      public static final RuleView UNRECOGNIZED

  • Field Details

    • RULE_VIEW_UNSPECIFIED_VALUE

      public static final int RULE_VIEW_UNSPECIFIED_VALUE
       The default/unset value.
 The API will default to the BASIC view for ListRules/ListRuleRevisions.
 The API will default to the FULL view for GetRule.
      RULE_VIEW_UNSPECIFIED = 0;
      See Also:

    • BASIC_VALUE

      public static final int BASIC_VALUE
       Include basic metadata about the rule, but not the full contents.
 Returned fields include: revision_id, revision_create_time, display_name,
 author, severity, type, allowed_run_frequency,
 near_real_time_live_rule_eligible, etag, and scope.
 This is the default value for ListRules and ListRuleRevisions.
      BASIC = 1;
      See Also:

    • FULL_VALUE

      public static final int FULL_VALUE
       Include all fields.
 This is the default value for GetRule.
      FULL = 2;
      See Also:

    • REVISION_METADATA_ONLY_VALUE

      public static final int REVISION_METADATA_ONLY_VALUE
       Include basic metadata about the rule's revision only.
 Returned fields include: revision_id and revision_create_time.
      REVISION_METADATA_ONLY = 3;
      See Also:

  • Method Details

    • values

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