Class RepositorySyncAttempt

    • Method Detail

      • 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:
        RepositorySyncStatus
      • 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:
        RepositorySyncStatus
      • 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.
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)