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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePutFileRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbranchName()The name of the branch where you want to add or update the file.static PutFileRequest.Builderbuilder()StringcommitMessage()A message about why this file was added or updated.Stringemail()An email address for the person adding or updating the file.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)SdkBytesfileContent()The content of the file, in binary object format.FileModeTypeEnumfileMode()The file mode permissions of the blob.StringfileModeAsString()The file mode permissions of the blob.StringfilePath()The name of the file you want to add or update, including the relative path to the file in the repository.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Stringname()The name of the person adding or updating the file.StringparentCommitId()The full commit ID of the head commit in the branch where you want to add or update the file.StringrepositoryName()The name of the repository where you want to add or update the file.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends PutFileRequest.Builder>serializableBuilderClass()PutFileRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
fileModewill returnFileModeTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfileModeAsString().- Returns:
- The file mode permissions of the blob. Valid file mode permissions are listed here.
- See Also:
FileModeTypeEnum
-
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,
fileModewill returnFileModeTypeEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfileModeAsString().- Returns:
- The file mode permissions of the blob. Valid file mode permissions are listed here.
- See Also:
FileModeTypeEnum
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PutFileRequest.Builder,PutFileRequest>- Specified by:
toBuilderin classCodeCommitRequest
-
builder
public static PutFileRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutFileRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-