public final class Binding extends GeneratedMessageV3 implements BindingOrBuilder
Associates members
, or principals, with a role
.
Protobuf type google.iam.v1.Binding
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
MEMBERS_FIELD_NUMBER
public static final int MEMBERS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
ROLE_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Binding getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Binding.Builder newBuilder()
newBuilder(Binding prototype)
public static Binding.Builder newBuilder(Binding prototype)
Parameter |
Name |
Description |
prototype |
Binding
|
public static Binding parseDelimitedFrom(InputStream input)
public static Binding parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Binding parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Binding parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Binding parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Binding parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Binding parseFrom(CodedInputStream input)
public static Binding parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Binding parseFrom(InputStream input)
public static Binding parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Binding parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Binding parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Binding> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
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 principals in this binding.
To learn which resources support conditions in their IAM policies, see the
IAM
documentation.
.google.type.Expr condition = 3;
Returns |
Type |
Description |
com.google.type.Expr |
The condition.
|
getConditionOrBuilder()
public ExprOrBuilder getConditionOrBuilder()
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 principals in this binding.
To learn which resources support conditions in their IAM policies, see the
IAM
documentation.
.google.type.Expr condition = 3;
Returns |
Type |
Description |
com.google.type.ExprOrBuilder |
|
getDefaultInstanceForType()
public Binding getDefaultInstanceForType()
getMembers(int index)
public String getMembers(int index)
Specifies the principals requesting access for a Google Cloud 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, alice@example.com
.
serviceAccount:{emailid}
: An email address that represents a service
account. For example, my-other-app@appspot.gserviceaccount.com
.
group:{emailid}
: An email address that represents a Google group.
For example, admins@example.com
.
deleted:user:{emailid}?uid={uniqueid}
: An email address (plus unique
identifier) representing a user that has been recently deleted. For
example, alice@example.com?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-app@appspot.gserviceaccount.com?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, admins@example.com?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
.
repeated string members = 2;
Parameter |
Name |
Description |
index |
int
The index of the element to return.
|
Returns |
Type |
Description |
String |
The members at the given index.
|
getMembersBytes(int index)
public ByteString getMembersBytes(int index)
Specifies the principals requesting access for a Google Cloud 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, alice@example.com
.
serviceAccount:{emailid}
: An email address that represents a service
account. For example, my-other-app@appspot.gserviceaccount.com
.
group:{emailid}
: An email address that represents a Google group.
For example, admins@example.com
.
deleted:user:{emailid}?uid={uniqueid}
: An email address (plus unique
identifier) representing a user that has been recently deleted. For
example, alice@example.com?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-app@appspot.gserviceaccount.com?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, admins@example.com?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
.
repeated string members = 2;
Parameter |
Name |
Description |
index |
int
The index of the value to return.
|
Returns |
Type |
Description |
ByteString |
The bytes of the members at the given index.
|
getMembersCount()
public int getMembersCount()
Specifies the principals requesting access for a Google Cloud 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, alice@example.com
.
serviceAccount:{emailid}
: An email address that represents a service
account. For example, my-other-app@appspot.gserviceaccount.com
.
group:{emailid}
: An email address that represents a Google group.
For example, admins@example.com
.
deleted:user:{emailid}?uid={uniqueid}
: An email address (plus unique
identifier) representing a user that has been recently deleted. For
example, alice@example.com?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-app@appspot.gserviceaccount.com?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, admins@example.com?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
.
repeated string members = 2;
Returns |
Type |
Description |
int |
The count of members.
|
getMembersList()
public ProtocolStringList getMembersList()
Specifies the principals requesting access for a Google Cloud 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, alice@example.com
.
serviceAccount:{emailid}
: An email address that represents a service
account. For example, my-other-app@appspot.gserviceaccount.com
.
group:{emailid}
: An email address that represents a Google group.
For example, admins@example.com
.
deleted:user:{emailid}?uid={uniqueid}
: An email address (plus unique
identifier) representing a user that has been recently deleted. For
example, alice@example.com?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-app@appspot.gserviceaccount.com?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, admins@example.com?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
.
repeated string members = 2;
getParserForType()
public Parser<Binding> getParserForType()
Overrides
getRole()
Role that is assigned to the list of members
, or principals.
For example, roles/viewer
, roles/editor
, or roles/owner
.
string role = 1;
Returns |
Type |
Description |
String |
The role.
|
getRoleBytes()
public ByteString getRoleBytes()
Role that is assigned to the list of members
, or principals.
For example, roles/viewer
, roles/editor
, or roles/owner
.
string role = 1;
Returns |
Type |
Description |
ByteString |
The bytes for role.
|
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hasCondition()
public boolean hasCondition()
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 principals in this binding.
To learn which resources support conditions in their IAM policies, see the
IAM
documentation.
.google.type.Expr condition = 3;
Returns |
Type |
Description |
boolean |
Whether the condition field is set.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Binding.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Binding.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public Binding.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides