Package com.google.cloud.tasks.v2

Enum Task.View

  • All Implemented Interfaces:
    com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Task.View>
    Enclosing class:
    Task
    public static enum Task.View
extends Enum<Task.View>
implements com.google.protobuf.ProtocolMessageEnum
     The view specifies a subset of [Task][google.cloud.tasks.v2.Task] data.

 When a task is returned in a response, not all
 information is retrieved by default because some data, such as
 payloads, might be desirable to return only when needed because
 of its large size or because of the sensitivity of data that it
 contains.
    Protobuf enum google.cloud.tasks.v2.Task.View

    • Enum Constant Detail

      • VIEW_UNSPECIFIED

        public static final Task.View VIEW_UNSPECIFIED
         Unspecified. Defaults to BASIC.
        VIEW_UNSPECIFIED = 0;

      • BASIC

        public static final Task.View BASIC
         The basic view omits fields which can be large or can contain
 sensitive data.

 This view does not include the
 [body in
 AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest.body].
 Bodies are desirable to return only when needed, because they
 can be large and because of the sensitivity of the data that you
 choose to store in it.
        BASIC = 1;

      • FULL

        public static final Task.View FULL
         All information is returned.

 Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Queue][google.cloud.tasks.v2.Queue] resource.
        FULL = 2;

      • UNRECOGNIZED

        public static final Task.View UNRECOGNIZED

    • Field Detail

      • VIEW_UNSPECIFIED_VALUE

        public static final int VIEW_UNSPECIFIED_VALUE
         Unspecified. Defaults to BASIC.
        VIEW_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • BASIC_VALUE

        public static final int BASIC_VALUE
         The basic view omits fields which can be large or can contain
 sensitive data.

 This view does not include the
 [body in
 AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest.body].
 Bodies are desirable to return only when needed, because they
 can be large and because of the sensitivity of the data that you
 choose to store in it.
        BASIC = 1;
        See Also:
        Constant Field Values

      • FULL_VALUE

        public static final int FULL_VALUE
         All information is returned.

 Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
 permission on the [Queue][google.cloud.tasks.v2.Queue] resource.
        FULL = 2;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static Task.View[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Task.View c : Task.View.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Task.View 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 Task.View 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 Task.View 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<Task.View> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static Task.View 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