Package com.atlassian.bitbucket.scm.mirror

Class MirrorSyncCommandParameters

java.lang.Object
com.atlassian.bitbucket.util.BuilderSupport
com.atlassian.bitbucket.scm.AbstractCommandParameters
com.atlassian.bitbucket.scm.mirror.MirrorSyncCommandParameters
public class MirrorSyncCommandParameters extends AbstractCommandParameters
Since:
4.1

  • Method Details

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • getEnvironment

      public Map<String,String> getEnvironment()
      Returns:
      a map of environment variables that will be applied to the synchronize command
      Since:
      6.7

    • getPassword

      @Nonnull public Optional<String> getPassword()
      Returns:
      the password to provide for authentication
      Since:
      4.6

    • getPrivateKey

      @Nonnull public Optional<File> getPrivateKey()
      Returns:
      the SSH private key to use for authentication

    • getRefspecs

      @Nonnull public Set<String> getRefspecs()
      Returns:
      a set of refspecs to be passed to the fetch command, returns an empty set if not set
      Since:
      6.7

    • getRemoteUrl

      @Nonnull public String getRemoteUrl()
      Returns:
      the URL to fetch from

    • getUsername

      @Nonnull public Optional<String> getUsername()
      Returns:
      the username to provide for authentication
      Since:
      4.6

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isAnonymous

      public boolean isAnonymous()
      Returns:
      whether the sync command can be done in an anonymous context or not; defaults to false if not provided
      Since:
      6.10

    • isAtomic

      public boolean isAtomic()
      Returns:
      whether the sync command should update the refs atomically; defaults to false if not provided
      Since:
      8.0

    • isIncludePrivateRefs

      public boolean isIncludePrivateRefs()
      If an explicit refspec is set then this setting is ignored.
      Returns:
      true if private refs (outside refs/heads and refs/tags) should be included in the fetch
      Since:
      5.1

    • isPrune

      public boolean isPrune()
      Returns:
      true when local branches and tags should be deleted where the upstream branch or tag has been deleted.
      Since:
      6.7

    • isWithTags

      public boolean isWithTags()
      If using a refspec that includes tags this must be set to false or the fetch command will fail.
      Returns:
      true if tags should be included from fetch unless explicitly included in the refspec
      Since:
      6.7

    • toString

      public String toString()
      Overrides:
      toString in class Object