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()

      A string that identifies the next page of events that you want to retrieve.

      Returns:
      A string that identifies the next page of events that you want to retrieve.

    • toBuilder

      public ListHookResultsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListHookResultsRequest.Builder,ListHookResultsRequest>
      Specified by:
      toBuilder in class CloudFormationRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.