com.amazonaws.services.datapipeline.model

## クラス PollForTaskRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.datapipeline.model.PollForTaskRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class PollForTaskRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `PollForTask operation`.

  Task runners call this action to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter of the PollForTask call. The task returned by PollForTask may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.

  If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same `workerGroup` until it receives a response, and this may take up to 90 seconds.

  関連項目:
    `DataPipeline.pollForTask(PollForTaskRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `PollForTaskRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getHostname()` The public DNS name of the calling task runner.
    `InstanceIdentity` | `getInstanceIdentity()` Identity information for the Amazon EC2 instance that is hosting the task runner.
    `java.lang.String` | `getWorkerGroup()` Indicates the type of task the task runner is configured to accept and process.
    `int` | `hashCode()`
    `void` | `setHostname(java.lang.String hostname)` The public DNS name of the calling task runner.
    `void` | `setInstanceIdentity(InstanceIdentity instanceIdentity)` Identity information for the Amazon EC2 instance that is hosting the task runner.
    `void` | `setWorkerGroup(java.lang.String workerGroup)` Indicates the type of task the task runner is configured to accept and process.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `PollForTaskRequest` | `withHostname(java.lang.String hostname)` The public DNS name of the calling task runner.
    `PollForTaskRequest` | `withInstanceIdentity(InstanceIdentity instanceIdentity)` Identity information for the Amazon EC2 instance that is hosting the task runner.
    `PollForTaskRequest` | `withWorkerGroup(java.lang.String workerGroup)` Indicates the type of task the task runner is configured to accept and process.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### PollForTaskRequest

          public PollForTaskRequest()

  - ### メソッドの詳細

    - #### getWorkerGroup

          public java.lang.String getWorkerGroup()

      Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for `workerGroup` in the call to PollForTask. There are no wildcard values permitted in `workerGroup`, the string must be an exact, case-sensitive, match.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for `workerGroup` in the call to PollForTask. There are no wildcard values permitted in `workerGroup`, the string must be an exact, case-sensitive, match.

    - #### setWorkerGroup

          public void setWorkerGroup(java.lang.String workerGroup)

      Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for `workerGroup` in the call to PollForTask. There are no wildcard values permitted in `workerGroup`, the string must be an exact, case-sensitive, match.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `workerGroup` - Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for `workerGroup` in the call to PollForTask. There are no wildcard values permitted in `workerGroup`, the string must be an exact, case-sensitive, match.

    - #### withWorkerGroup

          public PollForTaskRequest withWorkerGroup(java.lang.String workerGroup)

      Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for `workerGroup` in the call to PollForTask. There are no wildcard values permitted in `workerGroup`, the string must be an exact, case-sensitive, match.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `workerGroup` - Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for `workerGroup` in the call to PollForTask. There are no wildcard values permitted in `workerGroup`, the string must be an exact, case-sensitive, match.

    - #### getHostname

          public java.lang.String getHostname()

      The public DNS name of the calling task runner.

      Constraints:
      Length: 1 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        The public DNS name of the calling task runner.

    - #### setHostname

          public void setHostname(java.lang.String hostname)

      The public DNS name of the calling task runner.

      Constraints:
      Length: 1 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `hostname` - The public DNS name of the calling task runner.

    - #### withHostname

          public PollForTaskRequest withHostname(java.lang.String hostname)

      The public DNS name of the calling task runner.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 1 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `hostname` - The public DNS name of the calling task runner.

    - #### getInstanceIdentity

          public InstanceIdentity getInstanceIdentity()

      Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, `http://169.254.169.254/latest/meta-data/instance-id`, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.
      戻り値:
        Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, `http://169.254.169.254/latest/meta-data/instance-id`, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

    - #### setInstanceIdentity

          public void setInstanceIdentity(InstanceIdentity instanceIdentity)

      Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, `http://169.254.169.254/latest/meta-data/instance-id`, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.
      パラメータ:
        `instanceIdentity` - Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, `http://169.254.169.254/latest/meta-data/instance-id`, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

    - #### withInstanceIdentity

          public PollForTaskRequest withInstanceIdentity(InstanceIdentity instanceIdentity)

      Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, `http://169.254.169.254/latest/meta-data/instance-id`, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `instanceIdentity` - Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, `http://169.254.169.254/latest/meta-data/instance-id`, from the EC2 instance. For more information, go to Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`