Class DescribeReplicationBackfillResultsResponse

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

  • Method Details

    • registryId

      public final String registryId()

      The registry ID associated with the request.

      Returns:
      The registry ID associated with the request.

    • replicationBackfillId

      public final String replicationBackfillId()

      The ID of the replication backfill.

      Returns:
      The ID of the replication backfill.

    • destination

      public final ReplicationDestination destination()

      The destination Region and registry to which the images are replicated.

      Returns:
      The destination Region and registry to which the images are replicated.

    • status

      public final ReplicationBackfillStatus status()

      The current status of the replication backfill.

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

      Returns:
      The current status of the replication backfill.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the replication backfill.

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

      Returns:
      The current status of the replication backfill.
      See Also:

    • failureCode

      public final String failureCode()

      The failure code for a replication backfill that has failed.

      Returns:
      The failure code for a replication backfill that has failed.

    • progress

      public final ReplicationBackfillProgress progress()

      The progress of the replication backfill, including the total, completed, and failed replication counts. This value is null until the replication backfill finishes preparing the set of images to replicate. It is therefore null while the replication backfill is PREPARING, and remains null if the replication backfill is stopped before preparation completes.

      Returns:
      The progress of the replication backfill, including the total, completed, and failed replication counts. This value is null until the replication backfill finishes preparing the set of images to replicate. It is therefore null while the replication backfill is PREPARING, and remains null if the replication backfill is stopped before preparation completes.

    • hasResults

      public final boolean hasResults()
      For responses, this returns true if the service returned a value for the Results 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.

    • results

      public final List<ReplicationBackfillResult> results()

      The per-image results for the replication backfill. Results are available only after the replication backfill reaches a terminal status.

      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 hasResults() method.

      Returns:
      The per-image results for the replication backfill. Results are available only after the replication backfill reaches a terminal status.

    • startedAt

      public final Instant startedAt()

      The date and time, in JavaScript date format, when the replication backfill was started.

      Returns:
      The date and time, in JavaScript date format, when the replication backfill was started.

    • endedAt

      public final Instant endedAt()

      The date and time, in JavaScript date format, when the replication backfill ended. This value is null while the replication backfill is still in progress.

      Returns:
      The date and time, in JavaScript date format, when the replication backfill ended. This value is null while the replication backfill is still in progress.

    • nextToken

      public final String nextToken()

      The nextToken value to include in a future DescribeReplicationBackfillResults request. When the results of a DescribeReplicationBackfillResults request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

      Returns:
      The nextToken value to include in a future DescribeReplicationBackfillResults request. When the results of a DescribeReplicationBackfillResults request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

    • toBuilder

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

    • builder

      public static DescribeReplicationBackfillResultsResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeReplicationBackfillResultsResponse.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.

    • sdkFieldNameToField

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