Package com.google.iam.v1

Interface PolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Policy, Policy.Builder
public interface PolicyOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    AuditConfig
    getAuditConfigs(int index)
    Specifies cloud audit logging configuration for this policy.
    int
    getAuditConfigsCount()
    Specifies cloud audit logging configuration for this policy.
    List<AuditConfig>
    getAuditConfigsList()
    Specifies cloud audit logging configuration for this policy.
    Binding
    getBindings(int index)
    Associates a list of `members`, or principals, with a `role`.
    int
    getBindingsCount()
    Associates a list of `members`, or principals, with a `role`.
    List<Binding>
    getBindingsList()
    Associates a list of `members`, or principals, with a `role`.
    com.google.protobuf.ByteString
    getEtag()
    `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
    int
    getVersion()
    Specifies the format of the policy.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getVersion

      int getVersion()
       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](https://cloud.google.com/iam/help/conditions/resource-policies).
      int32 version = 1 [json_name = "version"];
      Returns:
      The version.

    • getBindingsList

      List<Binding> getBindingsList()
       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`.
      repeated .google.iam.v1.Binding bindings = 4 [json_name = "bindings"];

    • getBindings

      Binding getBindings(int index)
       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`.
      repeated .google.iam.v1.Binding bindings = 4 [json_name = "bindings"];

    • getBindingsCount

      int getBindingsCount()
       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`.
      repeated .google.iam.v1.Binding bindings = 4 [json_name = "bindings"];

    • getAuditConfigsList

      List<AuditConfig> getAuditConfigsList()
       Specifies cloud audit logging configuration for this policy.
      repeated .google.iam.v1.AuditConfig audit_configs = 6 [json_name = "auditConfigs"];

    • getAuditConfigs

      AuditConfig getAuditConfigs(int index)
       Specifies cloud audit logging configuration for this policy.
      repeated .google.iam.v1.AuditConfig audit_configs = 6 [json_name = "auditConfigs"];

    • getAuditConfigsCount

      int getAuditConfigsCount()
       Specifies cloud audit logging configuration for this policy.
      repeated .google.iam.v1.AuditConfig audit_configs = 6 [json_name = "auditConfigs"];

    • getEtag

      com.google.protobuf.ByteString getEtag()
       `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.
      bytes etag = 3 [json_name = "etag"];
      Returns:
      The etag.