Class ResourceSyncAttempt

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

Information about a resource sync attempt.

See Also:

  • Method Details

    • 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<ResourceSyncEvent> events()

      The events related to a resource 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 related to a resource sync attempt.

    • initialRevision

      public final Revision initialRevision()

      The current state of the resource as defined in the resource's config-file in the linked repository.

      Returns:
      The current state of the resource as defined in the resource's config-file in the linked repository.

    • startedAt

      public final Instant startedAt()

      The start time for a resource sync attempt.

      Returns:
      The start time for a resource sync attempt.

    • status

      public final ResourceSyncStatus status()

      The status for a resource sync attempt. The follow are valid statuses:

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

      • SYNCING - Syncing has started and work is being done to reconcile state.

      • SYNCED - Syncing has completed successfully.

      • SYNC_FAILED - A resource sync attempt has failed.

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

      Returns:
      The status for a resource sync attempt. The follow are valid statuses:

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

      • SYNCING - Syncing has started and work is being done to reconcile state.

      • SYNCED - Syncing has completed successfully.

      • SYNC_FAILED - A resource sync attempt has failed.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status for a resource sync attempt. The follow are valid statuses:

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

      • SYNCING - Syncing has started and work is being done to reconcile state.

      • SYNCED - Syncing has completed successfully.

      • SYNC_FAILED - A resource sync attempt has failed.

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

      Returns:
      The status for a resource sync attempt. The follow are valid statuses:

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

      • SYNCING - Syncing has started and work is being done to reconcile state.

      • SYNCED - Syncing has completed successfully.

      • SYNC_FAILED - A resource sync attempt has failed.

      See Also:

    • targetRevision

      public final Revision targetRevision()

      The desired state of the resource as defined in the resource's config-file in the linked repository. Git sync attempts to update the resource to this state.

      Returns:
      The desired state of the resource as defined in the resource's config-file in the linked repository. Git sync attempts to update the resource to this state.

    • target

      public final String target()

      The name of the Amazon Web Services resource that is attempted to be synchronized.

      Returns:
      The name of the Amazon Web Services resource that is attempted to be synchronized.

    • toBuilder

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

    • builder

      public static ResourceSyncAttempt.Builder builder()

    • serializableBuilderClass

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