public class

ResolveRefCommandParameters

extends AbstractCommandParameters
java.lang.Object
   ↳ com.atlassian.bitbucket.util.BuilderSupport
     ↳ com.atlassian.bitbucket.scm.AbstractCommandParameters
       ↳ com.atlassian.bitbucket.scm.ResolveRefCommandParameters

Class Overview

Describes a ref to resolve.

If it is known whether a requested ref is a branch or a tag, the caller is encouraged to specify the type to allow the SCM to optimize resolving the ref. If the ref type is unknown, the type should be left null.

See Also

Summary

Nested Classes
class ResolveRefCommandParameters.Builder  
[Expand]
Inherited Fields
From class com.atlassian.bitbucket.util.BuilderSupport
Public Methods
@Nonnull String getRefId()
@Nonnull Optional<RefType> getType()
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.util.BuilderSupport
From class java.lang.Object

Public Methods

@Nonnull public String getRefId ()

Returns
  • the branch IDs to resolve

@Nonnull public Optional<RefType> getType ()

Returns
  • an optional RefType, used to limit scope for matching the refId, which may empty() but never null