Struct Policy 

#[non_exhaustive]
pub struct Policy {
    pub audit_configs: Vec<AuditConfig>,
    pub bindings: Vec<Binding>,
    pub etag: Option<Bytes>,
    pub version: Option<i32>,
    /* private fields */
}

Available on crate features backend-buckets or backend-services or disks or firewall-policies or images or instance-templates or instances or instant-snapshots or interconnect-attachment-groups or interconnect-groups or licenses or machine-images or network-attachments or network-firewall-policies or node-groups or node-templates or region-backend-services or region-disks or region-instant-snapshots or region-network-firewall-policies or reservation-blocks or reservation-sub-blocks or reservations or resource-policies or service-attachments or snapshots or storage-pools or subnetworks only.

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.

For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation.

JSON example:

    {
      "bindings": [
        {
          "role": "roles/resourcemanager.organizationAdmin",
          "members": [
            "user:mike@example.com",
            "group:admins@example.com",
            "domain:google.com",
            "serviceAccount:my-project-id@appspot.gserviceaccount.com"
          ]
        },
        {
          "role": "roles/resourcemanager.organizationViewer",
          "members": [
            "user:eve@example.com"
          ],
          "condition": {
            "title": "expirable access",
            "description": "Does not grant access after Sep 2020",
            "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
          }
        }
      ],
      "etag": "BwWWja0YfJA=",
      "version": 3
    }

YAML example:

    bindings:
    - members:
      - user:mike@example.com
      - group:admins@example.com
      - domain:google.com
      - serviceAccount:my-project-id@appspot.gserviceaccount.com
      role: roles/resourcemanager.organizationAdmin
    - members:
      - user:eve@example.com
      role: roles/resourcemanager.organizationViewer
      condition:
        title: expirable access
        description: Does not grant access after Sep 2020
        expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
    etag: BwWWja0YfJA=
    version: 3

For a description of IAM and its features, see the IAM documentation.

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.

audit_configs: Vec<AuditConfig>

Specifies cloud audit logging configuration for this policy.

bindings: Vec<Binding>

Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.

The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

etag: Option<Bytes>

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.

Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

version: Option<i32>

Specifies the format of the policy.

Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.

Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

• Getting a policy that includes a conditional role binding
• Adding a conditional role binding to a policy
• Changing a conditional role binding in a policy
• Removing any role binding, with or without a condition, from a policy that includes conditions

Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

To learn which resources support conditions in their IAM policies, see the IAM documentation.

Implementations

impl Policy

pub fn new() -> Self

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

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

Sets the value of audit_configs.

Example

use google_cloud_compute_v1::model::AuditConfig;
let x = Policy::new()
    .set_audit_configs([
        AuditConfig::default()/* use setters */,
        AuditConfig::default()/* use (different) setters */,
    ]);

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

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

Sets the value of bindings.

Example

use google_cloud_compute_v1::model::Binding;
let x = Policy::new()
    .set_bindings([
        Binding::default()/* use setters */,
        Binding::default()/* use (different) setters */,
    ]);

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

where T: Into<Bytes>,

Sets the value of etag.

Example

let x = Policy::new().set_etag(bytes::Bytes::from_static(b"example"));

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

where T: Into<Bytes>,

Sets or clears the value of etag.

Example

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

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

where T: Into<i32>,

Sets the value of version.

Example

let x = Policy::new().set_version(42);

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

where T: Into<i32>,

Sets or clears the value of version.

Example

let x = Policy::new().set_or_clear_version(Some(42));
let x = Policy::new().set_or_clear_version(None::<i32>);

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl Default for Policy

fn default() -> Policy

Returns the “default value” for a type.

impl Message for Policy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Policy

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