JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.codegurureviewer.model

Class CodeReview

    • Constructor Detail

      • CodeReview

        public CodeReview()
    • Method Detail

      • setName

        public void setName(String name)

        The name of the code review.

        Parameters:
        name - The name of the code review.
      • getName

        public String getName()

        The name of the code review.

        Returns:
        The name of the code review.
      • withName

        public CodeReview withName(String name)

        The name of the code review.

        Parameters:
        name - The name of the code review.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCodeReviewArn

        public void setCodeReviewArn(String codeReviewArn)

        The Amazon Resource Name (ARN) of the CodeReview object.

        Parameters:
        codeReviewArn - The Amazon Resource Name (ARN) of the CodeReview object.
      • getCodeReviewArn

        public String getCodeReviewArn()

        The Amazon Resource Name (ARN) of the CodeReview object.

        Returns:
        The Amazon Resource Name (ARN) of the CodeReview object.
      • withCodeReviewArn

        public CodeReview withCodeReviewArn(String codeReviewArn)

        The Amazon Resource Name (ARN) of the CodeReview object.

        Parameters:
        codeReviewArn - The Amazon Resource Name (ARN) of the CodeReview object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setRepositoryName

        public void setRepositoryName(String repositoryName)

        The name of the repository.

        Parameters:
        repositoryName - The name of the repository.
      • getRepositoryName

        public String getRepositoryName()

        The name of the repository.

        Returns:
        The name of the repository.
      • withRepositoryName

        public CodeReview withRepositoryName(String repositoryName)

        The name of the repository.

        Parameters:
        repositoryName - The name of the repository.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setOwner

        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.

        Parameters:
        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.
      • getOwner

        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.

        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.
      • withOwner

        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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • setProviderType

        public void setProviderType(String providerType)

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

        Parameters:
        providerType - The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
        See Also:
        ProviderType
      • getProviderType

        public String getProviderType()

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

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

        public CodeReview withProviderType(String providerType)

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

        Parameters:
        providerType - The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProviderType
      • withProviderType

        public CodeReview withProviderType(ProviderType providerType)

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

        Parameters:
        providerType - The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ProviderType
      • setState

        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.

        Parameters:
        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.

        See Also:
        JobState
      • getState

        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.

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

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobState
      • withState

        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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobState
      • setStateReason

        public void setStateReason(String stateReason)

        The reason for the state of the code review.

        Parameters:
        stateReason - The reason for the state of the code review.
      • getStateReason

        public String getStateReason()

        The reason for the state of the code review.

        Returns:
        The reason for the state of the code review.
      • withStateReason

        public CodeReview withStateReason(String stateReason)

        The reason for the state of the code review.

        Parameters:
        stateReason - The reason for the state of the code review.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCreatedTimeStamp

        public void setCreatedTimeStamp(Date createdTimeStamp)

        The time, in milliseconds since the epoch, when the code review was created.

        Parameters:
        createdTimeStamp - The time, in milliseconds since the epoch, when the code review was created.
      • getCreatedTimeStamp

        public Date getCreatedTimeStamp()

        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.
      • withCreatedTimeStamp

        public CodeReview withCreatedTimeStamp(Date createdTimeStamp)

        The time, in milliseconds since the epoch, when the code review was created.

        Parameters:
        createdTimeStamp - The time, in milliseconds since the epoch, when the code review was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setLastUpdatedTimeStamp

        public void setLastUpdatedTimeStamp(Date lastUpdatedTimeStamp)

        The time, in milliseconds since the epoch, when the code review was last updated.

        Parameters:
        lastUpdatedTimeStamp - The time, in milliseconds since the epoch, when the code review was last updated.
      • getLastUpdatedTimeStamp

        public Date getLastUpdatedTimeStamp()

        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.
      • withLastUpdatedTimeStamp

        public CodeReview withLastUpdatedTimeStamp(Date lastUpdatedTimeStamp)

        The time, in milliseconds since the epoch, when the code review was last updated.

        Parameters:
        lastUpdatedTimeStamp - The time, in milliseconds since the epoch, when the code review was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setType

        public void setType(String type)

        The type of code review.

        Parameters:
        type - The type of code review.
        See Also:
        Type
      • getType

        public String getType()

        The type of code review.

        Returns:
        The type of code review.
        See Also:
        Type
      • withType

        public CodeReview withType(String type)

        The type of code review.

        Parameters:
        type - The type of code review.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Type
      • withType

        public CodeReview withType(Type type)

        The type of code review.

        Parameters:
        type - The type of code review.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Type
      • setPullRequestId

        public void setPullRequestId(String pullRequestId)

        The pull request ID for the code review.

        Parameters:
        pullRequestId - The pull request ID for the code review.
      • getPullRequestId

        public String getPullRequestId()

        The pull request ID for the code review.

        Returns:
        The pull request ID for the code review.
      • withPullRequestId

        public CodeReview withPullRequestId(String pullRequestId)

        The pull request ID for the code review.

        Parameters:
        pullRequestId - The pull request ID for the code review.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSourceCodeType

        public void setSourceCodeType(SourceCodeType sourceCodeType)

        The type of the source code for the code review.

        Parameters:
        sourceCodeType - The type of the source code for the code review.
      • getSourceCodeType

        public SourceCodeType getSourceCodeType()

        The type of the source code for the code review.

        Returns:
        The type of the source code for the code review.
      • withSourceCodeType

        public CodeReview withSourceCodeType(SourceCodeType sourceCodeType)

        The type of the source code for the code review.

        Parameters:
        sourceCodeType - The type of the source code for the code review.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withAssociationArn

        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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.
      • setMetrics

        public void setMetrics(Metrics metrics)

        The statistics from the code review.

        Parameters:
        metrics - The statistics from the code review.
      • getMetrics

        public Metrics getMetrics()

        The statistics from the code review.

        Returns:
        The statistics from the code review.
      • withMetrics

        public CodeReview withMetrics(Metrics metrics)

        The statistics from the code review.

        Parameters:
        metrics - The statistics from the code review.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getAnalysisTypes

        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.

        Returns:
        The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
        See Also:
        AnalysisType
      • setAnalysisTypes

        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.

        Parameters:
        analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
        See Also:
        AnalysisType
      • withAnalysisTypes

        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.

        Parameters:
        analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalysisType
      • withAnalysisTypes

        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.

        Parameters:
        analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalysisType
      • withAnalysisTypes

        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.

        Parameters:
        analysisTypes - The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalysisType
      • setConfigFileState

        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.

        Parameters:
        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.
        See Also:
        ConfigFileState
      • getConfigFileState

        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.

        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:
        ConfigFileState
      • withConfigFileState

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ConfigFileState
      • withConfigFileState

        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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ConfigFileState
      • 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()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /