Struct aws_sdk_codegurureviewer::model::CodeReview

#[non_exhaustive]
pub struct CodeReview {

    pub name: Option<String>,
    pub code_review_arn: Option<String>,
    pub repository_name: Option<String>,
    pub owner: Option<String>,
    pub provider_type: Option<ProviderType>,
    pub state: Option<JobState>,
    pub state_reason: Option<String>,
    pub created_time_stamp: Option<DateTime>,
    pub last_updated_time_stamp: Option<DateTime>,
    pub type: Option<Type>,
    pub pull_request_id: Option<String>,
    pub source_code_type: Option<SourceCodeType>,
    pub association_arn: Option<String>,
    pub metrics: Option<Metrics>,
    pub analysis_types: Option<Vec<AnalysisType>>,
    pub config_file_state: Option<ConfigFileState>,
}

Information about a code review. A code review belongs to the associated repository that contains the reviewed code.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the code review.

code_review_arn: Option<String>

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

repository_name: Option<String>

The name of the repository.

owner: Option<String>

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.

provider_type: Option<ProviderType>

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

state: Option<JobState>

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_reason: Option<String>

The reason for the state of the code review.

created_time_stamp: Option<DateTime>

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

last_updated_time_stamp: Option<DateTime>

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

type: Option<Type>

The type of code review.

pull_request_id: Option<String>

The pull request ID for the code review.

source_code_type: Option<SourceCodeType>

The type of the source code for the code review.

association_arn: Option<String>

The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations .

metrics: Option<Metrics>

The statistics from the code review.

analysis_types: Option<Vec<AnalysisType>>

The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

config_file_state: Option<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.

Implementations

impl CodeReview

pub fn name(&self) -> Option<&str>

The name of the code review.

pub fn code_review_arn(&self) -> Option<&str>

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

pub fn repository_name(&self) -> Option<&str>

The name of the repository.

pub fn owner(&self) -> Option<&str>

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.

pub fn provider_type(&self) -> Option<&ProviderType>

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

pub fn state(&self) -> Option<&JobState>

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.

pub fn state_reason(&self) -> Option<&str>

The reason for the state of the code review.

pub fn created_time_stamp(&self) -> Option<&DateTime>

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

pub fn last_updated_time_stamp(&self) -> Option<&DateTime>

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

pub fn type(&self) -> Option<&Type>

The type of code review.

pub fn pull_request_id(&self) -> Option<&str>

The pull request ID for the code review.

pub fn source_code_type(&self) -> Option<&SourceCodeType>

The type of the source code for the code review.

pub fn association_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations .

pub fn metrics(&self) -> Option<&Metrics>

The statistics from the code review.

pub fn analysis_types(&self) -> Option<&[AnalysisType]>

The types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.

pub fn config_file_state(&self) -> Option<&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.

impl CodeReview

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CodeReview

Trait Implementations

impl Clone for CodeReview

fn clone(&self) -> CodeReview

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodeReview

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<CodeReview> for CodeReview

fn eq(&self, other: &CodeReview) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CodeReview) -> bool

This method tests for !=.

impl StructuralPartialEq for CodeReview