PutFileRequest (AWS SDK for Java

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutFileRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutFileRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`branchName()` The name of the branch where you want to add or update the file.
`static PutFileRequest.Builder`	`builder()`
`String`	`commitMessage()` A message about why this file was added or updated.
`String`	`email()` An email address for the person adding or updating the file.
`boolean`	`equals(Object obj)`
`SdkBytes`	`fileContent()` The content of the file, in binary object format.
`FileModeTypeEnum`	`fileMode()` The file mode permissions of the blob.
`String`	`fileModeAsString()` The file mode permissions of the blob.
`String`	`filePath()` 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)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`name()` The name of the person adding or updating the file.
`String`	`parentCommitId()` The full commit ID of the head commit in the branch where you want to add or update the file.
`String`	`repositoryName()` The name of the repository where you want to add or update the file.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutFileRequest.Builder>`	`serializableBuilderClass()`
`PutFileRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - repositoryName
```
public 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 String branchName()
```
    The name of the branch where you want to add or update the file. If this is an empty repository, this branch will be created.
    
    Returns:
    
    The name of the branch where you want to add or update the file. If this is an empty repository, this branch will be created.
  - fileContent
```
public SdkBytes fileContent()
```
    The content of the file, in binary object format.
    
    Returns:
    
    The content of the file, in binary object format.
  - filePath
```
public 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 will be 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 will be created as part of adding the file.
  - fileMode
```
public FileModeTypeEnum fileMode()
```
    The file mode permissions of the blob. Valid file mode permissions are listed below.
    
    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 below.
    
    See Also:
    
    FileModeTypeEnum
  - fileModeAsString
```
public String fileModeAsString()
```
    The file mode permissions of the blob. Valid file mode permissions are listed below.
    
    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 below.
    
    See Also:
    
    FileModeTypeEnum
  - parentCommitId
```
public 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, or an error will occur, and the file will not be 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, or an error will occur, and the file will not be added or updated.
  - commitMessage
```
public String commitMessage()
```
    A message about why this file was added or updated. While optional, adding a message is strongly encouraged in order to provide a more useful commit history for your repository.
    
    Returns:
    
    A message about why this file was added or updated. While optional, adding a message is strongly encouraged in order to provide a more useful commit history for your repository.
  - name
```
public String name()
```
    The name of the person adding or updating the file. While optional, adding a name is strongly encouraged in order to provide a more useful commit history for your repository.
    
    Returns:
    
    The name of the person adding or updating the file. While optional, adding a name is strongly encouraged in order to provide a more useful commit history for your repository.
  - email
```
public 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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <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 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.

Class PutFileRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

repositoryName

branchName

fileContent

filePath

fileMode

fileModeAsString

parentCommitId

commitMessage

name

email

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields