AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb

Overview

Note:

When making an API call, you may pass DeleteFileInput data as a 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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#branch_nameString

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

Returns:

  • (String)


2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2157

class DeleteFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_path,
  :parent_commit_id,
  :keep_empty_folders,
  :commit_message,
  :name,
  :email)
  SENSITIVE = []
  include Aws::Structure
end

#commit_messageString

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)


2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2157

class DeleteFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_path,
  :parent_commit_id,
  :keep_empty_folders,
  :commit_message,
  :name,
  :email)
  SENSITIVE = []
  include Aws::Structure
end

#emailString

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

Returns:

  • (String)


2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2157

class DeleteFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_path,
  :parent_commit_id,
  :keep_empty_folders,
  :commit_message,
  :name,
  :email)
  SENSITIVE = []
  include Aws::Structure
end

#file_pathString

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)


2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2157

class DeleteFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_path,
  :parent_commit_id,
  :keep_empty_folders,
  :commit_message,
  :name,
  :email)
  SENSITIVE = []
  include Aws::Structure
end

#keep_empty_foldersBoolean

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)


2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2157

class DeleteFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_path,
  :parent_commit_id,
  :keep_empty_folders,
  :commit_message,
  :name,
  :email)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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)


2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2157

class DeleteFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_path,
  :parent_commit_id,
  :keep_empty_folders,
  :commit_message,
  :name,
  :email)
  SENSITIVE = []
  include Aws::Structure
end

#parent_commit_idString

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)


2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2157

class DeleteFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_path,
  :parent_commit_id,
  :keep_empty_folders,
  :commit_message,
  :name,
  :email)
  SENSITIVE = []
  include Aws::Structure
end

#repository_nameString

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

Returns:

  • (String)


2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 2157

class DeleteFileInput < Struct.new(
  :repository_name,
  :branch_name,
  :file_path,
  :parent_commit_id,
  :keep_empty_folders,
  :commit_message,
  :name,
  :email)
  SENSITIVE = []
  include Aws::Structure
end