Struct SecurityPolicy 

#[non_exhaustive]
pub struct SecurityPolicy {

    pub adaptive_protection_config: Option<SecurityPolicyAdaptiveProtectionConfig>,
    pub advanced_options_config: Option<SecurityPolicyAdvancedOptionsConfig>,
    pub associations: Vec<SecurityPolicyAssociation>,
    pub creation_timestamp: Option<String>,
    pub ddos_protection_config: Option<SecurityPolicyDdosProtectionConfig>,
    pub description: Option<String>,
    pub fingerprint: Option<Bytes>,
    pub id: Option<u64>,
    pub kind: Option<String>,
    pub label_fingerprint: Option<Bytes>,
    pub labels: HashMap<String, String>,
    pub name: Option<String>,
    pub parent: Option<String>,
    pub recaptcha_options_config: Option<SecurityPolicyRecaptchaOptionsConfig>,
    pub region: Option<String>,
    pub rules: Vec<SecurityPolicyRule>,
    pub self_link: Option<String>,
    pub short_name: Option<String>,
    pub type: Option<Type>,
    pub user_defined_fields: Vec<SecurityPolicyUserDefinedField>,
    /* private fields */
}

Available on crate features organization-security-policies or region-security-policies or security-policies only.

Represents a Google Cloud Armor security policy resource.

Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.

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.

adaptive_protection_config: Option<SecurityPolicyAdaptiveProtectionConfig>

advanced_options_config: Option<SecurityPolicyAdvancedOptionsConfig>

associations: Vec<SecurityPolicyAssociation>

A list of associations that belong to this policy.

creation_timestamp: Option<String>

Output only. [Output Only] Creation timestamp inRFC3339 text format.

ddos_protection_config: Option<SecurityPolicyDdosProtectionConfig>

description: Option<String>

An optional description of this resource. Provide this property when you create the resource.

fingerprint: Option<Bytes>

Specifies a fingerprint for this resource, which is essentially a hash of the metadata’s contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error412 conditionNotMet.

To see the latest fingerprint, make get() request to the security policy.

id: Option<u64>

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

kind: Option<String>

Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyfor security policies

label_fingerprint: Option<Bytes>

A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.

To see the latest fingerprint, make get() request to the security policy.

labels: HashMap<String, String>

Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.

name: Option<String>

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

parent: Option<String>

Output only. [Output Only] The parent of the security policy.

recaptcha_options_config: Option<SecurityPolicyRecaptchaOptionsConfig>

region: Option<String>

Output only. [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.

rules: Vec<SecurityPolicyRule>

A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match “” for srcIpRanges and for the networkMatch condition every field must be either match “” or not set). If no rules are provided when creating a security policy, a default rule with action “allow” will be added.

self_link: Option<String>

Output only. [Output Only] Server-defined URL for the resource.

short_name: Option<String>

User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is CLOUD_ARMOR. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

type: Option<Type>

The type indicates the intended use of the security policy.

• CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers.

• CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google’s cache.

• CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application.

• CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application.

This field can be set only at resource creation time.

user_defined_fields: Vec<SecurityPolicyUserDefinedField>

Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields.

Example:

userDefinedFields:

• name: “ipv4_fragment_offset” base: IPV4 offset: 6 size: 2 mask: “0x1fff”

Implementations

impl SecurityPolicy

pub fn new() -> Self

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

where T: Into<SecurityPolicyAdaptiveProtectionConfig>,

Sets the value of adaptive_protection_config.

Example

use google_cloud_compute_v1::model::SecurityPolicyAdaptiveProtectionConfig;
let x = SecurityPolicy::new().set_adaptive_protection_config(SecurityPolicyAdaptiveProtectionConfig::default()/* use setters */);

pub fn set_or_clear_adaptive_protection_config<T>(self, v: Option<T>) -> Self

where T: Into<SecurityPolicyAdaptiveProtectionConfig>,

Sets or clears the value of adaptive_protection_config.

Example

use google_cloud_compute_v1::model::SecurityPolicyAdaptiveProtectionConfig;
let x = SecurityPolicy::new().set_or_clear_adaptive_protection_config(Some(SecurityPolicyAdaptiveProtectionConfig::default()/* use setters */));
let x = SecurityPolicy::new().set_or_clear_adaptive_protection_config(None::<SecurityPolicyAdaptiveProtectionConfig>);

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

where T: Into<SecurityPolicyAdvancedOptionsConfig>,

Sets the value of advanced_options_config.

Example

use google_cloud_compute_v1::model::SecurityPolicyAdvancedOptionsConfig;
let x = SecurityPolicy::new().set_advanced_options_config(SecurityPolicyAdvancedOptionsConfig::default()/* use setters */);

pub fn set_or_clear_advanced_options_config<T>(self, v: Option<T>) -> Self

where T: Into<SecurityPolicyAdvancedOptionsConfig>,

Sets or clears the value of advanced_options_config.

Example

use google_cloud_compute_v1::model::SecurityPolicyAdvancedOptionsConfig;
let x = SecurityPolicy::new().set_or_clear_advanced_options_config(Some(SecurityPolicyAdvancedOptionsConfig::default()/* use setters */));
let x = SecurityPolicy::new().set_or_clear_advanced_options_config(None::<SecurityPolicyAdvancedOptionsConfig>);

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

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

Sets the value of associations.

Example

use google_cloud_compute_v1::model::SecurityPolicyAssociation;
let x = SecurityPolicy::new()
    .set_associations([
        SecurityPolicyAssociation::default()/* use setters */,
        SecurityPolicyAssociation::default()/* use (different) setters */,
    ]);

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

where T: Into<String>,

Sets the value of creation_timestamp.

Example

let x = SecurityPolicy::new().set_creation_timestamp("example");

pub fn set_or_clear_creation_timestamp<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of creation_timestamp.

Example

let x = SecurityPolicy::new().set_or_clear_creation_timestamp(Some("example"));
let x = SecurityPolicy::new().set_or_clear_creation_timestamp(None::<String>);

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

where T: Into<SecurityPolicyDdosProtectionConfig>,

Sets the value of ddos_protection_config.

Example

use google_cloud_compute_v1::model::SecurityPolicyDdosProtectionConfig;
let x = SecurityPolicy::new().set_ddos_protection_config(SecurityPolicyDdosProtectionConfig::default()/* use setters */);

pub fn set_or_clear_ddos_protection_config<T>(self, v: Option<T>) -> Self

where T: Into<SecurityPolicyDdosProtectionConfig>,

Sets or clears the value of ddos_protection_config.

Example

use google_cloud_compute_v1::model::SecurityPolicyDdosProtectionConfig;
let x = SecurityPolicy::new().set_or_clear_ddos_protection_config(Some(SecurityPolicyDdosProtectionConfig::default()/* use setters */));
let x = SecurityPolicy::new().set_or_clear_ddos_protection_config(None::<SecurityPolicyDdosProtectionConfig>);

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

where T: Into<String>,

Sets the value of description.

Example

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

pub fn set_or_clear_description<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of description.

Example

let x = SecurityPolicy::new().set_or_clear_description(Some("example"));
let x = SecurityPolicy::new().set_or_clear_description(None::<String>);

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

where T: Into<Bytes>,

Sets the value of fingerprint.

Example

let x = SecurityPolicy::new().set_fingerprint(bytes::Bytes::from_static(b"example"));

pub fn set_or_clear_fingerprint<T>(self, v: Option<T>) -> Self

where T: Into<Bytes>,

Sets or clears the value of fingerprint.

Example

let x = SecurityPolicy::new().set_or_clear_fingerprint(Some(bytes::Bytes::from_static(b"example")));
let x = SecurityPolicy::new().set_or_clear_fingerprint(None::<bytes::Bytes>);

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

where T: Into<u64>,

Sets the value of id.

Example

let x = SecurityPolicy::new().set_id(42_u32);

pub fn set_or_clear_id<T>(self, v: Option<T>) -> Self

where T: Into<u64>,

Sets or clears the value of id.

Example

let x = SecurityPolicy::new().set_or_clear_id(Some(42_u32));
let x = SecurityPolicy::new().set_or_clear_id(None::<u32>);

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

where T: Into<String>,

Sets the value of kind.

Example

let x = SecurityPolicy::new().set_kind("example");

pub fn set_or_clear_kind<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of kind.

Example

let x = SecurityPolicy::new().set_or_clear_kind(Some("example"));
let x = SecurityPolicy::new().set_or_clear_kind(None::<String>);

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

where T: Into<Bytes>,

Sets the value of label_fingerprint.

Example

let x = SecurityPolicy::new().set_label_fingerprint(bytes::Bytes::from_static(b"example"));

pub fn set_or_clear_label_fingerprint<T>(self, v: Option<T>) -> Self

where T: Into<Bytes>,

Sets or clears the value of label_fingerprint.

Example

let x = SecurityPolicy::new().set_or_clear_label_fingerprint(Some(bytes::Bytes::from_static(b"example")));
let x = SecurityPolicy::new().set_or_clear_label_fingerprint(None::<bytes::Bytes>);

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

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

Example

let x = SecurityPolicy::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

where T: Into<String>,

Sets the value of name.

Example

let x = SecurityPolicy::new().set_name("example");

pub fn set_or_clear_name<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of name.

Example

let x = SecurityPolicy::new().set_or_clear_name(Some("example"));
let x = SecurityPolicy::new().set_or_clear_name(None::<String>);

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

where T: Into<String>,

Sets the value of parent.

Example

let x = SecurityPolicy::new().set_parent("example");

pub fn set_or_clear_parent<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of parent.

Example

let x = SecurityPolicy::new().set_or_clear_parent(Some("example"));
let x = SecurityPolicy::new().set_or_clear_parent(None::<String>);

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

where T: Into<SecurityPolicyRecaptchaOptionsConfig>,

Sets the value of recaptcha_options_config.

Example

use google_cloud_compute_v1::model::SecurityPolicyRecaptchaOptionsConfig;
let x = SecurityPolicy::new().set_recaptcha_options_config(SecurityPolicyRecaptchaOptionsConfig::default()/* use setters */);

pub fn set_or_clear_recaptcha_options_config<T>(self, v: Option<T>) -> Self

where T: Into<SecurityPolicyRecaptchaOptionsConfig>,

Sets or clears the value of recaptcha_options_config.

Example

use google_cloud_compute_v1::model::SecurityPolicyRecaptchaOptionsConfig;
let x = SecurityPolicy::new().set_or_clear_recaptcha_options_config(Some(SecurityPolicyRecaptchaOptionsConfig::default()/* use setters */));
let x = SecurityPolicy::new().set_or_clear_recaptcha_options_config(None::<SecurityPolicyRecaptchaOptionsConfig>);

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

where T: Into<String>,

Sets the value of region.

Example

let x = SecurityPolicy::new().set_region("example");

pub fn set_or_clear_region<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of region.

Example

let x = SecurityPolicy::new().set_or_clear_region(Some("example"));
let x = SecurityPolicy::new().set_or_clear_region(None::<String>);

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

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

Sets the value of rules.

Example

use google_cloud_compute_v1::model::SecurityPolicyRule;
let x = SecurityPolicy::new()
    .set_rules([
        SecurityPolicyRule::default()/* use setters */,
        SecurityPolicyRule::default()/* use (different) setters */,
    ]);

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

where T: Into<String>,

Sets the value of self_link.

Example

let x = SecurityPolicy::new().set_self_link("example");

pub fn set_or_clear_self_link<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of self_link.

Example

let x = SecurityPolicy::new().set_or_clear_self_link(Some("example"));
let x = SecurityPolicy::new().set_or_clear_self_link(None::<String>);

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

where T: Into<String>,

Sets the value of short_name.

Example

let x = SecurityPolicy::new().set_short_name("example");

pub fn set_or_clear_short_name<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of short_name.

Example

let x = SecurityPolicy::new().set_or_clear_short_name(Some("example"));
let x = SecurityPolicy::new().set_or_clear_short_name(None::<String>);

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

where T: Into<Type>,

Sets the value of r#type.

Example

use google_cloud_compute_v1::model::security_policy::Type;
let x0 = SecurityPolicy::new().set_type(Type::CloudArmorEdge);
let x1 = SecurityPolicy::new().set_type(Type::CloudArmorNetwork);

pub fn set_or_clear_type<T>(self, v: Option<T>) -> Self

where T: Into<Type>,

Sets or clears the value of r#type.

Example

use google_cloud_compute_v1::model::security_policy::Type;
let x0 = SecurityPolicy::new().set_or_clear_type(Some(Type::CloudArmorEdge));
let x1 = SecurityPolicy::new().set_or_clear_type(Some(Type::CloudArmorNetwork));
let x_none = SecurityPolicy::new().set_or_clear_type(None::<Type>);

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

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

Sets the value of user_defined_fields.

Example

use google_cloud_compute_v1::model::SecurityPolicyUserDefinedField;
let x = SecurityPolicy::new()
    .set_user_defined_fields([
        SecurityPolicyUserDefinedField::default()/* use setters */,
        SecurityPolicyUserDefinedField::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for SecurityPolicy

fn clone(&self) -> SecurityPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityPolicy

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

Formats the value using the given formatter.

impl Default for SecurityPolicy

fn default() -> SecurityPolicy

Returns the “default value” for a type.

impl Message for SecurityPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SecurityPolicy

fn eq(&self, other: &SecurityPolicy) -> 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 SecurityPolicy