software.amazon.awssdk.services.codecommit.model

Class DeleteFileRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.codecommit.model.CodeCommitRequest

software.amazon.awssdk.services.codecommit.model.DeleteFileRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteFileRequest.Builder,DeleteFileRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DeleteFileRequest
extends CodeCommitRequest
implements ToCopyableBuilder<DeleteFileRequest.Builder,DeleteFileRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeleteFileRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	branchName() The name of the branch where the commit will be made deleting the file.
static DeleteFileRequest.Builder	builder()
String	commitMessage() The commit message you want to include as part of deleting the file.
String	email() The email address for the commit that deletes the file.
boolean	equals(Object obj)
String	filePath() The fully-qualified path to the file that will be deleted, including the full name and extension of that file.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Boolean	keepEmptyFolders() 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.
String	name() The name of the author of the commit that deletes the file.
String	parentCommitId() The ID of the commit that is the tip of the branch where you want to create the commit that will delete the file.
String	repositoryName() The name of the repository that contains the file to delete.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteFileRequest.Builder>	serializableBuilderClass()
DeleteFileRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

repositoryName

public String repositoryName()

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

Returns:

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

branchName

public String branchName()

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

Returns:

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

filePath

public String filePath()

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.

Returns:

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.

parentCommitId

public String parentCommitId()

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.

Returns:

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.

keepEmptyFolders

public Boolean keepEmptyFolders()

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.

Returns:

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.

commitMessage

public 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 will be 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 will be used.

name

public String name()

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.

Returns:

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.

email

public String email()

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

Returns:

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

toBuilder

public DeleteFileRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteFileRequest.Builder,DeleteFileRequest>

Specified by:

toBuilder in class CodeCommitRequest

Returns:

a builder for type T

builder

public static DeleteFileRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DeleteFileRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.