target.apidocs.com.google.api.services.compute.model.Binding.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation
There is a newer version: v1-rev20250107-2.0.0
Show newest version






Binding (Compute Engine API alpha-rev20200526-1.30.9)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class Binding



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.Binding













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class Binding
extends GenericJson
Associates `members` with a `role`.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


Binding() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Binding
clone() 


Expr
getCondition()
The condition that is associated with this binding.



List<String>
getMembers()
Specifies the identities requesting access for a Cloud Platform resource.



String
getRole()
Role that is assigned to `members`.



Binding
set(String fieldName,
   Object value) 


Binding
setCondition(Expr condition)
The condition that is associated with this binding.



Binding
setMembers(List<String> members)
Specifies the identities requesting access for a Cloud Platform resource.



Binding
setRole(String role)
Role that is assigned to `members`.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Binding
public Binding()









Method Detail





getCondition
public Expr getCondition()
The condition that is associated with this binding.

 If the condition evaluates to `true`, then this binding applies to the current request.

 If the condition evaluates to `false`, then this binding does not apply to the current request.
 However, a different role binding might grant the same role to one or more of the members in
 this binding.

 To learn which resources support conditions in their IAM policies, see the [IAM
 documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Returns:
value or null for none








setCondition
public Binding setCondition(Expr condition)
The condition that is associated with this binding.

 If the condition evaluates to `true`, then this binding applies to the current request.

 If the condition evaluates to `false`, then this binding does not apply to the current request.
 However, a different role binding might grant the same role to one or more of the members in
 this binding.

 To learn which resources support conditions in their IAM policies, see the [IAM
 documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Parameters:
condition - condition or null for none








getMembers
public List<String> getMembers()
Specifies the identities requesting access for a Cloud Platform resource. `members` can have
 the following values:

 * `allUsers`: A special identifier that represents anyone who is on the internet; with or
 without a Google account.

 * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated
 with a Google account or a service account.

 * `user:{emailid}`: An email address that represents a specific Google account. For example,
 `[email protected]` .

 * `serviceAccount:{emailid}`: An email address that represents a service account. For example,
 `[email protected]`.

 * `group:{emailid}`: An email address that represents a Google group. For example,
 `[email protected]`.

 * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier)
 representing a user that has been recently deleted. For example,
 `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to
 `user:{emailid}` and the recovered user retains the role in the binding.

 * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier)
 representing a service account that has been recently deleted. For example, `my-other-
 [email protected]?uid=123456789012345678901`. If the service account is
 undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account
 retains the role in the binding.

 * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier)
 representing a Google group that has been recently deleted. For example,
 `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts
 to `group:{emailid}` and the recovered group retains the role in the binding.

 * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain.
 For example, `google.com` or `example.com`.

Returns:
value or null for none








setMembers
public Binding setMembers(List<String> members)
Specifies the identities requesting access for a Cloud Platform resource. `members` can have
 the following values:

 * `allUsers`: A special identifier that represents anyone who is on the internet; with or
 without a Google account.

 * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated
 with a Google account or a service account.

 * `user:{emailid}`: An email address that represents a specific Google account. For example,
 `[email protected]` .

 * `serviceAccount:{emailid}`: An email address that represents a service account. For example,
 `[email protected]`.

 * `group:{emailid}`: An email address that represents a Google group. For example,
 `[email protected]`.

 * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier)
 representing a user that has been recently deleted. For example,
 `[email protected]?uid=123456789012345678901`. If the user is recovered, this value reverts to
 `user:{emailid}` and the recovered user retains the role in the binding.

 * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier)
 representing a service account that has been recently deleted. For example, `my-other-
 [email protected]?uid=123456789012345678901`. If the service account is
 undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account
 retains the role in the binding.

 * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier)
 representing a Google group that has been recently deleted. For example,
 `[email protected]?uid=123456789012345678901`. If the group is recovered, this value reverts
 to `group:{emailid}` and the recovered group retains the role in the binding.

 * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain.
 For example, `google.com` or `example.com`.

Parameters:
members - members or null for none








getRole
public String getRole()
Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or
 `roles/owner`.

Returns:
value or null for none








setRole
public Binding setRole(String role)
Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or
 `roles/owner`.

Parameters:
role - role or null for none








set
public Binding set(String fieldName,
                   Object value)

Overrides:
set in class GenericJson








clone
public Binding clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.
Modifier and Type	Method and Description
`Binding`	`clone()`
`Expr`	`getCondition()` The condition that is associated with this binding.
`List<String>`	`getMembers()` Specifies the identities requesting access for a Cloud Platform resource.
`String`	`getRole()` Role that is assigned to `members`.
`Binding`	`set(String fieldName, Object value)`
`Binding`	`setCondition(Expr condition)` The condition that is associated with this binding.
`Binding`	`setMembers(List<String> members)` Specifies the identities requesting access for a Cloud Platform resource.
`Binding`	`setRole(String role)` Role that is assigned to `members`.