software.amazon.awssdk.services.codecommit.model

Class CreateCommitRequest

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.CreateCommitRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCommitRequest.Builder,CreateCommitRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateCommitRequest
extends CodeCommitRequest
implements ToCopyableBuilder<CreateCommitRequest.Builder,CreateCommitRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCommitRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	authorName() The name of the author who created the commit.
String	branchName() The name of the branch where you create the commit.
static CreateCommitRequest.Builder	builder()
String	commitMessage() The commit message you want to include in the commit.
List<DeleteFileEntry>	deleteFiles() The files to delete in this commit.
String	email() The email address of the person who created the commit.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeleteFiles() Returns true if the DeleteFiles property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasPutFiles() Returns true if the PutFiles property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSetFileModes() Returns true if the SetFileModes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Boolean	keepEmptyFolders() If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty.
String	parentCommitId() The ID of the commit that is the parent of the commit you create.
List<PutFileEntry>	putFiles() The files to add or update in this commit.
String	repositoryName() The name of the repository where you create the commit.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCommitRequest.Builder>	serializableBuilderClass()
List<SetFileModeEntry>	setFileModes() The file modes to update for files in this commit.
CreateCommitRequest.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 create the commit.

Returns:

The name of the repository where you create the commit.

branchName

public final String branchName()

The name of the branch where you create the commit.

Returns:

The name of the branch where you create the commit.

parentCommitId

public final String parentCommitId()

The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.

Returns:

The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.

authorName

public final String authorName()

The name of the author who created the commit. This information is used as both the author and committer for the commit.

Returns:

The name of the author who created the commit. This information is used as both the author and committer for the commit.

email

public final String email()

The email address of the person who created the commit.

Returns:

The email address of the person who created the commit.

commitMessage

public final String commitMessage()

The commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.

Returns:

The commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is specified, a default message is used.

keepEmptyFolders

public final Boolean keepEmptyFolders()

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.

Returns:

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If true, a ..gitkeep file is created for empty folders. The default is false.

hasPutFiles

public final boolean hasPutFiles()

Returns true if the PutFiles property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

putFiles

public final List<PutFileEntry> putFiles()

The files to add or update in this commit.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasPutFiles() to see if a value was sent in this field.

Returns:

The files to add or update in this commit.

hasDeleteFiles

public final boolean hasDeleteFiles()

Returns true if the DeleteFiles property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

deleteFiles

public final List<DeleteFileEntry> deleteFiles()

The files to delete in this commit. These files still exist in earlier commits.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasDeleteFiles() to see if a value was sent in this field.

Returns:

The files to delete in this commit. These files still exist in earlier commits.

hasSetFileModes

public final boolean hasSetFileModes()

Returns true if the SetFileModes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

setFileModes

public final List<SetFileModeEntry> setFileModes()

The file modes to update for files in this commit.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSetFileModes() to see if a value was sent in this field.

Returns:

The file modes to update for files in this commit.

toBuilder

public CreateCommitRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCommitRequest.Builder,CreateCommitRequest>

Specified by:

toBuilder in class CodeCommitRequest

builder

public static CreateCommitRequest.Builder builder()

serializableBuilderClass

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