Interface PollForTaskRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<PollForTaskRequest.Builder,
,PollForTaskRequest> DataPipelineRequest.Builder
,SdkBuilder<PollForTaskRequest.Builder,
,PollForTaskRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PollForTaskRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe public DNS name of the calling task runner.default PollForTaskRequest.Builder
instanceIdentity
(Consumer<InstanceIdentity.Builder> instanceIdentity) Identity information for the EC2 instance that is hosting the task runner.instanceIdentity
(InstanceIdentity instanceIdentity) Identity information for the EC2 instance that is hosting the task runner.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.workerGroup
(String workerGroup) The type of task the task runner is configured to accept and process.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.datapipeline.model.DataPipelineRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
workerGroup
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 toPollForTask
. There are no wildcard values permitted inworkerGroup
; the string must be an exact, case-sensitive, match.- Parameters:
workerGroup
- 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 forworkerGroup
in the call toPollForTask
. There are no wildcard values permitted inworkerGroup
; the string must be an exact, case-sensitive, match.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hostname
The public DNS name of the calling task runner.
- Parameters:
hostname
- The public DNS name of the calling task runner.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceIdentity
Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using
http://169.254.169.254/latest/meta-data/instance-id
. For more information, see 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.- Parameters:
instanceIdentity
- Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance usinghttp://169.254.169.254/latest/meta-data/instance-id
. For more information, see 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:
- Returns a reference to this object so that method calls can be chained together.
-
instanceIdentity
default PollForTaskRequest.Builder instanceIdentity(Consumer<InstanceIdentity.Builder> instanceIdentity) Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using
This is a convenience method that creates an instance of thehttp://169.254.169.254/latest/meta-data/instance-id
. For more information, see 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.Builder
avoiding the need to create one manually viaInstanceIdentity.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceIdentity(InstanceIdentity)
.- Parameters:
instanceIdentity
- a consumer that will call methods onInstanceIdentity.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
PollForTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
PollForTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-