Package software.amazon.awssdk.services.cloudformation.model

Interface ListHookResultsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudFormationRequest.Builder, CopyableBuilder<ListHookResultsRequest.Builder,ListHookResultsRequest>, SdkBuilder<ListHookResultsRequest.Builder,ListHookResultsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListHookResultsRequest

@Mutable
@NotThreadSafe
public static interface ListHookResultsRequest.Builder
extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder<ListHookResultsRequest.Builder,ListHookResultsRequest>

Method Summary

Modifier and Type	Method	Description
ListHookResultsRequest.Builder	nextToken(String nextToken)	The token for the next set of items to return.
ListHookResultsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListHookResultsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListHookResultsRequest.Builder	status(String status)	Filters results by the status of Hook invocations.
ListHookResultsRequest.Builder	status(HookStatus status)	Filters results by the status of Hook invocations.
ListHookResultsRequest.Builder	targetId(String targetId)	Filters results by the unique identifier of the target the Hook was invoked against.
ListHookResultsRequest.Builder	targetType(String targetType)	Filters results by target type.
ListHookResultsRequest.Builder	targetType(ListHookResultsTargetType targetType)	Filters results by target type.
ListHookResultsRequest.Builder	typeArn(String typeArn)	Filters results by the ARN of the Hook.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

targetType

ListHookResultsRequest.Builder targetType(String targetType)

Filters results by target type. Currently, only CHANGE_SET and CLOUD_CONTROL are supported filter options.

Required when TargetId is specified and cannot be used otherwise.

Parameters:

targetType - Filters results by target type. Currently, only CHANGE_SET and CLOUD_CONTROL are supported filter options.

Required when TargetId is specified and cannot be used otherwise.

Returns:

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

See Also:

ListHookResultsTargetType, ListHookResultsTargetType

targetType

ListHookResultsRequest.Builder targetType(ListHookResultsTargetType targetType)

Filters results by target type. Currently, only CHANGE_SET and CLOUD_CONTROL are supported filter options.

Required when TargetId is specified and cannot be used otherwise.

Parameters:

targetType - Filters results by target type. Currently, only CHANGE_SET and CLOUD_CONTROL are supported filter options.

Required when TargetId is specified and cannot be used otherwise.

Returns:

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

See Also:

ListHookResultsTargetType, ListHookResultsTargetType

targetId

ListHookResultsRequest.Builder targetId(String targetId)

Filters results by the unique identifier of the target the Hook was invoked against.

For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this value must be the HookRequestToken returned by the Cloud Control API request. For more information on the HookRequestToken, see ProgressEvent.

Required when TargetType is specified and cannot be used otherwise.

Parameters:

targetId - Filters results by the unique identifier of the target the Hook was invoked against.

For change sets, this is the change set ARN. When the target is a Cloud Control API operation, this value must be the HookRequestToken returned by the Cloud Control API request. For more information on the HookRequestToken, see ProgressEvent.

Required when TargetType is specified and cannot be used otherwise.

Returns:

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

typeArn

ListHookResultsRequest.Builder typeArn(String typeArn)

Filters results by the ARN of the Hook. Can be used alone or in combination with Status.

Parameters:

typeArn - Filters results by the ARN of the Hook. Can be used alone or in combination with Status.

Returns:

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

status

ListHookResultsRequest.Builder status(String status)

Filters results by the status of Hook invocations. Can only be used in combination with TypeArn. Valid values are:

• HOOK_IN_PROGRESS: The Hook is currently running.

• HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

• HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

• HOOK_FAILED: The Hook encountered an error during execution.

Parameters:

status - Filters results by the status of Hook invocations. Can only be used in combination with TypeArn. Valid values are:

• HOOK_IN_PROGRESS: The Hook is currently running.

• HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

• HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

• HOOK_FAILED: The Hook encountered an error during execution.

Returns:

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

See Also:

HookStatus, HookStatus

status

ListHookResultsRequest.Builder status(HookStatus status)

Filters results by the status of Hook invocations. Can only be used in combination with TypeArn. Valid values are:

• HOOK_IN_PROGRESS: The Hook is currently running.

• HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

• HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

• HOOK_FAILED: The Hook encountered an error during execution.

Parameters:

status - Filters results by the status of Hook invocations. Can only be used in combination with TypeArn. Valid values are:

• HOOK_IN_PROGRESS: The Hook is currently running.

• HOOK_COMPLETE_SUCCEEDED: The Hook completed successfully.

• HOOK_COMPLETE_FAILED: The Hook completed but failed validation.

• HOOK_FAILED: The Hook encountered an error during execution.

Returns:

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

See Also:

HookStatus, HookStatus

nextToken

ListHookResultsRequest.Builder nextToken(String nextToken)

The token for the next set of items to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a previous call.)

Returns:

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

overrideConfiguration

ListHookResultsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListHookResultsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder