Class PutFileRequest

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

  • Method Details

    • repositoryName

      public final String repositoryName()

      The name of the repository where you want to add or update the file.

      Returns:
      The name of the repository where you want to add or update the file.

    • branchName

      public final String branchName()

      The name of the branch where you want to add or update the file. If this is an empty repository, this branch is created.

      Returns:
      The name of the branch where you want to add or update the file. If this is an empty repository, this branch is created.

    • fileContent

      public final SdkBytes fileContent()

      The content of the file, in binary object format.

      Returns:
      The content of the file, in binary object format.

    • filePath

      public final String filePath()

      The name of the file you want to add or update, including the relative path to the file in the repository.

      If the path does not currently exist in the repository, the path is created as part of adding the file.

      Returns:
      The name of the file you want to add or update, including the relative path to the file in the repository.

      If the path does not currently exist in the repository, the path is created as part of adding the file.

    • fileMode

      public final FileModeTypeEnum fileMode()

      The file mode permissions of the blob. Valid file mode permissions are listed here.

      If the service returns an enum value that is not available in the current SDK version, fileMode will return FileModeTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileModeAsString().

      Returns:
      The file mode permissions of the blob. Valid file mode permissions are listed here.
      See Also:

    • fileModeAsString

      public final String fileModeAsString()

      The file mode permissions of the blob. Valid file mode permissions are listed here.

      If the service returns an enum value that is not available in the current SDK version, fileMode will return FileModeTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fileModeAsString().

      Returns:
      The file mode permissions of the blob. Valid file mode permissions are listed here.
      See Also:

    • parentCommitId

      public final String parentCommitId()

      The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required.

      The commit ID must match the ID of the head commit at the time of the operation. Otherwise, an error occurs, and the file is not added or updated.

      Returns:
      The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required.

      The commit ID must match the ID of the head commit at the time of the operation. Otherwise, an error occurs, and the file is not added or updated.

    • commitMessage

      public final String commitMessage()

      A message about why this file was added or updated. Although it is optional, a message makes the commit history for your repository more useful.

      Returns:
      A message about why this file was added or updated. Although it is optional, a message makes the commit history for your repository more useful.

    • name

      public final String name()

      The name of the person adding or updating the file. Although it is optional, a name makes the commit history for your repository more useful.

      Returns:
      The name of the person adding or updating the file. Although it is optional, a name makes the commit history for your repository more useful.

    • email

      public final String email()

      An email address for the person adding or updating the file.

      Returns:
      An email address for the person adding or updating the file.

    • toBuilder

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

    • builder

      public static PutFileRequest.Builder builder()

    • serializableBuilderClass

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