注: 今後数か月にわたり、App Engine ドキュメント サイトの再編成を行い、コンテンツを見つけやすくなり、他の Google Cloud プロダクトと統一されます。内容は変わりませんが、ページ間のナビゲーションは残りの Cloud プロダクトと統一されます。操作中にフィードバックやご不明な点がある場合は、[フィードバックを送信] をクリックしてください。

TaskOptions (Google App Engine API for Java)

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
com.google.appengine.api.taskqueue

クラス TaskOptions

  • java.lang.Object
    • com.google.appengine.api.taskqueue.TaskOptions
  • すべての実装インターフェース:
    java.io.Serializable


    public final class TaskOptions
    extends java.lang.Object
    implements java.io.Serializable
    ビルダー パターンに従うタスクについての、さまざまなオプションが含まれています。 TaskOptions メソッドの呼び出しをチェーンすることによって、1 つの TaskOptions オブジェクトで複数のオプションを指定できます。

    taskOptions には TaskOptions.Method PULL または PUSH 関連メソッド(POST、GET など)のいずれかを指定できます。PULL メソッドを使用したタスクは PULL キューに追加でき、PUSH タスクは PUSH キューにのみ追加できます。

    使用上の注意:
    TaskOptions オブジェクトをインスタンス化するには、TaskOptions.Builder.* を静的にインポートし、静的作成メソッドを呼び出すことをおすすめします。そのとき、必要な場合はインスタンス ミューテーターを後に続けます。

     import static com.google.appengine.api.taskqueue.TaskOptions.Builder.*;
    
     ...
     QueueFactory.getDefaultQueue().add(withUrl(url).etaMillis(eta));
     

    関連情報:
    シリアル化された形式
    • コンストラクタの概要

      コンストラクタ 
      コンストラクタと説明
      TaskOptions(TaskOptions options)
      TaskOptions のコピー コンストラクタ。
    • メソッドの概要

      すべてのメソッド インスタンス メソッド 具象メソッド 
      修飾子と型 メソッドと説明
      TaskOptions clearParams()
      パラメータをクリアします。
      TaskOptions countdownMillis(long countdownMillis)
      タスクを実行するまでの遅延時間をミリ秒単位で設定します。
      boolean equals(java.lang.Object obj) 
      TaskOptions etaMillis(long etaMillis)
      実行する絶対時間の概算値を設定します。
      java.util.Map<java.lang.String,java.util.List<byte[]>> getByteArrayParams()
      タスクのバイト配列値パラメータのコピーを返します。これは、各パラメータ名からその名前の値リストへのマップです。
      java.lang.Long getCountdownMillis()
      送信された時刻に適用する遅延を返します。
      java.lang.Long getEtaMillis()
      タスクの指定された ETA を返します。
      java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()
      タスクのヘッダーのコピーを返します。これは、各ヘッダー名からそのヘッダー名の値リストへのマップです。
      TaskOptions.Method getMethod()
      このタスクに使用されたメソッドを返します。
      byte[] getPayload()
      タスクの実際のペイロードを返します。返されるのはコピーではありません。
      RetryOptions getRetryOptions()
      タスクの再試行オプションのコピーを返します。
      java.util.Map<java.lang.String,java.util.List<java.lang.String>> getStringParams()
      タスクの文字列型パラメータのコピーを返します。これは、各パラメータ名からその名前の値リストへのマップです。
      java.lang.String getTag()
      タスクのタグを返します。
      byte[] getTagAsBytes()
      タスクの実際のタグバイトを返します。返されるのはコピーではありません。
      java.lang.String getTaskName()
      タスク名を返します。
      java.lang.String getUrl() 
      int hashCode() 
      TaskOptions header(java.lang.String headerName, java.lang.String value)
      ヘッダー name/value ペアを追加します。
      TaskOptions headers(java.util.Map<java.lang.String,java.lang.String> headers)
      既存のヘッダーを、指定されたヘッダー name/value マッピングに置き換えます。
      TaskOptions method(TaskOptions.Method method)
      このタスクに使用するメソッドを設定します。
      TaskOptions param(java.lang.String name, byte[] value)
      名前付き byte 配列パラメータを追加します。
      TaskOptions param(java.lang.String name, java.lang.String value)
      名前付き String パラメータを追加します。
      TaskOptions payload(byte[] payload)
      コンテンツ タイプを指定せずにペイロードを直接設定します。
      TaskOptions payload(byte[] payload, java.lang.String contentType)
      指定されたコンテンツ タイプでペイロードを設定します。
      TaskOptions payload(DeferredTask deferredTask)
      シリアル化された形式の deferredTask オブジェクトにペイロードを設定します。
      TaskOptions payload(java.lang.String payload)
      ペイロードを String で設定します。
      TaskOptions payload(java.lang.String payload, java.lang.String charset)
      特定の文字セットを指定して String からペイロードを設定します。
      TaskOptions removeHeader(java.lang.String headerName)
      指定された名前のヘッダーをすべて削除します。
      TaskOptions removeParam(java.lang.String paramName)
      指定された名前のパラメータをすべて削除します。
      TaskOptions retryOptions(RetryOptions retryOptions)
      このタスクの再試行オプションを設定します。
      TaskOptions tag(byte[] tag)
      タスクのタグを設定します。
      TaskOptions tag(java.lang.String tag)
      タスクのタグを設定します。
      TaskOptions taskName(java.lang.String taskName)
      タスク名を設定します。
      java.lang.String toString() 
      TaskOptions url(java.lang.String url)
      URL を設定します。
      • java.lang.Object から継承されたメソッド

        getClass, notify, notifyAll, wait, wait, wait
    • コンストラクタの詳細

    • メソッドの詳細

      • taskName

        public TaskOptions taskName(java.lang.String taskName)
        タスク名を設定します。
        スロー:
        java.lang.IllegalArgumentException - 指定された名前が null または空であるか、または正規表現と一致しませんQueueConstants.TASK_NAME_REGEX
      • getTaskName

        public java.lang.String getTaskName()
        タスク名を返します。
      • getPayload

        public byte[] getPayload()
        タスクの実際のペイロードを返します。返されるのはコピーではありません。null にできます。
      • payload

        public TaskOptions payload(byte[] payload)
        コンテンツ タイプを指定せずにペイロードを直接設定します。このタスクが PUSH キューに追加された場合、コンテンツ タイプはデフォルトで 'application/octet-stream' に設定されます。
        パラメータ:
        payload - ペイロードを表すバイト。
        戻り値:
        チェーンにする TaskOptions オブジェクト。
      • payload

        public TaskOptions payload(DeferredTask deferredTask)
        シリアル化された形式の deferredTask オブジェクトにペイロードを設定します。 ObjectOutputStream.writeObject(Object) で deferredTask オブジェクトをシリアル化することによってペイロードが生成されます。deferredTask の TaskOptions.Method が PULL でない場合、コンテンツ タイプは DeferredTaskContext.RUNNABLE_TASK_CONTENT_TYPE に設定され、メソッドは強制的に TaskOptions.Method.POST になります。指定されていない場合、URL は DeferredTaskContext.DEFAULT_DEFERRED_URL に設定されます。デフォルトで、DeferredTask サーブレットがこの URL にマッピングされます。

        注: これは便利な API ですが、payload(DeferredTask) メソッドに渡すオブジェクトをシリアル化する際の互換性を慎重に制御する必要があります。タスクキューにオブジェクトが入っている間にアプリケーションのリビジョンが更新された場合、アプリケーションの新しいリビジョンでタスクをデコードするとき、それらのオブジェクトの逆シリアル化が失敗する可能性があります。特に、Java の匿名クラスは便利ですが、シリアル化の互換性を制御またはテストするのが非常に難しい場合があります。

        パラメータ:
        deferredTask - ペイロードとしてシリアル化するオブジェクト。
        スロー:
        DeferredTaskCreationException - iオブジェクトをシリアル化する際に IOException が発生した場合。
      • payload

        public TaskOptions payload(java.lang.String payload,
                                   java.lang.String charset)
        特定の文字セットを指定して String からペイロードを設定します。
        スロー:
        UnsupportedTranslationException
      • payload

        public TaskOptions payload(byte[] payload,
                                   java.lang.String contentType)
        指定されたコンテンツ タイプでペイロードを設定します。
        パラメータ:
        payload - ペイロードを表すバイト。
        contentType - バイトのコンテンツ タイプ。
        戻り値:
        チェーンにする TaskOptions オブジェクト。
      • payload

        public TaskOptions payload(java.lang.String payload)
        ペイロードを String で設定します。String に変換する文字セットは UTF-8 になります。ただし、メソッドが PULL の場合は、String のバイトデータがそのまま使用されます。
        パラメータ:
        payload - 使用する文字列。
        戻り値:
        チェーンにする TaskOptions オブジェクト。
      • getHeaders

        public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()
        タスクのヘッダーのコピーを返します。これは、各ヘッダー名からそのヘッダー名の値リストへのマップです。
      • headers

        public TaskOptions headers(java.util.Map<java.lang.String,java.lang.String> headers)
        既存のヘッダーを、指定されたヘッダー name/value マッピングに置き換えます。
        パラメータ:
        headers - コピーするヘッダー。
        戻り値:
        チェーンにする TaskOptions オブジェクト。
      • public TaskOptions header(java.lang.String headerName,
                                  java.lang.String value)
        ヘッダー name/value ペアを追加します。
        スロー:
        java.lang.IllegalArgumentException
      • removeHeader

        public TaskOptions removeHeader(java.lang.String headerName)
        指定された名前のヘッダーをすべて削除します。
      • getMethod

        public TaskOptions.Method getMethod()
        このタスクに使用されたメソッドを返します。
      • getStringParams

        public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getStringParams()
        タスクの文字列型パラメータのコピーを返します。これは、各パラメータ名からその名前の値リストへのマップです。
      • getByteArrayParams

        public java.util.Map<java.lang.String,java.util.List<byte[]>> getByteArrayParams()
        タスクのバイト配列値パラメータのコピーを返します。これは、各パラメータ名からその名前の値リストへのマップです。
      • clearParams

        public TaskOptions clearParams()
        パラメータをクリアします。
      • param

        public TaskOptions param(java.lang.String name,
                                 java.lang.String value)
        名前付き String パラメータを追加します。
        パラメータ:
        name - パラメータの名前。null または空にすることはできません。
        value - パラメータの値は、キューに追加するときに「UTF-8」の文字エンコード変換が行われます。 valuenull にすることはできません。
        スロー:
        java.lang.IllegalArgumentException
      • param

        public TaskOptions param(java.lang.String name,
                                 byte[] value)
        名前付き byte 配列パラメータを追加します。
        パラメータ:
        name - パラメータの名前。null または空にすることはできません。
        value - バイト配列。そのまま符号化されます(つまり、文字エンコーディング変換なし)。 valuenull にすることはできません。
        スロー:
        java.lang.IllegalArgumentException
      • removeParam

        public TaskOptions removeParam(java.lang.String paramName)
        指定された名前のパラメータをすべて削除します。
        パラメータ:
        paramName - パラメータの名前。null または空にすることはできません。
      • getUrl

        public java.lang.String getUrl()
      • url

        public TaskOptions url(java.lang.String url)
        URL を設定します。

        デフォルト値は null です。

        パラメータ:
        url - URL が含まれる文字列。
      • getCountdownMillis

        public java.lang.Long getCountdownMillis()
        送信された時刻に適用する遅延を返します。null にできます。
      • countdownMillis

        public TaskOptions countdownMillis(long countdownMillis)
        タスクを実行するまでの遅延時間をミリ秒単位で設定します。
      • getEtaMillis

        public java.lang.Long getEtaMillis()
        タスクの指定された ETA を返します。指定しない場合は null になります。
      • etaMillis

        public TaskOptions etaMillis(long etaMillis)
        実行する絶対時間の概算値を設定します。 (etaMillis は System.currentTimeMillis() と同等です)。
      • getRetryOptions

        public RetryOptions getRetryOptions()
        タスクの再試行オプションのコピーを返します。指定しない場合は null になります。
      • retryOptions

        public TaskOptions retryOptions(RetryOptions retryOptions)
        このタスクの再試行オプションを設定します。再試行オプションのビルドには、RetryOptions.Builder を使用します。
      • getTagAsBytes

        public byte[] getTagAsBytes()
        タスクの実際のタグバイトを返します。返されるのはコピーではありません。タグが指定されていない場合は null になります。
      • getTag

        public java.lang.String getTag()
                                throws java.io.UnsupportedEncodingException
        タスクのタグを返します。タグが指定されていない場合は null になります。
        スロー:
        java.io.UnsupportedEncodingException
      • tag

        public TaskOptions tag(byte[] tag)
        タスクのタグを設定します。null または長さがゼロのタグは無視されます。
      • tag

        public TaskOptions tag(java.lang.String tag)
        タスクのタグを設定します。null または空のタグは無視されます。
      • hashCode

        public int hashCode()
        オーバーライド:
        クラス java.lang.Object 内の hashCode
      • equals

        public boolean equals(java.lang.Object obj)
        オーバーライド:
        クラス java.lang.Object 内の equals
      • toString

        public java.lang.String toString()
        オーバーライド:
        クラス java.lang.Object 内の toString