Package org.projectnessie.client.api

Interface GetReferenceBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      default GetReferenceBuilder fetch​(org.projectnessie.api.params.FetchOption fetchOption)
      Deprecated.
      GetReferenceBuilder fetch​(org.projectnessie.model.FetchOption fetchOption)
      Will fetch additional metadata about Branch instances, such as number of commits ahead/behind or the common ancestor in relation to the default branch, and the commit metadata for the HEAD commit.
      org.projectnessie.model.Reference get()  
      GetReferenceBuilder refName​(@NotNull @NotNull @Pattern(regexp="^(?:[A-Za-z](?:(?:(?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?)|-$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") @Pattern(regexp="^(?:[A-Za-z](?:(?:(?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?)|-$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") java.lang.String refName)  

    • Method Detail

      • refName

        GetReferenceBuilder refName​(@NotNull @NotNull @Pattern(regexp="^(?:[A-Za-z](?:(?:(?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?)|-$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") @Pattern(regexp="^(?:[A-Za-z](?:(?:(?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?)|-$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'")
                            @NotNull @NotNull @Pattern(regexp="^(?:[A-Za-z](?:(?:(?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?)|-$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") @Pattern(regexp="^(?:[A-Za-z](?:(?:(?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9_-])?)|-$",message="Reference name must start with a letter, followed by letters, digits, one of the ./_- characters, not end with a slash or dot, not contain \'..\'") java.lang.String refName)

      • fetch

        GetReferenceBuilder fetch​(org.projectnessie.model.FetchOption fetchOption)
        Will fetch additional metadata about Branch instances, such as number of commits ahead/behind or the common ancestor in relation to the default branch, and the commit metadata for the HEAD commit.
        Parameters:
        fetchOption - The option indicating how much info to fetch
        Returns:
        GetReferenceBuilder

      • fetch

        @Deprecated
default GetReferenceBuilder fetch​(org.projectnessie.api.params.FetchOption fetchOption)
        Deprecated.
        Legacy API method for backward compatibility. Use fetch(FetchOption) instead.

      • get

        org.projectnessie.model.Reference get()
                               throws org.projectnessie.error.NessieNotFoundException
        Throws:
        org.projectnessie.error.NessieNotFoundException