Class RepositorySyncAttempt

java.lang.Object
software.amazon.awssdk.services.codeconnections.model.RepositorySyncAttempt
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RepositorySyncAttempt.Builder,RepositorySyncAttempt>
@Generated("software.amazon.awssdk:codegen") public final class RepositorySyncAttempt extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RepositorySyncAttempt.Builder,RepositorySyncAttempt>

Information about a repository sync attempt for a repository with a sync configuration.

See Also:

  • Method Details

    • startedAt

      public final Instant startedAt()

      The start time of a specific sync attempt.

      Returns:
      The start time of a specific sync attempt.

    • status

      public final RepositorySyncStatus status()

      The status of a specific sync attempt. The following are valid statuses:

      • INITIATED - A repository sync attempt has been created and will begin soon.

      • IN_PROGRESS - A repository sync attempt has started and work is being done to reconcile the branch.

      • SUCCEEDED - The repository sync attempt has completed successfully.

      • FAILED - The repository sync attempt has failed.

      • QUEUED - The repository sync attempt didn't execute and was queued.

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

      Returns:
      The status of a specific sync attempt. The following are valid statuses:

      • INITIATED - A repository sync attempt has been created and will begin soon.

      • IN_PROGRESS - A repository sync attempt has started and work is being done to reconcile the branch.

      • SUCCEEDED - The repository sync attempt has completed successfully.

      • FAILED - The repository sync attempt has failed.

      • QUEUED - The repository sync attempt didn't execute and was queued.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a specific sync attempt. The following are valid statuses:

      • INITIATED - A repository sync attempt has been created and will begin soon.

      • IN_PROGRESS - A repository sync attempt has started and work is being done to reconcile the branch.

      • SUCCEEDED - The repository sync attempt has completed successfully.

      • FAILED - The repository sync attempt has failed.

      • QUEUED - The repository sync attempt didn't execute and was queued.

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

      Returns:
      The status of a specific sync attempt. The following are valid statuses:

      • INITIATED - A repository sync attempt has been created and will begin soon.

      • IN_PROGRESS - A repository sync attempt has started and work is being done to reconcile the branch.

      • SUCCEEDED - The repository sync attempt has completed successfully.

      • FAILED - The repository sync attempt has failed.

      • QUEUED - The repository sync attempt didn't execute and was queued.

      See Also:

    • hasEvents

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

    • events

      public final List<RepositorySyncEvent> events()

      The events associated with a specific sync attempt.

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

      Returns:
      The events associated with a specific sync attempt.

    • toBuilder

      public RepositorySyncAttempt.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<RepositorySyncAttempt.Builder,RepositorySyncAttempt>
      Returns:
      a builder for type T

    • builder

      public static RepositorySyncAttempt.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

    • 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.