public static final class Explanations.BindingExplanation extends GeneratedMessageV3 implements Explanations.BindingExplanationOrBuilder
Details about how a binding in a policy affects a member's ability to use a
permission.
Protobuf type google.cloud.policytroubleshooter.v1.BindingExplanation
Fields
ACCESS_FIELD_NUMBER
public static final int ACCESS_FIELD_NUMBER
Field Value
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
Field Value
MEMBERSHIPS_FIELD_NUMBER
public static final int MEMBERSHIPS_FIELD_NUMBER
Field Value
RELEVANCE_FIELD_NUMBER
public static final int RELEVANCE_FIELD_NUMBER
Field Value
ROLE_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER
Field Value
ROLE_PERMISSION_FIELD_NUMBER
public static final int ROLE_PERMISSION_FIELD_NUMBER
Field Value
ROLE_PERMISSION_RELEVANCE_FIELD_NUMBER
public static final int ROLE_PERMISSION_RELEVANCE_FIELD_NUMBER
Field Value
Methods
containsMemberships(String key)
public boolean containsMemberships(String key)
Indicates whether each member in the binding includes the member specified
in the request, either directly or indirectly. Each key identifies a member
in the binding, and each value indicates whether the member in the binding
includes the member in the request.
For example, suppose that a binding includes the following members:
user:alice@example.comgroup:product-eng@example.com
You want to troubleshoot access for user:bob@example.com. This user is a
member of the group group:product-eng@example.com.
For the first member in the binding, the key is user:alice@example.com,
and the membership field in the value is set to
MEMBERSHIP_NOT_INCLUDED.
For the second member in the binding, the key is
group:product-eng@example.com, and the membership field in the value is
set to MEMBERSHIP_INCLUDED.
map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAccess()
public Explanations.AccessState getAccess()
Required. Indicates whether this binding provides the specified permission to the
specified member for the specified resource.
This field does not indicate whether the member actually has the
permission for the resource. There might be another binding that overrides
this binding. To determine whether the member actually has the permission,
use the access field in the
TroubleshootIamPolicyResponse.
.google.cloud.policytroubleshooter.v1.AccessState access = 1 [(.google.api.field_behavior) = REQUIRED];
getAccessValue()
public int getAccessValue()
Required. Indicates whether this binding provides the specified permission to the
specified member for the specified resource.
This field does not indicate whether the member actually has the
permission for the resource. There might be another binding that overrides
this binding. To determine whether the member actually has the permission,
use the access field in the
TroubleshootIamPolicyResponse.
.google.cloud.policytroubleshooter.v1.AccessState access = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| int | The enum numeric value on the wire for access.
|
getCondition()
public Expr getCondition()
Returns
| Type | Description |
| com.google.type.Expr | The condition.
|
getConditionOrBuilder()
public ExprOrBuilder getConditionOrBuilder()
Returns
| Type | Description |
| com.google.type.ExprOrBuilder | |
getDefaultInstance()
public static Explanations.BindingExplanation getDefaultInstance()
Returns
getDefaultInstanceForType()
public Explanations.BindingExplanation getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getMemberships()
public Map<String,Explanations.BindingExplanation.AnnotatedMembership> getMemberships()
Returns
getMembershipsCount()
public int getMembershipsCount()
Indicates whether each member in the binding includes the member specified
in the request, either directly or indirectly. Each key identifies a member
in the binding, and each value indicates whether the member in the binding
includes the member in the request.
For example, suppose that a binding includes the following members:
user:alice@example.comgroup:product-eng@example.com
You want to troubleshoot access for user:bob@example.com. This user is a
member of the group group:product-eng@example.com.
For the first member in the binding, the key is user:alice@example.com,
and the membership field in the value is set to
MEMBERSHIP_NOT_INCLUDED.
For the second member in the binding, the key is
group:product-eng@example.com, and the membership field in the value is
set to MEMBERSHIP_INCLUDED.
map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
getMembershipsMap()
public Map<String,Explanations.BindingExplanation.AnnotatedMembership> getMembershipsMap()
Indicates whether each member in the binding includes the member specified
in the request, either directly or indirectly. Each key identifies a member
in the binding, and each value indicates whether the member in the binding
includes the member in the request.
For example, suppose that a binding includes the following members:
user:alice@example.comgroup:product-eng@example.com
You want to troubleshoot access for user:bob@example.com. This user is a
member of the group group:product-eng@example.com.
For the first member in the binding, the key is user:alice@example.com,
and the membership field in the value is set to
MEMBERSHIP_NOT_INCLUDED.
For the second member in the binding, the key is
group:product-eng@example.com, and the membership field in the value is
set to MEMBERSHIP_INCLUDED.
map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
getMembershipsOrDefault(String key, Explanations.BindingExplanation.AnnotatedMembership defaultValue)
public Explanations.BindingExplanation.AnnotatedMembership getMembershipsOrDefault(String key, Explanations.BindingExplanation.AnnotatedMembership defaultValue)
Indicates whether each member in the binding includes the member specified
in the request, either directly or indirectly. Each key identifies a member
in the binding, and each value indicates whether the member in the binding
includes the member in the request.
For example, suppose that a binding includes the following members:
user:alice@example.comgroup:product-eng@example.com
You want to troubleshoot access for user:bob@example.com. This user is a
member of the group group:product-eng@example.com.
For the first member in the binding, the key is user:alice@example.com,
and the membership field in the value is set to
MEMBERSHIP_NOT_INCLUDED.
For the second member in the binding, the key is
group:product-eng@example.com, and the membership field in the value is
set to MEMBERSHIP_INCLUDED.
map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
getMembershipsOrThrow(String key)
public Explanations.BindingExplanation.AnnotatedMembership getMembershipsOrThrow(String key)
Indicates whether each member in the binding includes the member specified
in the request, either directly or indirectly. Each key identifies a member
in the binding, and each value indicates whether the member in the binding
includes the member in the request.
For example, suppose that a binding includes the following members:
user:alice@example.comgroup:product-eng@example.com
You want to troubleshoot access for user:bob@example.com. This user is a
member of the group group:product-eng@example.com.
For the first member in the binding, the key is user:alice@example.com,
and the membership field in the value is set to
MEMBERSHIP_NOT_INCLUDED.
For the second member in the binding, the key is
group:product-eng@example.com, and the membership field in the value is
set to MEMBERSHIP_INCLUDED.
map<string, .google.cloud.policytroubleshooter.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
getParserForType()
public Parser<Explanations.BindingExplanation> getParserForType()
Returns
Overrides
getRelevance()
public Explanations.HeuristicRelevance getRelevance()
The relevance of this binding to the overall determination for the entire
policy.
.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 6;
getRelevanceValue()
public int getRelevanceValue()
The relevance of this binding to the overall determination for the entire
policy.
.google.cloud.policytroubleshooter.v1.HeuristicRelevance relevance = 6;
| Type | Description |
| int | The enum numeric value on the wire for relevance.
|
getRole()
Returns
| Type | Description |
| String | The role.
|
getRoleBytes()
public ByteString getRoleBytes()
Returns
getRolePermission()
public Explanations.BindingExplanation.RolePermission getRolePermission()
Indicates whether the role granted by this binding contains the specified
permission.
.google.cloud.policytroubleshooter.v1.BindingExplanation.RolePermission role_permission = 3;
getRolePermissionRelevance()
public Explanations.HeuristicRelevance getRolePermissionRelevance()
The relevance of the permission's existence, or nonexistence, in the role
to the overall determination for the entire policy.
.google.cloud.policytroubleshooter.v1.HeuristicRelevance role_permission_relevance = 4;
getRolePermissionRelevanceValue()
public int getRolePermissionRelevanceValue()
The relevance of the permission's existence, or nonexistence, in the role
to the overall determination for the entire policy.
.google.cloud.policytroubleshooter.v1.HeuristicRelevance role_permission_relevance = 4;
| Type | Description |
| int | The enum numeric value on the wire for rolePermissionRelevance.
|
getRolePermissionValue()
public int getRolePermissionValue()
Indicates whether the role granted by this binding contains the specified
permission.
.google.cloud.policytroubleshooter.v1.BindingExplanation.RolePermission role_permission = 3;
| Type | Description |
| int | The enum numeric value on the wire for rolePermission.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCondition()
public boolean hasCondition()
Returns
| Type | Description |
| boolean | Whether the condition field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Explanations.BindingExplanation.Builder newBuilder()
Returns
newBuilder(Explanations.BindingExplanation prototype)
public static Explanations.BindingExplanation.Builder newBuilder(Explanations.BindingExplanation prototype)
Parameter
Returns
newBuilderForType()
public Explanations.BindingExplanation.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Explanations.BindingExplanation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Explanations.BindingExplanation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Explanations.BindingExplanation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Explanations.BindingExplanation parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Explanations.BindingExplanation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Explanations.BindingExplanation parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Explanations.BindingExplanation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Explanations.BindingExplanation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Explanations.BindingExplanation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Explanations.BindingExplanation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Explanations.BindingExplanation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Explanations.BindingExplanation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Explanations.BindingExplanation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Explanations.BindingExplanation> parser()
Returns
toBuilder()
public Explanations.BindingExplanation.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
