public class


extends AbstractCommandParameters
   ↳ com.atlassian.bitbucket.util.BuilderSupport
     ↳ com.atlassian.bitbucket.scm.AbstractCommandParameters
       ↳ com.atlassian.bitbucket.scm.ArchiveCommandParameters

Class Overview

Describes a commit to archive.

In addition to specifying the commit to archive, callers can select from a standard set of archive formats. Any SCM which supports archiving repositories is required to support all of the standard formats.

For finer control over the content of the archive, callers can also specify paths to filter by, and a prefix to prepend to the archive's contents. SCMs should support both of those settings if possible, but are not required to do so.


Nested Classes
class ArchiveCommandParameters.Builder  
Inherited Fields
From class com.atlassian.bitbucket.util.BuilderSupport
Public Methods
@Nonnull String getCommitId()
@Nonnull ArchiveFormat getFormat()
@Nonnull Set<String> getPaths()
@Nonnull Optional<String> getPrefix()
Inherited Methods
From class com.atlassian.bitbucket.util.BuilderSupport
From class java.lang.Object

Public Methods

@Nonnull public String getCommitId ()

  • the commit to archive, which may be a ref name or commit hash

@Nonnull public ArchiveFormat getFormat ()

  • the format to stream the archive in

@Nonnull public Set<String> getPaths ()

  • a set of paths to filter the archive by, which may be empty to include all paths

@Nonnull public Optional<String> getPrefix ()

  • a prefix to apply to all entries in the archive, which may be empty() but not null