Interface Commit.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Commit.Builder,Commit>, SdkBuilder<Commit.Builder,Commit>, SdkPojo
Enclosing class:
Commit

public static interface Commit.Builder extends SdkPojo, CopyableBuilder<Commit.Builder,Commit>
  • Method Details

    • commitId

      Commit.Builder commitId(String commitId)

      The full SHA ID of the specified commit.

      Parameters:
      commitId - The full SHA ID of the specified commit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • treeId

      Commit.Builder treeId(String treeId)

      Tree information for the specified commit.

      Parameters:
      treeId - Tree information for the specified commit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • parents

      Commit.Builder parents(Collection<String> parents)

      A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.

      Parameters:
      parents - A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • parents

      Commit.Builder parents(String... parents)

      A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.

      Parameters:
      parents - A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • message

      Commit.Builder message(String message)

      The commit message associated with the specified commit.

      Parameters:
      message - The commit message associated with the specified commit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • author

      Commit.Builder author(UserInfo author)

      Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.

      Parameters:
      author - Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • author

      default Commit.Builder author(Consumer<UserInfo.Builder> author)

      Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.

      This is a convenience method that creates an instance of the UserInfo.Builder avoiding the need to create one manually via UserInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to author(UserInfo).

      Parameters:
      author - a consumer that will call methods on UserInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • committer

      Commit.Builder committer(UserInfo committer)

      Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.

      For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

      Parameters:
      committer - Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.

      For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • committer

      default Commit.Builder committer(Consumer<UserInfo.Builder> committer)

      Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.

      For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

      This is a convenience method that creates an instance of the UserInfo.Builder avoiding the need to create one manually via UserInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to committer(UserInfo).

      Parameters:
      committer - a consumer that will call methods on UserInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • additionalData

      Commit.Builder additionalData(String additionalData)

      Any other data associated with the specified commit.

      Parameters:
      additionalData - Any other data associated with the specified commit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.