Struct RequestMetadata

#[non_exhaustive]
pub struct RequestMetadata {
    pub request_id: Option<String>,
    pub requester: Option<String>,
    pub event_info: Option<EventInfo>,
    pub vendor_name: Option<VendorName>,
}

Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.

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.

request_id: Option<String>

The ID of the request. This is required for a pull request code review.

requester: Option<String>

An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

event_info: Option<EventInfo>

Information about the event associated with a code review.

vendor_name: Option<VendorName>

The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.

Implementations

impl RequestMetadata

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

The ID of the request. This is required for a pull request code review.

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

An identifier, such as a name or account ID, that is associated with the requester. The Requester is used to capture the author/actor name of the event request.

pub fn event_info(&self) -> Option<&EventInfo>

Information about the event associated with a code review.

pub fn vendor_name(&self) -> Option<&VendorName>

The name of the repository vendor used to upload code to an S3 bucket for a CI/CD code review. For example, if code and artifacts are uploaded to an S3 bucket for a CI/CD code review by GitHub scripts from a GitHub repository, then the repository association's ProviderType is S3Bucket and the CI/CD repository vendor name is GitHub. For more information, see the definition for ProviderType in RepositoryAssociation.

impl RequestMetadata

pub fn builder() -> RequestMetadataBuilder

Creates a new builder-style object to manufacture RequestMetadata.

Trait Implementations

impl Clone for RequestMetadata

fn clone(&self) -> RequestMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RequestMetadata

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

Formats the value using the given formatter.

impl PartialEq for RequestMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RequestMetadata