Class PutFileRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutFileRequest.Builder,
PutFileRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the branch where you want to add or update the file.static PutFileRequest.Builder
builder()
final String
A message about why this file was added or updated.final String
email()
An email address for the person adding or updating the file.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final SdkBytes
The content of the file, in binary object format.final FileModeTypeEnum
fileMode()
The file mode permissions of the blob.final String
The file mode permissions of the blob.final String
filePath()
The name of the file you want to add or update, including the relative path to the file in the repository.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
name()
The name of the person adding or updating the file.final String
The full commit ID of the head commit in the branch where you want to add or update the file.final String
The name of the repository where you want to add or update the file.static Class
<? extends PutFileRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The content of the file, in binary object format.
- Returns:
- The content of the file, in binary object format.
-
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
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 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:
-
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 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:
-
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
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
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
An email address for the person adding or updating the file.
- Returns:
- An email address for the person adding or updating the file.
-
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 interfaceToCopyableBuilder<PutFileRequest.Builder,
PutFileRequest> - Specified by:
toBuilder
in classCodeCommitRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-