Class CreateCommitRequest

    • Method Detail

      • repositoryName

        public final String repositoryName()

        The name of the repository where you create the commit.

        Returns:
        The name of the repository where you create the commit.
      • branchName

        public final String branchName()

        The name of the branch where you create the commit.

        Returns:
        The name of the branch where you create the commit.
      • parentCommitId

        public final String parentCommitId()

        The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.

        Returns:
        The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.
      • authorName

        public final String authorName()

        The name of the author who created the commit. This information is used as both the author and committer for the commit.

        Returns:
        The name of the author who created the commit. This information is used as both the author and committer for the commit.
      • email

        public final String email()

        The email address of the person who created the commit.

        Returns:
        The email address of the person who created the commit.
      • commitMessage

        public final String commitMessage()

        The commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.

        Returns:
        The commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.
      • keepEmptyFolders

        public final Boolean keepEmptyFolders()

        If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.

        Returns:
        If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.
      • hasPutFiles

        public final boolean hasPutFiles()
        For responses, this returns true if the service returned a value for the PutFiles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • putFiles

        public final List<PutFileEntry> putFiles()

        The files to add or update in this commit.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPutFiles() method.

        Returns:
        The files to add or update in this commit.
      • hasDeleteFiles

        public final boolean hasDeleteFiles()
        For responses, this returns true if the service returned a value for the DeleteFiles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • deleteFiles

        public final List<DeleteFileEntry> deleteFiles()

        The files to delete in this commit. These files still exist in earlier commits.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDeleteFiles() method.

        Returns:
        The files to delete in this commit. These files still exist in earlier commits.
      • hasSetFileModes

        public final boolean hasSetFileModes()
        For responses, this returns true if the service returned a value for the SetFileModes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • setFileModes

        public final List<SetFileModeEntry> setFileModes()

        The file modes to update for files in this commit.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSetFileModes() method.

        Returns:
        The file modes to update for files in this commit.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object