Enum Purpose

java.lang.Object
java.lang.Enum<Purpose>
com.google.cloud.resourcemanager.v3.Purpose
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Purpose>

@Generated public enum Purpose extends Enum<Purpose> implements com.google.protobuf.ProtocolMessageEnum
 A purpose for each policy engine requiring such an integration. A single
 policy engine may have multiple purposes defined, however a TagKey may only
 specify a single purpose.
 
Protobuf enum google.cloud.resourcemanager.v3.Purpose
  • Enum Constant Details

    • PURPOSE_UNSPECIFIED

      public static final Purpose PURPOSE_UNSPECIFIED
       Unspecified purpose.
       
      PURPOSE_UNSPECIFIED = 0;
    • GCE_FIREWALL

      public static final Purpose GCE_FIREWALL
       Purpose for Compute Engine firewalls.
       A corresponding `purpose_data` should be set for the network the tag is
       intended for. The key should be `network` and the value should be in
       either of these two formats:
      
       -
       `https://www.googleapis.com/compute/{compute_version}/projects/{project_id}/global/networks/{network_id}`
       - `{project_id}/{network_name}`
      
       Examples:
      
       -
       `https://www.googleapis.com/compute/staging_v1/projects/fail-closed-load-testing/global/networks/6992953698831725600`
       - `fail-closed-load-testing/load-testing-network`
       
      GCE_FIREWALL = 1;
    • UNRECOGNIZED

      public static final Purpose UNRECOGNIZED
  • Field Details

    • PURPOSE_UNSPECIFIED_VALUE

      public static final int PURPOSE_UNSPECIFIED_VALUE
       Unspecified purpose.
       
      PURPOSE_UNSPECIFIED = 0;
      See Also:
    • GCE_FIREWALL_VALUE

      public static final int GCE_FIREWALL_VALUE
       Purpose for Compute Engine firewalls.
       A corresponding `purpose_data` should be set for the network the tag is
       intended for. The key should be `network` and the value should be in
       either of these two formats:
      
       -
       `https://www.googleapis.com/compute/{compute_version}/projects/{project_id}/global/networks/{network_id}`
       - `{project_id}/{network_name}`
      
       Examples:
      
       -
       `https://www.googleapis.com/compute/staging_v1/projects/fail-closed-load-testing/global/networks/6992953698831725600`
       - `fail-closed-load-testing/load-testing-network`
       
      GCE_FIREWALL = 1;
      See Also:
  • Method Details

    • values

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