You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeCommit::Types::DeleteFileInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteFileInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  repository_name: "RepositoryName", # required
  branch_name: "BranchName", # required
  file_path: "Path", # required
  parent_commit_id: "CommitId", # required
  keep_empty_folders: false,
  commit_message: "Message",
  name: "Name",
  email: "Email",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#branch_name ⇒ String

The name of the branch where the commit that deletes the file is made.

Returns:

  • (String) —

    The name of the branch where the commit that deletes the file is made.

#commit_message ⇒ String

The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message is used.

Returns:

  • (String) —

    The commit message you want to include as part of deleting the file.

#email ⇒ String

The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.

Returns:

  • (String) —

    The email address for the commit that deletes the file.

#file_path ⇒ String

The fully qualified path to the file that to be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.

Returns:

  • (String) —

    The fully qualified path to the file that to be deleted, including the full name and extension of that file.

#keep_empty_folders ⇒ Boolean

If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file. By default, empty folders are deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 also deletes the empty folders dir4, dir3, and dir2.

Returns:

  • (Boolean) —

    If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file.

#name ⇒ String

The name of the author of the commit that deletes the file. If no name is specified, the user\'s ARN is used as the author name and committer name.

Returns:

  • (String) —

    The name of the author of the commit that deletes the file.

#parent_commit_id ⇒ String

The ID of the commit that is the tip of the branch where you want to create the commit that deletes the file. This must be the HEAD commit for the branch. The commit that deletes the file is created from this commit ID.

Returns:

  • (String) —

    The ID of the commit that is the tip of the branch where you want to create the commit that deletes the file.

#repository_name ⇒ String

The name of the repository that contains the file to delete.

Returns:

  • (String) —

    The name of the repository that contains the file to delete.