public final class Binding extends GeneratedMessageV3 implements BindingOrBuilder
Associates members
, or principals, with a role
.
Protobuf type google.iam.v1.Binding
Static Fields
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
Field Value
MEMBERS_FIELD_NUMBER
public static final int MEMBERS_FIELD_NUMBER
Field Value
ROLE_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Binding getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Binding.Builder newBuilder()
Returns
newBuilder(Binding prototype)
public static Binding.Builder newBuilder(Binding prototype)
Parameter
Returns
public static Binding parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Binding parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Binding parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Binding parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Binding parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Binding parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Binding parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Binding parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Binding parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Binding parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Binding parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Binding parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Binding> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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()
Returns
getMembers(int index)
public String getMembers(int index)
Specifies the principals 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, 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 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, 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 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, 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 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, 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
getParserForType()
public Parser<Binding> getParserForType()
Returns
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
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Binding.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Binding.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Binding.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions