@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CodeReview extends Object implements Serializable, Cloneable, StructuredPojo
Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
Constructor and Description |
---|
CodeReview() |
Modifier and Type | Method and Description |
---|---|
CodeReview |
clone() |
boolean |
equals(Object obj) |
List<String> |
getAnalysisTypes()
The types of analysis performed during a repository analysis or a pull request review.
|
String |
getAssociationArn()
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code.
|
String |
getCodeReviewArn()
The Amazon Resource Name (ARN) of the CodeReview object.
|
String |
getConfigFileState()
The state of the
aws-codeguru-reviewer.yml configuration file that allows the configuration of the
CodeGuru Reviewer analysis. |
Date |
getCreatedTimeStamp()
The time, in milliseconds since the epoch, when the code review was created.
|
Date |
getLastUpdatedTimeStamp()
The time, in milliseconds since the epoch, when the code review was last updated.
|
Metrics |
getMetrics()
The statistics from the code review.
|
String |
getName()
The name of the code review.
|
String |
getOwner()
The owner of the repository.
|
String |
getProviderType()
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
|
String |
getPullRequestId()
The pull request ID for the code review.
|
String |
getRepositoryName()
The name of the repository.
|
SourceCodeType |
getSourceCodeType()
The type of the source code for the code review.
|
String |
getState()
The valid code review states are:
|
String |
getStateReason()
The reason for the state of the code review.
|
String |
getType()
The type of code review.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAnalysisTypes(Collection<String> analysisTypes)
The types of analysis performed during a repository analysis or a pull request review.
|
void |
setAssociationArn(String associationArn)
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code.
|
void |
setCodeReviewArn(String codeReviewArn)
The Amazon Resource Name (ARN) of the CodeReview object.
|
void |
setConfigFileState(String configFileState)
The state of the
aws-codeguru-reviewer.yml configuration file that allows the configuration of the
CodeGuru Reviewer analysis. |
void |
setCreatedTimeStamp(Date createdTimeStamp)
The time, in milliseconds since the epoch, when the code review was created.
|
void |
setLastUpdatedTimeStamp(Date lastUpdatedTimeStamp)
The time, in milliseconds since the epoch, when the code review was last updated.
|
void |
setMetrics(Metrics metrics)
The statistics from the code review.
|
void |
setName(String name)
The name of the code review.
|
void |
setOwner(String owner)
The owner of the repository.
|
void |
setProviderType(String providerType)
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
|
void |
setPullRequestId(String pullRequestId)
The pull request ID for the code review.
|
void |
setRepositoryName(String repositoryName)
The name of the repository.
|
void |
setSourceCodeType(SourceCodeType sourceCodeType)
The type of the source code for the code review.
|
void |
setState(String state)
The valid code review states are:
|
void |
setStateReason(String stateReason)
The reason for the state of the code review.
|
void |
setType(String type)
The type of code review.
|
String |
toString()
Returns a string representation of this object.
|
CodeReview |
withAnalysisTypes(AnalysisType... analysisTypes)
The types of analysis performed during a repository analysis or a pull request review.
|
CodeReview |
withAnalysisTypes(Collection<String> analysisTypes)
The types of analysis performed during a repository analysis or a pull request review.
|
CodeReview |
withAnalysisTypes(String... analysisTypes)
The types of analysis performed during a repository analysis or a pull request review.
|
CodeReview |
withAssociationArn(String associationArn)
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code.
|
CodeReview |
withCodeReviewArn(String codeReviewArn)
The Amazon Resource Name (ARN) of the CodeReview object.
|
CodeReview |
withConfigFileState(ConfigFileState configFileState)
The state of the
aws-codeguru-reviewer.yml configuration file that allows the configuration of the
CodeGuru Reviewer analysis. |
CodeReview |
withConfigFileState(String configFileState)
The state of the
aws-codeguru-reviewer.yml configuration file that allows the configuration of the
CodeGuru Reviewer analysis. |
CodeReview |
withCreatedTimeStamp(Date createdTimeStamp)
The time, in milliseconds since the epoch, when the code review was created.
|
CodeReview |
withLastUpdatedTimeStamp(Date lastUpdatedTimeStamp)
The time, in milliseconds since the epoch, when the code review was last updated.
|
CodeReview |
withMetrics(Metrics metrics)
The statistics from the code review.
|
CodeReview |
withName(String name)
The name of the code review.
|
CodeReview |
withOwner(String owner)
The owner of the repository.
|
CodeReview |
withProviderType(ProviderType providerType)
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
|
CodeReview |
withProviderType(String providerType)
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
|
CodeReview |
withPullRequestId(String pullRequestId)
The pull request ID for the code review.
|
CodeReview |
withRepositoryName(String repositoryName)
The name of the repository.
|
CodeReview |
withSourceCodeType(SourceCodeType sourceCodeType)
The type of the source code for the code review.
|
CodeReview |
withState(JobState state)
The valid code review states are:
|
CodeReview |
withState(String state)
The valid code review states are:
|
CodeReview |
withStateReason(String stateReason)
The reason for the state of the code review.
|
CodeReview |
withType(String type)
The type of code review.
|
CodeReview |
withType(Type type)
The type of code review.
|
public void setName(String name)
The name of the code review.
name
- The name of the code review.public String getName()
The name of the code review.
public CodeReview withName(String name)
The name of the code review.
name
- The name of the code review.public void setCodeReviewArn(String codeReviewArn)
The Amazon Resource Name (ARN) of the CodeReview object.
codeReviewArn
- The Amazon Resource Name (ARN) of the CodeReview object.public String getCodeReviewArn()
The Amazon Resource Name (ARN) of the CodeReview object.
public CodeReview withCodeReviewArn(String codeReviewArn)
The Amazon Resource Name (ARN) of the CodeReview object.
codeReviewArn
- The Amazon Resource Name (ARN) of the CodeReview object.public void setRepositoryName(String repositoryName)
The name of the repository.
repositoryName
- The name of the repository.public String getRepositoryName()
The name of the repository.
public CodeReview withRepositoryName(String repositoryName)
The name of the repository.
repositoryName
- The name of the repository.public void setOwner(String owner)
The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.
owner
- The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web
Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or
Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository,
it can be the username or Amazon Web Services account ID.public String getOwner()
The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.
public CodeReview withOwner(String owner)
The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.
owner
- The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web
Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or
Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository,
it can be the username or Amazon Web Services account ID.public void setProviderType(String providerType)
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
providerType
- The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).ProviderType
public String getProviderType()
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
ProviderType
public CodeReview withProviderType(String providerType)
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
providerType
- The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).ProviderType
public CodeReview withProviderType(ProviderType providerType)
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
providerType
- The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).ProviderType
public void setState(String state)
The valid code review states are:
Completed
: The code review is complete.
Pending
: The code review started and has not completed or failed.
Failed
: The code review failed.
Deleting
: The code review is being deleted.
state
- The valid code review states are:
Completed
: The code review is complete.
Pending
: The code review started and has not completed or failed.
Failed
: The code review failed.
Deleting
: The code review is being deleted.
JobState
public String getState()
The valid code review states are:
Completed
: The code review is complete.
Pending
: The code review started and has not completed or failed.
Failed
: The code review failed.
Deleting
: The code review is being deleted.
Completed
: The code review is complete.
Pending
: The code review started and has not completed or failed.
Failed
: The code review failed.
Deleting
: The code review is being deleted.
JobState
public CodeReview withState(String state)
The valid code review states are:
Completed
: The code review is complete.
Pending
: The code review started and has not completed or failed.
Failed
: The code review failed.
Deleting
: The code review is being deleted.
state
- The valid code review states are:
Completed
: The code review is complete.
Pending
: The code review started and has not completed or failed.
Failed
: The code review failed.
Deleting
: The code review is being deleted.
JobState
public CodeReview withState(JobState state)
The valid code review states are:
Completed
: The code review is complete.
Pending
: The code review started and has not completed or failed.
Failed
: The code review failed.
Deleting
: The code review is being deleted.
state
- The valid code review states are:
Completed
: The code review is complete.
Pending
: The code review started and has not completed or failed.
Failed
: The code review failed.
Deleting
: The code review is being deleted.
JobState
public void setStateReason(String stateReason)
The reason for the state of the code review.
stateReason
- The reason for the state of the code review.public String getStateReason()
The reason for the state of the code review.
public CodeReview withStateReason(String stateReason)
The reason for the state of the code review.
stateReason
- The reason for the state of the code review.public void setCreatedTimeStamp(Date createdTimeStamp)
The time, in milliseconds since the epoch, when the code review was created.
createdTimeStamp
- The time, in milliseconds since the epoch, when the code review was created.public Date getCreatedTimeStamp()
The time, in milliseconds since the epoch, when the code review was created.
public CodeReview withCreatedTimeStamp(Date createdTimeStamp)
The time, in milliseconds since the epoch, when the code review was created.
createdTimeStamp
- The time, in milliseconds since the epoch, when the code review was created.public void setLastUpdatedTimeStamp(Date lastUpdatedTimeStamp)
The time, in milliseconds since the epoch, when the code review was last updated.
lastUpdatedTimeStamp
- The time, in milliseconds since the epoch, when the code review was last updated.public Date getLastUpdatedTimeStamp()
The time, in milliseconds since the epoch, when the code review was last updated.
public CodeReview withLastUpdatedTimeStamp(Date lastUpdatedTimeStamp)
The time, in milliseconds since the epoch, when the code review was last updated.
lastUpdatedTimeStamp
- The time, in milliseconds since the epoch, when the code review was last updated.public void setType(String type)
The type of code review.
type
- The type of code review.Type
public String getType()
The type of code review.
Type
public CodeReview withType(String type)
The type of code review.
type
- The type of code review.Type
public CodeReview withType(Type type)
The type of code review.
type
- The type of code review.Type
public void setPullRequestId(String pullRequestId)
The pull request ID for the code review.
pullRequestId
- The pull request ID for the code review.public String getPullRequestId()
The pull request ID for the code review.
public CodeReview withPullRequestId(String pullRequestId)
The pull request ID for the code review.
pullRequestId
- The pull request ID for the code review.public void setSourceCodeType(SourceCodeType sourceCodeType)
The type of the source code for the code review.
sourceCodeType
- The type of the source code for the code review.public SourceCodeType getSourceCodeType()
The type of the source code for the code review.
public CodeReview withSourceCodeType(SourceCodeType sourceCodeType)
The type of the source code for the code review.
sourceCodeType
- The type of the source code for the code review.public void setAssociationArn(String associationArn)
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
associationArn
- The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository
ARNs by calling ListRepositoryAssociations.public String getAssociationArn()
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
public CodeReview withAssociationArn(String associationArn)
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
associationArn
- The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository
ARNs by calling ListRepositoryAssociations.public void setMetrics(Metrics metrics)
The statistics from the code review.
metrics
- The statistics from the code review.public Metrics getMetrics()
The statistics from the code review.
public CodeReview withMetrics(Metrics metrics)
The statistics from the code review.
metrics
- The statistics from the code review.public List<String> getAnalysisTypes()
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
, CodeQuality
, or both.
Security
, CodeQuality
, or both.AnalysisType
public void setAnalysisTypes(Collection<String> analysisTypes)
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
, CodeQuality
, or both.
analysisTypes
- The types of analysis performed during a repository analysis or a pull request review. You can specify
either Security
, CodeQuality
, or both.AnalysisType
public CodeReview withAnalysisTypes(String... analysisTypes)
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
, CodeQuality
, or both.
NOTE: This method appends the values to the existing list (if any). Use
setAnalysisTypes(java.util.Collection)
or withAnalysisTypes(java.util.Collection)
if you want
to override the existing values.
analysisTypes
- The types of analysis performed during a repository analysis or a pull request review. You can specify
either Security
, CodeQuality
, or both.AnalysisType
public CodeReview withAnalysisTypes(Collection<String> analysisTypes)
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
, CodeQuality
, or both.
analysisTypes
- The types of analysis performed during a repository analysis or a pull request review. You can specify
either Security
, CodeQuality
, or both.AnalysisType
public CodeReview withAnalysisTypes(AnalysisType... analysisTypes)
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security
, CodeQuality
, or both.
analysisTypes
- The types of analysis performed during a repository analysis or a pull request review. You can specify
either Security
, CodeQuality
, or both.AnalysisType
public void setConfigFileState(String configFileState)
The state of the aws-codeguru-reviewer.yml
configuration file that allows the configuration of the
CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of
your repository.
configFileState
- The state of the aws-codeguru-reviewer.yml
configuration file that allows the configuration
of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the
root directory of your repository.ConfigFileState
public String getConfigFileState()
The state of the aws-codeguru-reviewer.yml
configuration file that allows the configuration of the
CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of
your repository.
aws-codeguru-reviewer.yml
configuration file that allows the configuration
of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the
root directory of your repository.ConfigFileState
public CodeReview withConfigFileState(String configFileState)
The state of the aws-codeguru-reviewer.yml
configuration file that allows the configuration of the
CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of
your repository.
configFileState
- The state of the aws-codeguru-reviewer.yml
configuration file that allows the configuration
of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the
root directory of your repository.ConfigFileState
public CodeReview withConfigFileState(ConfigFileState configFileState)
The state of the aws-codeguru-reviewer.yml
configuration file that allows the configuration of the
CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the root directory of
your repository.
configFileState
- The state of the aws-codeguru-reviewer.yml
configuration file that allows the configuration
of the CodeGuru Reviewer analysis. The file either exists, doesn't exist, or exists with errors at the
root directory of your repository.ConfigFileState
public String toString()
toString
in class Object
Object.toString()
public CodeReview clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.