Class CodeReview
- java.lang.Object
-
- software.amazon.awssdk.services.codegurureviewer.model.CodeReview
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CodeReview.Builder,CodeReview>
@Generated("software.amazon.awssdk:codegen") public final class CodeReview extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CodeReview.Builder,CodeReview>
Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCodeReview.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AnalysisType>analysisTypes()The types of analysis performed during a repository analysis or a pull request review.List<String>analysisTypesAsStrings()The types of analysis performed during a repository analysis or a pull request review.StringassociationArn()The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code.static CodeReview.Builderbuilder()StringcodeReviewArn()The Amazon Resource Name (ARN) of the CodeReview object.ConfigFileStateconfigFileState()The state of theaws-codeguru-reviewer.ymlconfiguration file that allows the configuration of the CodeGuru Reviewer analysis.StringconfigFileStateAsString()The state of theaws-codeguru-reviewer.ymlconfiguration file that allows the configuration of the CodeGuru Reviewer analysis.InstantcreatedTimeStamp()The time, in milliseconds since the epoch, when the code review was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAnalysisTypes()For responses, this returns true if the service returned a value for the AnalysisTypes property.inthashCode()InstantlastUpdatedTimeStamp()The time, in milliseconds since the epoch, when the code review was last updated.Metricsmetrics()The statistics from the code review.Stringname()The name of the code review.Stringowner()The owner of the repository.ProviderTypeproviderType()The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).StringproviderTypeAsString()The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).StringpullRequestId()The pull request ID for the code review.StringrepositoryName()The name of the repository.List<SdkField<?>>sdkFields()static Class<? extends CodeReview.Builder>serializableBuilderClass()SourceCodeTypesourceCodeType()The type of the source code for the code review.JobStatestate()The valid code review states are:StringstateAsString()The valid code review states are:StringstateReason()The reason for the state of the code review.CodeReview.BuildertoBuilder()StringtoString()Returns a string representation of this object.Typetype()The type of code review.StringtypeAsString()The type of code review.-
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
-
name
public final String name()
The name of the code review.
- Returns:
- The name of the code review.
-
codeReviewArn
public final String codeReviewArn()
The Amazon Resource Name (ARN) of the CodeReview object.
- Returns:
- The Amazon Resource Name (ARN) of the CodeReview object.
-
repositoryName
public final String repositoryName()
The name of the repository.
- Returns:
- The name of the repository.
-
owner
public final 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.
- Returns:
- 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.
-
providerType
public final ProviderType providerType()
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
If the service returns an enum value that is not available in the current SDK version,
providerTypewill returnProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromproviderTypeAsString().- Returns:
- The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
- See Also:
ProviderType
-
providerTypeAsString
public final String providerTypeAsString()
The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
If the service returns an enum value that is not available in the current SDK version,
providerTypewill returnProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromproviderTypeAsString().- Returns:
- The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
- See Also:
ProviderType
-
state
public final 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.
If the service returns an enum value that is not available in the current SDK version,
statewill returnJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- 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.
-
- See Also:
JobState
-
-
stateAsString
public final String stateAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
statewill returnJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- 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.
-
- See Also:
JobState
-
-
stateReason
public final String stateReason()
The reason for the state of the code review.
- Returns:
- The reason for the state of the code review.
-
createdTimeStamp
public final Instant createdTimeStamp()
The time, in milliseconds since the epoch, when the code review was created.
- Returns:
- The time, in milliseconds since the epoch, when the code review was created.
-
lastUpdatedTimeStamp
public final Instant lastUpdatedTimeStamp()
The time, in milliseconds since the epoch, when the code review was last updated.
- Returns:
- The time, in milliseconds since the epoch, when the code review was last updated.
-
type
public final Type type()
The type of code review.
If the service returns an enum value that is not available in the current SDK version,
typewill returnType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of code review.
- See Also:
Type
-
typeAsString
public final String typeAsString()
The type of code review.
If the service returns an enum value that is not available in the current SDK version,
typewill returnType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The type of code review.
- See Also:
Type
-
pullRequestId
public final String pullRequestId()
The pull request ID for the code review.
- Returns:
- The pull request ID for the code review.
-
sourceCodeType
public final SourceCodeType sourceCodeType()
The type of the source code for the code review.
- Returns:
- The type of the source code for the code review.
-
associationArn
public final 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.
- Returns:
- The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
-
metrics
public final Metrics metrics()
The statistics from the code review.
- Returns:
- The statistics from the code review.
-
analysisTypes
public final List<AnalysisType> analysisTypes()
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security,CodeQuality, or both.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAnalysisTypes()method.- Returns:
- The types of analysis performed during a repository analysis or a pull request review. You can specify
either
Security,CodeQuality, or both.
-
hasAnalysisTypes
public final boolean hasAnalysisTypes()
For responses, this returns true if the service returned a value for the AnalysisTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
analysisTypesAsStrings
public final List<String> analysisTypesAsStrings()
The types of analysis performed during a repository analysis or a pull request review. You can specify either
Security,CodeQuality, or both.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAnalysisTypes()method.- Returns:
- The types of analysis performed during a repository analysis or a pull request review. You can specify
either
Security,CodeQuality, or both.
-
configFileState
public final ConfigFileState configFileState()
The state of the
aws-codeguru-reviewer.ymlconfiguration 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.If the service returns an enum value that is not available in the current SDK version,
configFileStatewill returnConfigFileState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconfigFileStateAsString().- Returns:
- The state of the
aws-codeguru-reviewer.ymlconfiguration 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. - See Also:
ConfigFileState
-
configFileStateAsString
public final String configFileStateAsString()
The state of the
aws-codeguru-reviewer.ymlconfiguration 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.If the service returns an enum value that is not available in the current SDK version,
configFileStatewill returnConfigFileState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromconfigFileStateAsString().- Returns:
- The state of the
aws-codeguru-reviewer.ymlconfiguration 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. - See Also:
ConfigFileState
-
toBuilder
public CodeReview.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CodeReview.Builder,CodeReview>
-
builder
public static CodeReview.Builder builder()
-
serializableBuilderClass
public static Class<? extends CodeReview.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-