Struct Framework 

#[non_exhaustive]
pub struct Framework {
    pub name: String,
    pub major_revision_id: i64,
    pub display_name: String,
    pub description: String,
    pub type: FrameworkType,
    pub cloud_control_details: Vec<CloudControlDetails>,
    pub category: Vec<FrameworkCategory>,
    pub supported_cloud_providers: Vec<CloudProvider>,
    pub supported_target_resource_types: Vec<TargetResourceType>,
    pub supported_enforcement_modes: Vec<EnforcementMode>,
    /* private fields */
}

A framework is a collection of cloud controls and regulatory controls that represent security best practices or industry-defined standards such as FedRAMP or NIST.

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

Required. Identifier. The name of the framework, in one of the following formats: organizations/{organization}/locations/{location}/frameworks/{framework} or projects/{project}/locations/{location}/frameworks/{framework}.

The only supported location is global.

major_revision_id: i64

Output only. The major version of the framework, which is incremented in ascending order.

display_name: String

Optional. The friendly name of the framework. The maximum length is 200 characters.

description: String

Optional. The description of the framework. The maximum length is 2000 characters.

type: FrameworkType

Output only. The type of framework.

cloud_control_details: Vec<CloudControlDetails>

Optional. The cloud control details that are directly added without any grouping in the framework.

category: Vec<FrameworkCategory>

Optional. The category of the framework.

supported_cloud_providers: Vec<CloudProvider>

Output only. The cloud providers that are supported by the framework.

supported_target_resource_types: Vec<TargetResourceType>

Output only. The target resource types that are supported by the framework.

supported_enforcement_modes: Vec<EnforcementMode>

Output only. The supported enforcement modes of the framework.

Implementations

impl Framework

pub fn new() -> Self

Creates a new default instance.

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

Example

let x = Framework::new().set_name(format!("organizations/{organization_id}/locations/{location_id}/frameworks/{framework_id}"));

pub fn set_major_revision_id<T: Into<i64>>(self, v: T) -> Self

Sets the value of major_revision_id.

Example

let x = Framework::new().set_major_revision_id(42);

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

Example

let x = Framework::new().set_display_name("example");

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

Example

let x = Framework::new().set_description("example");

pub fn set_type<T: Into<FrameworkType>>(self, v: T) -> Self

Sets the value of r#type.

Example

use google_cloud_cloudsecuritycompliance_v1::model::framework::FrameworkType;
let x0 = Framework::new().set_type(FrameworkType::BuiltIn);
let x1 = Framework::new().set_type(FrameworkType::Custom);

pub fn set_cloud_control_details<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<CloudControlDetails>,

Sets the value of cloud_control_details.

Example

use google_cloud_cloudsecuritycompliance_v1::model::CloudControlDetails;
let x = Framework::new()
    .set_cloud_control_details([
        CloudControlDetails::default()/* use setters */,
        CloudControlDetails::default()/* use (different) setters */,
    ]);

pub fn set_category<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<FrameworkCategory>,

Sets the value of category.

Example

use google_cloud_cloudsecuritycompliance_v1::model::FrameworkCategory;
let x = Framework::new().set_category([
    FrameworkCategory::IndustryDefinedStandard,
    FrameworkCategory::AssuredWorkloads,
    FrameworkCategory::DataSecurity,
]);

pub fn set_supported_cloud_providers<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<CloudProvider>,

Sets the value of supported_cloud_providers.

Example

use google_cloud_cloudsecuritycompliance_v1::model::CloudProvider;
let x = Framework::new().set_supported_cloud_providers([
    CloudProvider::Aws,
    CloudProvider::Azure,
    CloudProvider::Gcp,
]);

pub fn set_supported_target_resource_types<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<TargetResourceType>,

Sets the value of supported_target_resource_types.

Example

use google_cloud_cloudsecuritycompliance_v1::model::TargetResourceType;
let x = Framework::new().set_supported_target_resource_types([
    TargetResourceType::TargetResourceCrmTypeOrg,
    TargetResourceType::TargetResourceCrmTypeFolder,
    TargetResourceType::TargetResourceCrmTypeProject,
]);

pub fn set_supported_enforcement_modes<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<EnforcementMode>,

Sets the value of supported_enforcement_modes.

Example

use google_cloud_cloudsecuritycompliance_v1::model::EnforcementMode;
let x = Framework::new().set_supported_enforcement_modes([
    EnforcementMode::Preventive,
    EnforcementMode::Detective,
    EnforcementMode::Audit,
]);

Trait Implementations

impl Clone for Framework

fn clone(&self) -> Framework

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Framework

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

Formats the value using the given formatter.

impl Default for Framework

fn default() -> Framework

Returns the “default value” for a type.

impl Message for Framework

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Framework

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Framework