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

Class ListHookResultsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
software.amazon.awssdk.services.cloudformation.model.ListHookResultsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListHookResultsRequest.Builder,ListHookResultsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListHookResultsRequest extends CloudFormationRequest implements ToCopyableBuilder<ListHookResultsRequest.Builder,ListHookResultsRequest>

  • Method Details

    • targetType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, targetType will return ListHookResultsTargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

      Returns:
      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.

      See Also:

    • targetTypeAsString

      public final String targetTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, targetType will return ListHookResultsTargetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetTypeAsString().

      Returns:
      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.

      See Also:

    • targetId

      public final 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.

      Returns:
      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.

    • typeArn

      public final String typeArn()

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

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

    • status

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, status will return HookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.

      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, status will return HookStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      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.

      See Also:

    • nextToken

      public final String nextToken()

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

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

    • toBuilder

      public ListHookResultsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListHookResultsRequest.Builder,ListHookResultsRequest>
      Specified by:
      toBuilder in class CloudFormationRequest

    • builder

      public static ListHookResultsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListHookResultsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo