AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DeleteFileInput

import "github.com/aws/aws-sdk-go/service/codecommit"

type DeleteFileInput struct { BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"` CommitMessage *string `locationName:"commitMessage" type:"string"` Email *string `locationName:"email" type:"string"` FilePath *string `locationName:"filePath" type:"string" required:"true"` KeepEmptyFolders *bool `locationName:"keepEmptyFolders" type:"boolean"` Name *string `locationName:"name" type:"string"` ParentCommitId *string `locationName:"parentCommitId" type:"string" required:"true"` RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"` }

BranchName

Type: *string

The name of the branch where the commit will be made deleting the file.

BranchName is a required field

CommitMessage

Type: *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 will be used.

Email

Type: *string

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

FilePath

Type: *string

The fully-qualified path to the file that will 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.

FilePath is a required field

KeepEmptyFolders

Type: *bool

Specifies whether to delete the folder or directory that contains the file you want to delete if that file is the only object in the folder or directory. By default, empty folders will be 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 will also delete the empty folders dir4, dir3, and dir2.

Name

Type: *string

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

ParentCommitId

Type: *string

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

ParentCommitId is a required field

RepositoryName

Type: *string

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

RepositoryName is a required field

Method

GoString

func (s DeleteFileInput) GoString() string

GoString returns the string representation

SetBranchName

func (s *DeleteFileInput) SetBranchName(v string) *DeleteFileInput

SetBranchName sets the BranchName field's value.

SetCommitMessage

func (s *DeleteFileInput) SetCommitMessage(v string) *DeleteFileInput

SetCommitMessage sets the CommitMessage field's value.

SetEmail

func (s *DeleteFileInput) SetEmail(v string) *DeleteFileInput

SetEmail sets the Email field's value.

SetFilePath

func (s *DeleteFileInput) SetFilePath(v string) *DeleteFileInput

SetFilePath sets the FilePath field's value.

SetKeepEmptyFolders

func (s *DeleteFileInput) SetKeepEmptyFolders(v bool) *DeleteFileInput

SetKeepEmptyFolders sets the KeepEmptyFolders field's value.

SetName

func (s *DeleteFileInput) SetName(v string) *DeleteFileInput

SetName sets the Name field's value.

SetParentCommitId

func (s *DeleteFileInput) SetParentCommitId(v string) *DeleteFileInput

SetParentCommitId sets the ParentCommitId field's value.

SetRepositoryName

func (s *DeleteFileInput) SetRepositoryName(v string) *DeleteFileInput

SetRepositoryName sets the RepositoryName field's value.

String

func (s DeleteFileInput) String() string

String returns the string representation

Validate

func (s *DeleteFileInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: