Struct AuthzPolicy 

#[non_exhaustive]
pub struct AuthzPolicy {
    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub description: String,
    pub labels: HashMap<String, String>,
    pub target: Option<Target>,
    pub http_rules: Vec<AuthzRule>,
    pub action: AuthzAction,
    pub custom_provider: Option<CustomProvider>,
    pub policy_profile: PolicyProfile,
    /* private fields */
}

AuthzPolicy is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.

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. Name of the AuthzPolicy resource in the following format: projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

create_time: Option<Timestamp>

Output only. The timestamp when the resource was created.

update_time: Option<Timestamp>

Output only. The timestamp when the resource was updated.

description: String

Optional. A human-readable description of the resource.

labels: HashMap<String, String>

Optional. Set of labels associated with the AuthzPolicy resource.

The format must comply with the following requirements.

target: Option<Target>

Required. Specifies the set of resources to which this policy should be applied to.

http_rules: Vec<AuthzRule>

Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules.

action: AuthzAction

Required. Can be one of ALLOW, DENY, CUSTOM.

When the action is CUSTOM, customProvider must be specified.

When the action is ALLOW, only requests matching the policy will be allowed.

When the action is DENY, only requests matching the policy will be denied.

When a request arrives, the policies are evaluated in the following order:

1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request.

2. If there are any DENY policies that match the request, the request is denied.

3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed.

4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.

custom_provider: Option<CustomProvider>

Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified.

policy_profile: PolicyProfile

Optional. Immutable. Defines the type of authorization being performed. If not specified, REQUEST_AUTHZ is applied. This field cannot be changed once AuthzPolicy is created.

Implementations

impl AuthzPolicy

pub fn new() -> Self

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

Sets the value of name.

Example

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

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = AuthzPolicy::new().set_create_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = AuthzPolicy::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = AuthzPolicy::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = AuthzPolicy::new().set_update_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = AuthzPolicy::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = AuthzPolicy::new().set_or_clear_update_time(None::<Timestamp>);

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

Sets the value of description.

Example

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

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 = AuthzPolicy::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

where T: Into<Target>,

Sets the value of target.

Example

use google_cloud_networksecurity_v1::model::authz_policy::Target;
let x = AuthzPolicy::new().set_target(Target::default()/* use setters */);

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

where T: Into<Target>,

Sets or clears the value of target.

Example

use google_cloud_networksecurity_v1::model::authz_policy::Target;
let x = AuthzPolicy::new().set_or_clear_target(Some(Target::default()/* use setters */));
let x = AuthzPolicy::new().set_or_clear_target(None::<Target>);

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

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

Sets the value of http_rules.

Example

use google_cloud_networksecurity_v1::model::authz_policy::AuthzRule;
let x = AuthzPolicy::new()
    .set_http_rules([
        AuthzRule::default()/* use setters */,
        AuthzRule::default()/* use (different) setters */,
    ]);

pub fn set_action<T: Into<AuthzAction>>(self, v: T) -> Self

Sets the value of action.

Example

use google_cloud_networksecurity_v1::model::authz_policy::AuthzAction;
let x0 = AuthzPolicy::new().set_action(AuthzAction::Allow);
let x1 = AuthzPolicy::new().set_action(AuthzAction::Deny);
let x2 = AuthzPolicy::new().set_action(AuthzAction::Custom);

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

where T: Into<CustomProvider>,

Sets the value of custom_provider.

Example

use google_cloud_networksecurity_v1::model::authz_policy::CustomProvider;
let x = AuthzPolicy::new().set_custom_provider(CustomProvider::default()/* use setters */);

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

where T: Into<CustomProvider>,

Sets or clears the value of custom_provider.

Example

use google_cloud_networksecurity_v1::model::authz_policy::CustomProvider;
let x = AuthzPolicy::new().set_or_clear_custom_provider(Some(CustomProvider::default()/* use setters */));
let x = AuthzPolicy::new().set_or_clear_custom_provider(None::<CustomProvider>);

pub fn set_policy_profile<T: Into<PolicyProfile>>(self, v: T) -> Self

Sets the value of policy_profile.

Example

use google_cloud_networksecurity_v1::model::authz_policy::PolicyProfile;
let x0 = AuthzPolicy::new().set_policy_profile(PolicyProfile::RequestAuthz);
let x1 = AuthzPolicy::new().set_policy_profile(PolicyProfile::ContentAuthz);

Trait Implementations

impl Clone for AuthzPolicy

fn clone(&self) -> AuthzPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthzPolicy

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

Formats the value using the given formatter.

impl Default for AuthzPolicy

fn default() -> AuthzPolicy

Returns the “default value” for a type.

impl Message for AuthzPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AuthzPolicy

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