PutFileRequest (AWS Java SDK :: Services :: AWS CodeCommit 2.17.0 API)

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)`
`boolean`	`equalsBySdkFields(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)`
`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()`
`String`	`toString()` 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, 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:
    
    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, 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:
    
    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:
    
    toBuilder in interface ToCopyableBuilder<PutFileRequest.Builder,PutFileRequest>
    
    Specified by:
    
    toBuilder in class CodeCommitRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

equalsBySdkFields

toString

getValueForField

sdkFields