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("software.amazon.awssdk:codegen") public final class DeleteFileRequest extends CodeCommitRequest implements ToCopyableBuilder<DeleteFileRequest.Builder,DeleteFileRequest>

  • Method Details

    • repositoryName

      public final 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 final String branchName()

      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.

    • filePath

      public final 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.

      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.

    • parentCommitId

      public final 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.

      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.

    • keepEmptyFolders

      public final 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.

      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.

    • commitMessage

      public final 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.

      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.

    • name

      public final 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.

      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.

    • email

      public final String email()

      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.

    • 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 final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <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 final 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.