Class Policy (1.2.12)

  public 
  
 final 
  
 class 
 Policy 
  
 extends 
  
 GeneratedMessageV3 
  
 implements 
  
 PolicyOrBuilder 
 

Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings . A binding binds one or more members to a single role . Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition , which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. 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')", } } ] } YAML Examplebindings:

  • 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') For a description of IAM and its features, see the IAM developer's guide .

Protobuf type google.iam.v1.Policy

Implements

PolicyOrBuilder

Static Fields

BINDINGS_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 BINDINGS_FIELD_NUMBER 
 
Field Value
Type Description
int

ETAG_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 ETAG_FIELD_NUMBER 
 
Field Value
Type Description
int

VERSION_FIELD_NUMBER

  public 
  
 static 
  
 final 
  
 int 
  
 VERSION_FIELD_NUMBER 
 
Field Value
Type Description
int

Static Methods

getDefaultInstance()

  public 
  
 static 
  
 Policy 
  
 getDefaultInstance 
 () 
 
Returns
Type Description
Policy

getDescriptor()

  public 
  
 static 
  
 final 
  
 Descriptors 
 . 
 Descriptor 
  
 getDescriptor 
 () 
 
Returns
Type Description
Descriptor

newBuilder()

  public 
  
 static 
  
 Policy 
 . 
 Builder 
  
 newBuilder 
 () 
 
Returns
Type Description
Policy.Builder

newBuilder(Policy prototype)

  public 
  
 static 
  
 Policy 
 . 
 Builder 
  
 newBuilder 
 ( 
 Policy 
  
 prototype 
 ) 
 
Parameter
Name Description
prototype Policy
Returns
Type Description
Policy.Builder

parseDelimitedFrom(InputStream input)

  public 
  
 static 
  
 Policy 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name Description
input InputStream
Returns
Type Description
Policy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Policy 
  
 parseDelimitedFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Policy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 ) 
 
Parameter
Name Description
data byte []
Returns
Type Description
Policy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 byte 
 [] 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name Description
data byte []
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Policy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 ) 
 
Parameter
Name Description
data ByteString
Returns
Type Description
Policy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 ByteString 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Policy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 ) 
 
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Policy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 CodedInputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Policy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 ) 
 
Parameter
Name Description
input InputStream
Returns
Type Description
Policy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 InputStream 
  
 input 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Policy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 ) 
 
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Policy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

  public 
  
 static 
  
 Policy 
  
 parseFrom 
 ( 
 ByteBuffer 
  
 data 
 , 
  
 ExtensionRegistryLite 
  
 extensionRegistry 
 ) 
 
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Policy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

  public 
  
 static 
  
 Parser<Policy> 
  
 parser 
 () 
 
Returns
Type Description
Parser < Policy >

Methods

equals(Object obj)

  public 
  
 boolean 
  
 equals 
 ( 
 Object 
  
 obj 
 ) 
 
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBindings(int index)

  public 
  
 Binding 
  
 getBindings 
 ( 
 int 
  
 index 
 ) 
 

Associates a list of members to a role . Optionally may specify a condition that determines when binding is in effect. bindings with no members will result in an error.

repeated .google.iam.v1.Binding bindings = 4;

Parameter
Name Description
index int
Returns
Type Description
Binding

getBindingsCount()

  public 
  
 int 
  
 getBindingsCount 
 () 
 

Associates a list of members to a role . Optionally may specify a condition that determines when binding is in effect. bindings with no members will result in an error.

repeated .google.iam.v1.Binding bindings = 4;

Returns
Type Description
int

getBindingsList()

  public 
  
 List<Binding> 
  
 getBindingsList 
 () 
 

Associates a list of members to a role . Optionally may specify a condition that determines when binding is in effect. bindings with no members will result in an error.

repeated .google.iam.v1.Binding bindings = 4;

Returns
Type Description
List < Binding >

getBindingsOrBuilder(int index)

  public 
  
 BindingOrBuilder 
  
 getBindingsOrBuilder 
 ( 
 int 
  
 index 
 ) 
 

Associates a list of members to a role . Optionally may specify a condition that determines when binding is in effect. bindings with no members will result in an error.

repeated .google.iam.v1.Binding bindings = 4;

Parameter
Name Description
index int
Returns
Type Description
BindingOrBuilder

getBindingsOrBuilderList()

  public 
  
 List 
< ? 
  
 extends 
  
 BindingOrBuilder 
>  
 getBindingsOrBuilderList 
 () 
 

Associates a list of members to a role . Optionally may specify a condition that determines when binding is in effect. bindings with no members will result in an error.

repeated .google.iam.v1.Binding bindings = 4;

Returns
Type Description
List < ? extends com.google.iam.v1.BindingOrBuilder >

getDefaultInstanceForType()

  public 
  
 Policy 
  
 getDefaultInstanceForType 
 () 
 
Returns
Type Description
Policy

getEtag()

  public 
  
 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. If no etag is provided in the call to setIamPolicy , then the existing policy is overwritten. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy.

bytes etag = 3;

Returns
Type Description
ByteString

The etag.

getParserForType()

  public 
  
 Parser<Policy> 
  
 getParserForType 
 () 
 
Returns
Type Description
Parser < Policy >
Overrides

getSerializedSize()

  public 
  
 int 
  
 getSerializedSize 
 () 
 
Returns
Type Description
int
Overrides

getUnknownFields()

  public 
  
 final 
  
 UnknownFieldSet 
  
 getUnknownFields 
 () 
 
Returns
Type Description
UnknownFieldSet
Overrides

getVersion()

  public 
  
 int 
  
 getVersion 
 () 
 

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to setIamPolicy , version compliance checks against the stored policy is skipped.

int32 version = 1;

Returns
Type Description
int

The version.

hashCode()

  public 
  
 int 
  
 hashCode 
 () 
 
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

  protected 
  
 GeneratedMessageV3 
 . 
 FieldAccessorTable 
  
 internalGetFieldAccessorTable 
 () 
 
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

  public 
  
 final 
  
 boolean 
  
 isInitialized 
 () 
 
Returns
Type Description
boolean
Overrides

newBuilderForType()

  public 
  
 Policy 
 . 
 Builder 
  
 newBuilderForType 
 () 
 
Returns
Type Description
Policy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

  protected 
  
 Policy 
 . 
 Builder 
  
 newBuilderForType 
 ( 
 GeneratedMessageV3 
 . 
 BuilderParent 
  
 parent 
 ) 
 
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Policy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

  protected 
  
 Object 
  
 newInstance 
 ( 
 GeneratedMessageV3 
 . 
 UnusedPrivateParameter 
  
 unused 
 ) 
 
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

  public 
  
 Policy 
 . 
 Builder 
  
 toBuilder 
 () 
 
Returns
Type Description
Policy.Builder

writeTo(CodedOutputStream output)

  public 
  
 void 
  
 writeTo 
 ( 
 CodedOutputStream 
  
 output 
 ) 
 
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException
Design a Mobile Site
View Site in Mobile | Classic
Share by: