Class PutFileRequest

    • Method Detail

      • repositoryName

        public final String repositoryName()

        The name of the repository where you want to add or update the file.

        Returns:
        The name of the repository where you want to add or update the file.
      • branchName

        public final String branchName()

        The name of the branch where you want to add or update the file. If this is an empty repository, this branch is created.

        Returns:
        The name of the branch where you want to add or update the file. If this is an empty repository, this branch is created.
      • fileContent

        public final SdkBytes fileContent()

        The content of the file, in binary object format.

        Returns:
        The content of the file, in binary object format.
      • filePath

        public final String filePath()

        The name of the file you want to add or update, including the relative path to the file in the repository.

        If the path does not currently exist in the repository, the path is created as part of adding the file.

        Returns:
        The name of the file you want to add or update, including the relative path to the file in the repository.

        If the path does not currently exist in the repository, the path is created as part of adding the file.

      • fileModeAsString

        public final String fileModeAsString()

        The file mode permissions of the blob. Valid file mode permissions are listed here.

        If the service returns an enum value that is not available in the current SDK version, fileMode will return FileModeTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileModeAsString().

        Returns:
        The file mode permissions of the blob. Valid file mode permissions are listed here.
        See Also:
        FileModeTypeEnum
      • parentCommitId

        public final String parentCommitId()

        The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required.

        The commit ID must match the ID of the head commit at the time of the operation. Otherwise, an error occurs, and the file is not added or updated.

        Returns:
        The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required.

        The commit ID must match the ID of the head commit at the time of the operation. Otherwise, an error occurs, and the file is not added or updated.

      • commitMessage

        public final String commitMessage()

        A message about why this file was added or updated. Although it is optional, a message makes the commit history for your repository more useful.

        Returns:
        A message about why this file was added or updated. Although it is optional, a message makes the commit history for your repository more useful.
      • name

        public final String name()

        The name of the person adding or updating the file. Although it is optional, a name makes the commit history for your repository more useful.

        Returns:
        The name of the person adding or updating the file. Although it is optional, a name makes the commit history for your repository more useful.
      • email

        public final String email()

        An email address for the person adding or updating the file.

        Returns:
        An email address for the person adding or updating the file.
      • 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