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:

  • Method Details

    • 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, providerType will return ProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from providerTypeAsString().

      Returns:
      The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
      See Also:

    • 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, providerType will return ProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from providerTypeAsString().

      Returns:
      The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
      See Also:

    • 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, state will return JobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      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:

    • 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, state will return JobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      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:

    • 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, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of code review.
      See Also:

    • 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, type will return Type.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of code review.
      See Also:

    • 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 the isEmpty() 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.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.

      If the service returns an enum value that is not available in the current SDK version, configFileState will return ConfigFileState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configFileStateAsString().

      Returns:
      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.
      See Also:

    • configFileStateAsString

      public final String configFileStateAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, configFileState will return ConfigFileState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from configFileStateAsString().

      Returns:
      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.
      See Also:

    • toBuilder

      public CodeReview.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CodeReview.Builder,CodeReview>
      Returns:
      a builder for type T

    • builder

      public static CodeReview.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CodeReview.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.