com.amazonaws.services.codecommit.model

Class DeleteFileRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codecommit.model.DeleteFileRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeleteFileRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DeleteFileRequest()

Method Summary

Modifier and Type	Method and Description
DeleteFileRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getBranchName() The name of the branch where the commit that deletes the file is made.
String	getCommitMessage() The commit message you want to include as part of deleting the file.
String	getEmail() The email address for the commit that deletes the file.
String	getFilePath() The fully qualified path to the file that to be deleted, including the full name and extension of that file.
Boolean	getKeepEmptyFolders() If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file.
String	getName() The name of the author of the commit that deletes the file.
String	getParentCommitId() The ID of the commit that is the tip of the branch where you want to create the commit that deletes the file.
String	getRepositoryName() The name of the repository that contains the file to delete.
int	hashCode()
Boolean	isKeepEmptyFolders() If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file.
void	setBranchName(String branchName) The name of the branch where the commit that deletes the file is made.
void	setCommitMessage(String commitMessage) The commit message you want to include as part of deleting the file.
void	setEmail(String email) The email address for the commit that deletes the file.
void	setFilePath(String filePath) The fully qualified path to the file that to be deleted, including the full name and extension of that file.
void	setKeepEmptyFolders(Boolean keepEmptyFolders) If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file.
void	setName(String name) The name of the author of the commit that deletes the file.
void	setParentCommitId(String parentCommitId) The ID of the commit that is the tip of the branch where you want to create the commit that deletes the file.
void	setRepositoryName(String repositoryName) The name of the repository that contains the file to delete.
String	toString() Returns a string representation of this object.
DeleteFileRequest	withBranchName(String branchName) The name of the branch where the commit that deletes the file is made.
DeleteFileRequest	withCommitMessage(String commitMessage) The commit message you want to include as part of deleting the file.
DeleteFileRequest	withEmail(String email) The email address for the commit that deletes the file.
DeleteFileRequest	withFilePath(String filePath) The fully qualified path to the file that to be deleted, including the full name and extension of that file.
DeleteFileRequest	withKeepEmptyFolders(Boolean keepEmptyFolders) If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file.
DeleteFileRequest	withName(String name) The name of the author of the commit that deletes the file.
DeleteFileRequest	withParentCommitId(String parentCommitId) The ID of the commit that is the tip of the branch where you want to create the commit that deletes the file.
DeleteFileRequest	withRepositoryName(String repositoryName) The name of the repository that contains the file to delete.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteFileRequest

public DeleteFileRequest()

Method Detail

setRepositoryName

public void setRepositoryName(String repositoryName)

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

Parameters:

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

getRepositoryName

public String getRepositoryName()

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

Returns:

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

withRepositoryName

public DeleteFileRequest withRepositoryName(String repositoryName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setBranchName

public void setBranchName(String branchName)

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

Parameters:

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

getBranchName

public String getBranchName()

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

Returns:

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

withBranchName

public DeleteFileRequest withBranchName(String branchName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setFilePath

public void setFilePath(String filePath)

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.

Parameters:

filePath - 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.

getFilePath

public String getFilePath()

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:

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.

withFilePath

public DeleteFileRequest withFilePath(String filePath)

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.

Parameters:

filePath - 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:

Returns a reference to this object so that method calls can be chained together.

setParentCommitId

public void setParentCommitId(String parentCommitId)

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.

Parameters:

parentCommitId - 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.

getParentCommitId

public String getParentCommitId()

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:

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.

withParentCommitId

public DeleteFileRequest withParentCommitId(String parentCommitId)

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.

Parameters:

parentCommitId - 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:

Returns a reference to this object so that method calls can be chained together.

setKeepEmptyFolders

public void setKeepEmptyFolders(Boolean keepEmptyFolders)

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.

Parameters:

keepEmptyFolders - 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.

getKeepEmptyFolders

public Boolean getKeepEmptyFolders()

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:

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.

withKeepEmptyFolders

public DeleteFileRequest withKeepEmptyFolders(Boolean keepEmptyFolders)

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.

Parameters:

keepEmptyFolders - 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:

Returns a reference to this object so that method calls can be chained together.

isKeepEmptyFolders

public Boolean isKeepEmptyFolders()

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:

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.

setCommitMessage

public void setCommitMessage(String commitMessage)

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.

Parameters:

commitMessage - 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.

getCommitMessage

public String getCommitMessage()

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:

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.

withCommitMessage

public DeleteFileRequest withCommitMessage(String commitMessage)

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.

Parameters:

commitMessage - 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:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

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.

Parameters:

name - 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.

getName

public String getName()

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:

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.

withName

public DeleteFileRequest withName(String name)

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.

Parameters:

name - 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:

Returns a reference to this object so that method calls can be chained together.

setEmail

public void setEmail(String email)

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

Parameters:

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

getEmail

public String getEmail()

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

Returns:

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

withEmail

public DeleteFileRequest withEmail(String email)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeleteFileRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()