TaskOptions (API de Google App Engine para Java)

java.lang.Object
- com.google.appengine.api.taskqueue.TaskOptions

Todas las interfaces implementadas:

java.io.Serializable
```
public final class TaskOptions
extends java.lang.Object
implements java.io.Serializable
```
Contiene varias opciones para una tarea que sigue el patrón del compilador. Las llamadas a los métodos TaskOptions se pueden encadenar para especificar varias opciones en el objeto TaskOptions.
taskOptions puede tener un complemento TaskOptions.Method PULL o un método relacionado con PUSH, p. ej., POST, GET, ... Las tareas con el método PULL solo se pueden agregar a una cola PULL y las tareas de PUSH solo se pueden agregar a una cola de PUSH.
Notas sobre el uso:
La forma recomendada de crear una instancia de un objeto TaskOptions es importar de forma estática TaskOptions.Builder.* y, luego, invocar un método de creación estático seguido de un mutador de instancias (si es necesario):
```
 import static com.google.appengine.api.taskqueue.TaskOptions.Builder.*;

 ...
 QueueFactory.getDefaultQueue().add(withUrl(url).etaMillis(eta));
 
```
Consulta también lo siguiente:

Formulario serializado

Resumen de clases anidadas

Clases anidadas
Modificador y tipo	Clase y descripción
`static class`	`TaskOptions.Builder` Proporciona métodos de creación estática para `TaskOptions`.
`static class`	`TaskOptions.Method` Métodos admitidos por `Queue`

Resumen de constructores

Constructores
Constructor y descripción

TaskOptions(TaskOptions options)
Un constructor de copias para TaskOptions.

Resumen de métodos

Todos los métodos Métodos de instancia Métodos concretos
Modificador y tipo	Método y descripción
`TaskOptions`	`clearParams()` Borra los parámetros.
`TaskOptions`	`countdownMillis(long countdownMillis)` Establece la cantidad de milisegundos de retraso antes de la ejecución de la tarea.
`boolean`	`equals(java.lang.Object obj)`
`TaskOptions`	`etaMillis(long etaMillis)` Establece el tiempo absoluto aproximado para ejecutar.
`java.util.Map<java.lang.String,java.util.List<byte[]>>`	`getByteArrayParams()` Muestra una copia de los parámetros con valores de array de bytes de la tarea como una asignación de cada nombre de parámetro a una lista de valores para ese nombre.
`java.lang.Long`	`getCountdownMillis()` Muestra el retraso que se aplicará a la hora enviada.
`java.lang.Long`	`getEtaMillis()` Muestra el ETA especificado para una tarea.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getHeaders()` Muestra una copia de los encabezados de la tarea como un mapa desde el nombre de cada encabezado en una lista de valores para ese nombre de encabezado.
`TaskOptions.Method`	`getMethod()` Muestra el método utilizado para esta tarea.
`byte[]`	`getPayload()` Muestra la carga útil en vivo de la tarea, no una copia.
`RetryOptions`	`getRetryOptions()` Muestra una copia de las opciones de reintento para una tarea.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getStringParams()` Muestra una copia de los parámetros con valores de string de la tarea como un mapa desde el nombre de cada parámetro a una lista de valores para ese nombre.
`java.lang.String`	`getTag()` Muestra la etiqueta de una tarea.
`byte[]`	`getTagAsBytes()` Muestra los bytes de la etiqueta activa para una tarea, no una copia.
`java.lang.String`	`getTaskName()` Muestra el nombre de la tarea.
`java.lang.String`	`getUrl()`
`int`	`hashCode()`
`TaskOptions`	`header(java.lang.String headerName, java.lang.String value)` Agrega un par `name/value` de encabezado.
`TaskOptions`	`headers(java.util.Map<java.lang.String,java.lang.String> headers)` Reemplaza los encabezados existentes con la asignación de encabezado `name/value` proporcionada.
`TaskOptions`	`method(TaskOptions.Method method)` Establece el método que se usa para esta tarea.
`TaskOptions`	`param(java.lang.String name, byte[] value)` Agrega un parámetro de array `byte` con nombre.
`TaskOptions`	`param(java.lang.String name, java.lang.String value)` Agrega un parámetro `String` con nombre.
`TaskOptions`	`payload(byte[] payload)` Configura la carga útil directamente sin especificar el tipo de contenido.
`TaskOptions`	`payload(byte[] payload, java.lang.String contentType)` Configura la carga útil con el tipo de contenido determinado.
`TaskOptions`	`payload(DeferredTask deferredTask)` Configura la carga útil como el formato serializado del objeto deferredTask.
`TaskOptions`	`payload(java.lang.String payload)` Configura la carga útil por `String`.
`TaskOptions`	`payload(java.lang.String payload, java.lang.String charset)` Establece la carga útil de un `String` dado un grupo de caracteres específico.
`TaskOptions`	`removeHeader(java.lang.String headerName)` Quita todos los encabezados con el nombre determinado.
`TaskOptions`	`removeParam(java.lang.String paramName)` Quita todos los parámetros con el nombre determinado.
`TaskOptions`	`retryOptions(RetryOptions retryOptions)` Configura opciones de reintento para esta tarea.
`TaskOptions`	`tag(byte[] tag)` Configura la etiqueta para una tarea.
`TaskOptions`	`tag(java.lang.String tag)` Configura la etiqueta para una tarea.
`TaskOptions`	`taskName(java.lang.String taskName)` Establece el nombre de la tarea.
`java.lang.String`	`toString()`
`TaskOptions`	`url(java.lang.String url)` Configura la URL.

Métodos heredados de la clase java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Detalles del constructor
  - TaskOptions
```
public TaskOptions(TaskOptions options)
```
    Un constructor de copias para TaskOptions.
- Detalle del método
  - taskName
```
public TaskOptions taskName(java.lang.String taskName)
```
    Establece el nombre de la tarea.
    
    Arroja:
    
    java.lang.IllegalArgumentException: El nombre proporcionado es nulo, vacío o no coincide con la expresión regular QueueConstants.TASK_NAME_REGEX
  - getTaskName
```
public java.lang.String getTaskName()
```
    Muestra el nombre de la tarea.
  - getPayload
```
public byte[] getPayload()
```
    Muestra la carga útil en vivo de la tarea, no una copia. Tal vez null.
  - Carga útil
```
public TaskOptions payload(byte[] payload)
```
    Configura la carga útil directamente sin especificar el tipo de contenido. Si esta tarea se agrega a una lista de aplicaciones en cola, el tipo de contenido se establecerá en "application/octet-stream" de forma predeterminada.
    
    Parámetros:
    
    payload: Los bytes que representan el pago.
    
    Muestra:
    
    Objeto TaskOptions para encadenar
  - Carga útil
```
public TaskOptions payload(DeferredTask deferredTask)
```
    Configura la carga útil como el formato serializado del objeto deferredTask. La carga útil se generará mediante la serialización del objeto deferredTask con ObjectOutputStream.writeObject(Object). Si el TaskOptions.Method de deferredTask no es PULL, el tipo de contenido se establecerá como DeferredTaskContext.RUNNABLE_TASK_CONTENT_TYPE, el método será forzado a TaskOptions.Method.POST y, si no se especifica lo contrario, la URL se establecerá en DeferredTaskContext.DEFAULT_DEFERRED_URL; el servlet DeferredTask se asigna a esta URL de forma predeterminada.
    Nota: Si bien esta puede ser una API adecuada, requiere un control detallado de la compatibilidad de serialización de los objetos pasados al método payload(DeferredTask), ya que los objetos ubicados en la lista de tareas en cola sobrevivirán a las actualizaciones de revisión de la aplicación y, por lo tanto, la serialización puede fallar cuando la tarea se decodifica con nuevas revisiones de la aplicación. En particular, las clases anónimas de Java son adecuadas, pero puede ser muy difícil controlar o probar la compatibilidad de la serialización.
    
    Parámetros:
    
    deferredTask: El objeto que se serializa en la carga útil.
    
    Arroja:
    
    DeferredTaskCreationException: Si hubo un objeto de serialización de IOException.
  - Carga útil
```
public TaskOptions payload(java.lang.String payload,
                           java.lang.String charset)
```
    Establece la carga útil de un String dado un grupo de caracteres específico.
    
    Arroja:
    
    UnsupportedTranslationException
  - Carga útil
```
public TaskOptions payload(byte[] payload,
                           java.lang.String contentType)
```
    Configura la carga útil con el tipo de contenido determinado.
    
    Parámetros:
    
    payload: Los bytes que representan el pago.
    
    contentType: El tipo de contenido de los bytes.
    
    Muestra:
    
    Objeto TaskOptions para encadenar
  - Carga útil
```
public TaskOptions payload(java.lang.String payload)
```
    Configura la carga útil por String. El charset para convertir la string en UTF-8, a menos que el método sea PULL, en cuyo caso los bytes de la string se usarán directamente.
    
    Parámetros:
    
    payload: La string que se usará.
    
    Muestra:
    
    Objeto TaskOptions para encadenar
  - getHeaders
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()
```
    Muestra una copia de los encabezados de la tarea como un mapa desde el nombre de cada encabezado en una lista de valores para ese nombre de encabezado.
  - encabezados
```
public TaskOptions headers(java.util.Map<java.lang.String,java.lang.String> headers)
```
    Reemplaza los encabezados existentes con la asignación de encabezado name/value proporcionada.
    
    Parámetros:
    
    headers: Los encabezados que se copiarán.
    
    Muestra:
    
    Objeto TaskOptions para encadenar
  - encabezado
```
public TaskOptions header(java.lang.String headerName,
                          java.lang.String value)
```
    Agrega un par name/value de encabezado.
    
    Arroja:
    
    java.lang.IllegalArgumentException
  - removeHeader
```
public TaskOptions removeHeader(java.lang.String headerName)
```
    Quita todos los encabezados con el nombre determinado.
  - getMethod
```
public TaskOptions.Method getMethod()
```
    Muestra el método utilizado para esta tarea.
  - método
```
public TaskOptions method(TaskOptions.Method method)
```
    Establece el método que se usa para esta tarea. La configuración predeterminada es TaskOptions.Method.POST.
  - getStringParams
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getStringParams()
```
    Muestra una copia de los parámetros con valores de string de la tarea como un mapa desde el nombre de cada parámetro a una lista de valores para ese nombre.
  - getByteArrayParams
```
public java.util.Map<java.lang.String,java.util.List<byte[]>> getByteArrayParams()
```
    Muestra una copia de los parámetros con valores de array de bytes de la tarea como una asignación de cada nombre de parámetro a una lista de valores para ese nombre.
  - clearParams
```
public TaskOptions clearParams()
```
    Borra los parámetros.
  - param
```
public TaskOptions param(java.lang.String name,
                         java.lang.String value)
```
    Agrega un parámetro String con nombre.
    
    Parámetros:
    
    name: El nombre del parámetro. No debe ser nulo ni vacío.
    
    value: El valor del parámetro se someterá a una transformación de codificación de caracteres “UTF-8” cuando se agregue a la cola. value no debe ser null.
    
    Arroja:
    
    java.lang.IllegalArgumentException
  - param
```
public TaskOptions param(java.lang.String name,
                         byte[] value)
```
    Agrega un parámetro de array byte con nombre.
    
    Parámetros:
    
    name: El nombre del parámetro. No debe ser nulo ni vacío.
    
    value: Un array de bytes y codificado como está (es decir, sin transformaciones de codificación de caracteres). value no debe ser null.
    
    Arroja:
    
    java.lang.IllegalArgumentException
  - removeParam
```
public TaskOptions removeParam(java.lang.String paramName)
```
    Quita todos los parámetros con el nombre determinado.
    
    Parámetros:
    
    paramName: El nombre del parámetro. No debe ser nulo ni vacío.
  - getUrl
```
public java.lang.String getUrl()
```
  - url
```
public TaskOptions url(java.lang.String url)
```
    Configura la URL.
    El valor predeterminado es null.
    
    Parámetros:
    
    url: String que contiene la URL.
  - getCountdownMillis
```
public java.lang.Long getCountdownMillis()
```
    Muestra el retraso que se aplicará a la hora enviada. Tal vez null.
  - countdownMillis
```
public TaskOptions countdownMillis(long countdownMillis)
```
    Establece la cantidad de milisegundos de retraso antes de la ejecución de la tarea.
  - getEtaMillis
```
public java.lang.Long getEtaMillis()
```
    Muestra el ETA especificado para una tarea. Puede ser null si no se especifica.
  - etaMillis
```
public TaskOptions etaMillis(long etaMillis)
```
    Establece el tiempo absoluto aproximado para ejecutar. (es decir, etaMillis es comparable con System.currentTimeMillis()).
  - getRetryOptions
```
public RetryOptions getRetryOptions()
```
    Muestra una copia de las opciones de reintento para una tarea. Puede ser null si no se especifica.
  - retryOptions
```
public TaskOptions retryOptions(RetryOptions retryOptions)
```
    Configura opciones de reintento para esta tarea. Las opciones de reintento deben compilarse con RetryOptions.Builder.
  - getTagAsBytes
```
public byte[] getTagAsBytes()
```
    Muestra los bytes de la etiqueta activa para una tarea, no una copia. Puede ser null si no se especifica la etiqueta.
  - getTag
```
public java.lang.String getTag()
                        throws java.io.UnsupportedEncodingException
```
    Muestra la etiqueta de una tarea. Puede ser null si no se especifica la etiqueta.
    
    Arroja:
    
    java.io.UnsupportedEncodingException
  - etiqueta de política
```
public TaskOptions tag(byte[] tag)
```
    Configura la etiqueta para una tarea. Ignora las etiquetas nulas o de longitud cero.
  - etiqueta de política
```
public TaskOptions tag(java.lang.String tag)
```
    Configura la etiqueta para una tarea. Ignora las etiquetas nulas o vacías.
  - hashCode
```
public int hashCode()
```
    Anula:
    
    hashCode en la clase java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Anula:
    
    equals en la clase java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Anula:
    
    toString en la clase java.lang.Object

Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.

Última actualización: 2022-11-07 (UTC)

TaskOptions (API de Google App Engine para Java)

Clase TaskOptions

Resumen de clases anidadas

Resumen de constructores

Resumen de métodos

Métodos heredados de la clase java.lang.Object

Detalles del constructor

TaskOptions

Detalle del método

taskName

getTaskName

getPayload

Carga útil

Carga útil

Carga útil

Carga útil

Carga útil

getHeaders

encabezados

encabezado

removeHeader

getMethod

método

getStringParams

getByteArrayParams

clearParams

param

param

removeParam

getUrl

url

getCountdownMillis

countdownMillis

getEtaMillis

etaMillis

getRetryOptions

retryOptions

getTagAsBytes

getTag

etiqueta de política

etiqueta de política

hashCode

equals

toString