Class CreateCommitRequest

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.CreateCommitRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateCommitRequest.Builder,CreateCommitRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCommitRequest extends CodeCommitRequest implements ToCopyableBuilder<CreateCommitRequest.Builder,CreateCommitRequest>

  • Method Details

    • repositoryName

      public final String repositoryName()

      The name of the repository where you create the commit.

      Returns:
      The name of the repository where you create the commit.

    • branchName

      public final String branchName()

      The name of the branch where you create the commit.

      Returns:
      The name of the branch where you create the commit.

    • parentCommitId

      public final String parentCommitId()

      The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.

      Returns:
      The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.

    • authorName

      public final String authorName()

      The name of the author who created the commit. This information is used as both the author and committer for the commit.

      Returns:
      The name of the author who created the commit. This information is used as both the author and committer for the commit.

    • email

      public final String email()

      The email address of the person who created the commit.

      Returns:
      The email address of the person who created the commit.

    • commitMessage

      public final String commitMessage()

      The commit message you want to include in the commit. 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 in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.

    • keepEmptyFolders

      public final Boolean keepEmptyFolders()

      If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.

      Returns:
      If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.

    • hasPutFiles

      public final boolean hasPutFiles()
      For responses, this returns true if the service returned a value for the PutFiles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • putFiles

      public final List<PutFileEntry> putFiles()

      The files to add or update in this commit.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPutFiles() method.

      Returns:
      The files to add or update in this commit.

    • hasDeleteFiles

      public final boolean hasDeleteFiles()
      For responses, this returns true if the service returned a value for the DeleteFiles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • deleteFiles

      public final List<DeleteFileEntry> deleteFiles()

      The files to delete in this commit. These files still exist in earlier commits.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDeleteFiles() method.

      Returns:
      The files to delete in this commit. These files still exist in earlier commits.

    • hasSetFileModes

      public final boolean hasSetFileModes()
      For responses, this returns true if the service returned a value for the SetFileModes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • setFileModes

      public final List<SetFileModeEntry> setFileModes()

      The file modes to update for files in this commit.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSetFileModes() method.

      Returns:
      The file modes to update for files in this commit.

    • toBuilder

      public CreateCommitRequest.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<CreateCommitRequest.Builder,CreateCommitRequest>
      Specified by:
      toBuilder in class CodeCommitRequest
      Returns:
      a builder for type T

    • builder

      public static CreateCommitRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateCommitRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.