AWS SDK for .NET Documentation
PollForTaskRequest Class
AmazonAmazon.DataPipeline.ModelPollForTaskRequest Did this page help you?   Yes   No    Tell us about it...
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.

Declaration Syntax
C#
public class PollForTaskRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
PollForTaskRequest()()()()
Initializes a new instance of the PollForTaskRequest class

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Hostname
The public DNS name of the calling task runner.

Constraints:

Length
1 - 1024
Pattern
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*


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()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithHostname(String) Obsolete.
Sets the Hostname property

WithInstanceIdentity(InstanceIdentity) Obsolete.
Sets the InstanceIdentity property

WithWorkerGroup(String) Obsolete.
Sets the WorkerGroup property

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
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*


Inheritance Hierarchy
Object
AmazonWebServiceRequest
 PollForTaskRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)