com.amazonaws.services.codecommit.model

Class PutFileRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codecommit.model.PutFileRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutFileRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutFileRequest()

Method Summary

Modifier and Type	Method and Description
PutFileRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getBranchName() The name of the branch where you want to add or update the file.
String	getCommitMessage() A message about why this file was added or updated.
String	getEmail() An email address for the person adding or updating the file.
ByteBuffer	getFileContent() The content of the file, in binary object format.
String	getFileMode() The file mode permissions of the blob.
String	getFilePath() The name of the file you want to add or update, including the relative path to the file in the repository.
String	getName() The name of the person adding or updating the file.
String	getParentCommitId() The full commit ID of the head commit in the branch where you want to add or update the file.
String	getRepositoryName() The name of the repository where you want to add or update the file.
int	hashCode()
void	setBranchName(String branchName) The name of the branch where you want to add or update the file.
void	setCommitMessage(String commitMessage) A message about why this file was added or updated.
void	setEmail(String email) An email address for the person adding or updating the file.
void	setFileContent(ByteBuffer fileContent) The content of the file, in binary object format.
void	setFileMode(String fileMode) The file mode permissions of the blob.
void	setFilePath(String filePath) The name of the file you want to add or update, including the relative path to the file in the repository.
void	setName(String name) The name of the person adding or updating the file.
void	setParentCommitId(String parentCommitId) The full commit ID of the head commit in the branch where you want to add or update the file.
void	setRepositoryName(String repositoryName) The name of the repository where you want to add or update the file.
String	toString() Returns a string representation of this object.
PutFileRequest	withBranchName(String branchName) The name of the branch where you want to add or update the file.
PutFileRequest	withCommitMessage(String commitMessage) A message about why this file was added or updated.
PutFileRequest	withEmail(String email) An email address for the person adding or updating the file.
PutFileRequest	withFileContent(ByteBuffer fileContent) The content of the file, in binary object format.
PutFileRequest	withFileMode(FileModeTypeEnum fileMode) The file mode permissions of the blob.
PutFileRequest	withFileMode(String fileMode) The file mode permissions of the blob.
PutFileRequest	withFilePath(String filePath) The name of the file you want to add or update, including the relative path to the file in the repository.
PutFileRequest	withName(String name) The name of the person adding or updating the file.
PutFileRequest	withParentCommitId(String parentCommitId) The full commit ID of the head commit in the branch where you want to add or update the file.
PutFileRequest	withRepositoryName(String repositoryName) The name of the repository where you want to add or update the file.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutFileRequest

public PutFileRequest()

Method Detail

setRepositoryName

public void setRepositoryName(String repositoryName)

The name of the repository where you want to add or update the file.

Parameters:

repositoryName - The name of the repository where you want to add or update the file.

getRepositoryName

public String getRepositoryName()

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.

withRepositoryName

public PutFileRequest withRepositoryName(String repositoryName)

The name of the repository where you want to add or update the file.

Parameters:

repositoryName - The name of the repository where you want to add or update the file.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBranchName

public void setBranchName(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.

Parameters:

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.

getBranchName

public String getBranchName()

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.

withBranchName

public PutFileRequest withBranchName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setFileContent

public void setFileContent(ByteBuffer fileContent)

The content of the file, in binary object format.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

fileContent - The content of the file, in binary object format.

getFileContent

public ByteBuffer getFileContent()

The content of the file, in binary object format.

ByteBuffers are stateful. Calling their get methods changes their position. We recommend using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent position, and calling get methods on this rather than directly on the returned ByteBuffer. Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the position.

Returns:

The content of the file, in binary object format.

withFileContent

public PutFileRequest withFileContent(ByteBuffer fileContent)

The content of the file, in binary object format.

The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.

Warning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.

Parameters:

fileContent - The content of the file, in binary object format.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFilePath

public void setFilePath(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.

Parameters:

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.

getFilePath

public String getFilePath()

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.

withFilePath

public PutFileRequest withFilePath(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setFileMode

public void setFileMode(String fileMode)

The file mode permissions of the blob. Valid file mode permissions are listed here.

Parameters:

fileMode - The file mode permissions of the blob. Valid file mode permissions are listed here.

See Also:

FileModeTypeEnum

getFileMode

public String getFileMode()

The file mode permissions of the blob. Valid file mode permissions are listed here.

Returns:

The file mode permissions of the blob. Valid file mode permissions are listed here.

See Also:

FileModeTypeEnum

withFileMode

public PutFileRequest withFileMode(String fileMode)

The file mode permissions of the blob. Valid file mode permissions are listed here.

Parameters:

fileMode - The file mode permissions of the blob. Valid file mode permissions are listed here.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileModeTypeEnum

withFileMode

public PutFileRequest withFileMode(FileModeTypeEnum fileMode)

The file mode permissions of the blob. Valid file mode permissions are listed here.

Parameters:

fileMode - The file mode permissions of the blob. Valid file mode permissions are listed here.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FileModeTypeEnum

setParentCommitId

public void setParentCommitId(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.

Parameters:

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.

getParentCommitId

public String getParentCommitId()

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.

withParentCommitId

public PutFileRequest withParentCommitId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setCommitMessage

public void setCommitMessage(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.

Parameters:

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.

getCommitMessage

public String getCommitMessage()

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.

withCommitMessage

public PutFileRequest withCommitMessage(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(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.

Parameters:

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.

getName

public String getName()

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.

withName

public PutFileRequest withName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setEmail

public void setEmail(String email)

An email address for the person adding or updating the file.

Parameters:

email - An email address for the person adding or updating the file.

getEmail

public String getEmail()

An email address for the person adding or updating the file.

Returns:

An email address for the person adding or updating the file.

withEmail

public PutFileRequest withEmail(String email)

An email address for the person adding or updating the file.

Parameters:

email - An email address for the person adding or updating the file.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutFileRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()