Class DescribeChangeSetResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.marketplacecatalog.model.MarketplaceCatalogResponse
software.amazon.awssdk.services.marketplacecatalog.model.DescribeChangeSetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeChangeSetResponse.Builder,DescribeChangeSetResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeChangeSetResponse extends MarketplaceCatalogResponse implements ToCopyableBuilder<DescribeChangeSetResponse.Builder,DescribeChangeSetResponse>

  • Method Details

    • changeSetId

      public final String changeSetId()

      Required. The unique identifier for the change set referenced in this request.

      Returns:
      Required. The unique identifier for the change set referenced in this request.

    • changeSetArn

      public final String changeSetArn()

      The ARN associated with the unique identifier for the change set referenced in this request.

      Returns:
      The ARN associated with the unique identifier for the change set referenced in this request.

    • changeSetName

      public final String changeSetName()

      The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.

      Returns:
      The optional name provided in the StartChangeSet request. If you do not provide a name, one is set by default.

    • intent

      public final Intent intent()

      The optional intent provided in the StartChangeSet request. If you do not provide an intent, APPLY is set by default.

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

      Returns:
      The optional intent provided in the StartChangeSet request. If you do not provide an intent, APPLY is set by default.
      See Also:

    • intentAsString

      public final String intentAsString()

      The optional intent provided in the StartChangeSet request. If you do not provide an intent, APPLY is set by default.

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

      Returns:
      The optional intent provided in the StartChangeSet request. If you do not provide an intent, APPLY is set by default.
      See Also:

    • startTime

      public final String startTime()

      The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.

      Returns:
      The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.

    • endTime

      public final String endTime()

      The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request is not in a terminal state.

      Returns:
      The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The change cannot transition to a different state. Null if the request is not in a terminal state.

    • status

      public final ChangeStatus status()

      The status of the change request.

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

      Returns:
      The status of the change request.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the change request.

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

      Returns:
      The status of the change request.
      See Also:

    • failureCode

      public final FailureCode failureCode()

      Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.

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

      Returns:
      Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.
      See Also:

    • failureCodeAsString

      public final String failureCodeAsString()

      Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.

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

      Returns:
      Returned if the change set is in FAILED status. Can be either CLIENT_ERROR, which means that there are issues with the request (see the ErrorDetailList), or SERVER_FAULT, which means that there is a problem in the system, and you should retry your request.
      See Also:

    • failureDescription

      public final String failureDescription()

      Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.

      Returns:
      Returned if there is a failure on the change set, but that failure is not related to any of the changes in the request.

    • hasChangeSet

      public final boolean hasChangeSet()
      For responses, this returns true if the service returned a value for the ChangeSet property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • changeSet

      public final List<ChangeSummary> changeSet()

      An array of ChangeSummary objects.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChangeSet() method.

      Returns:
      An array of ChangeSummary objects.

    • toBuilder

      public DescribeChangeSetResponse.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<DescribeChangeSetResponse.Builder,DescribeChangeSetResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeChangeSetResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.