veracode_platform::policy

Struct PolicyApi

Source 
pub struct PolicyApi<'a> { /* private fields */ }
Expand description

Veracode Policy API operations

Implementations§

Source§

impl<'a> PolicyApi<'a>

Source

pub fn new(client: &'a VeracodeClient) -> Self

Create a new PolicyApi instance

Source

pub async fn list_policies( &self, params: Option<PolicyListParams>, ) -> Result<Vec<SecurityPolicy>, PolicyError>

List all available security policies

§Arguments
  • params - Optional query parameters for filtering
§Returns

A Result containing a list of policies or an error.

Source

pub async fn get_policy( &self, policy_guid: &str, ) -> Result<SecurityPolicy, PolicyError>

Get a specific policy by GUID

§Arguments
  • policy_guid - The GUID of the policy
§Returns

A Result containing the policy or an error.

Source

pub async fn get_default_policy(&self) -> Result<SecurityPolicy, PolicyError>

Get the default policy for the organization

§Returns

A Result containing the default policy or an error.

Source

pub async fn evaluate_policy_compliance( &self, application_guid: &str, policy_guid: &str, sandbox_guid: Option<&str>, ) -> Result<PolicyComplianceResult, PolicyError>

Evaluate policy compliance for an application

§Arguments
  • application_guid - The GUID of the application
  • policy_guid - The GUID of the policy to evaluate against
  • sandbox_guid - Optional sandbox GUID for sandbox evaluation
§Returns

A Result containing the compliance result or an error.

Source

pub async fn initiate_policy_scan( &self, request: PolicyScanRequest, ) -> Result<PolicyScanResult, PolicyError>

Initiate a policy scan for an application

§Arguments
  • request - The policy scan request
§Returns

A Result containing the scan result or an error.

Source

pub async fn get_policy_scan_result( &self, scan_id: u64, ) -> Result<PolicyScanResult, PolicyError>

Get policy scan status and results

§Arguments
  • scan_id - The ID of the policy scan
§Returns

A Result containing the scan result or an error.

Source

pub async fn is_policy_scan_complete( &self, scan_id: u64, ) -> Result<bool, PolicyError>

Check if a policy scan is complete

§Arguments
  • scan_id - The ID of the policy scan
§Returns

A Result containing a boolean indicating completion status.

Source

pub async fn get_policy_violations( &self, application_guid: &str, policy_guid: &str, sandbox_guid: Option<&str>, ) -> Result<Vec<PolicyViolation>, PolicyError>

Get policy violations for an application

§Arguments
  • application_guid - The GUID of the application
  • policy_guid - The GUID of the policy
  • sandbox_guid - Optional sandbox GUID
§Returns

A Result containing policy violations or an error.

Source§

impl<'a> PolicyApi<'a>

Convenience methods for common policy operations

Source

pub async fn is_application_compliant( &self, application_guid: &str, policy_guid: &str, ) -> Result<bool, PolicyError>

Check if an application passes policy compliance

§Arguments
  • application_guid - The GUID of the application
  • policy_guid - The GUID of the policy
§Returns

A Result containing a boolean indicating compliance status.

Source

pub async fn get_compliance_score( &self, application_guid: &str, policy_guid: &str, ) -> Result<Option<f64>, PolicyError>

Get compliance score for an application

§Arguments
  • application_guid - The GUID of the application
  • policy_guid - The GUID of the policy
§Returns

A Result containing the compliance score or an error.

Source

pub async fn get_active_policies( &self, ) -> Result<Vec<SecurityPolicy>, PolicyError>

Get active policies for the organization

§Returns

A Result containing a list of active policies or an error.

Auto Trait Implementations§

§

impl<'a> Freeze for PolicyApi<'a>

§

impl<'a> !RefUnwindSafe for PolicyApi<'a>

§

impl<'a> Send for PolicyApi<'a>

§

impl<'a> Sync for PolicyApi<'a>

§

impl<'a> Unpin for PolicyApi<'a>

§

impl<'a> !UnwindSafe for PolicyApi<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,