public final class BindingExplanation extends com.google.protobuf.GeneratedMessageV3 implements BindingExplanationOrBuilder
Details about how a binding in a policy affects a principal's ability to use a permission.Protobuf type
google.cloud.policysimulator.v1.BindingExplanation| Modifier and Type | Class and Description |
|---|---|
static class |
BindingExplanation.AnnotatedMembership
Details about whether the binding includes the principal.
|
static interface |
BindingExplanation.AnnotatedMembershipOrBuilder |
static class |
BindingExplanation.Builder
Details about how a binding in a policy affects a principal's ability to use
a permission.
|
static class |
BindingExplanation.Membership
Whether the binding includes the principal.
|
static class |
BindingExplanation.RolePermission
Whether a role includes a specific permission.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ACCESS_FIELD_NUMBER |
static int |
CONDITION_FIELD_NUMBER |
static int |
MEMBERSHIPS_FIELD_NUMBER |
static int |
RELEVANCE_FIELD_NUMBER |
static int |
ROLE_FIELD_NUMBER |
static int |
ROLE_PERMISSION_FIELD_NUMBER |
static int |
ROLE_PERMISSION_RELEVANCE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsMemberships(String key)
Indicates whether each principal in the binding includes the principal
specified in the request, either directly or indirectly.
|
boolean |
equals(Object obj) |
AccessState |
getAccess()
Required.
|
int |
getAccessValue()
Required.
|
com.google.type.Expr |
getCondition()
A condition expression that prevents this binding from granting access
unless the expression evaluates to `true`.
|
com.google.type.ExprOrBuilder |
getConditionOrBuilder()
A condition expression that prevents this binding from granting access
unless the expression evaluates to `true`.
|
static BindingExplanation |
getDefaultInstance() |
BindingExplanation |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Map<String,BindingExplanation.AnnotatedMembership> |
getMemberships()
Deprecated.
|
int |
getMembershipsCount()
Indicates whether each principal in the binding includes the principal
specified in the request, either directly or indirectly.
|
Map<String,BindingExplanation.AnnotatedMembership> |
getMembershipsMap()
Indicates whether each principal in the binding includes the principal
specified in the request, either directly or indirectly.
|
BindingExplanation.AnnotatedMembership |
getMembershipsOrDefault(String key,
BindingExplanation.AnnotatedMembership defaultValue)
Indicates whether each principal in the binding includes the principal
specified in the request, either directly or indirectly.
|
BindingExplanation.AnnotatedMembership |
getMembershipsOrThrow(String key)
Indicates whether each principal in the binding includes the principal
specified in the request, either directly or indirectly.
|
com.google.protobuf.Parser<BindingExplanation> |
getParserForType() |
HeuristicRelevance |
getRelevance()
The relevance of this binding to the overall determination for the entire
policy.
|
int |
getRelevanceValue()
The relevance of this binding to the overall determination for the entire
policy.
|
String |
getRole()
The role that this binding grants.
|
com.google.protobuf.ByteString |
getRoleBytes()
The role that this binding grants.
|
BindingExplanation.RolePermission |
getRolePermission()
Indicates whether the role granted by this binding contains the specified
permission.
|
HeuristicRelevance |
getRolePermissionRelevance()
The relevance of the permission's existence, or nonexistence, in the role
to the overall determination for the entire policy.
|
int |
getRolePermissionRelevanceValue()
The relevance of the permission's existence, or nonexistence, in the role
to the overall determination for the entire policy.
|
int |
getRolePermissionValue()
Indicates whether the role granted by this binding contains the specified
permission.
|
int |
getSerializedSize() |
boolean |
hasCondition()
A condition expression that prevents this binding from granting access
unless the expression evaluates to `true`.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static BindingExplanation.Builder |
newBuilder() |
static BindingExplanation.Builder |
newBuilder(BindingExplanation prototype) |
BindingExplanation.Builder |
newBuilderForType() |
protected BindingExplanation.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static BindingExplanation |
parseDelimitedFrom(InputStream input) |
static BindingExplanation |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BindingExplanation |
parseFrom(byte[] data) |
static BindingExplanation |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BindingExplanation |
parseFrom(ByteBuffer data) |
static BindingExplanation |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BindingExplanation |
parseFrom(com.google.protobuf.ByteString data) |
static BindingExplanation |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BindingExplanation |
parseFrom(com.google.protobuf.CodedInputStream input) |
static BindingExplanation |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BindingExplanation |
parseFrom(InputStream input) |
static BindingExplanation |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<BindingExplanation> |
parser() |
BindingExplanation.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int ACCESS_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER
public static final int ROLE_PERMISSION_FIELD_NUMBER
public static final int ROLE_PERMISSION_RELEVANCE_FIELD_NUMBER
public static final int MEMBERSHIPS_FIELD_NUMBER
public static final int RELEVANCE_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public int getAccessValue()
Required. Indicates whether _this binding_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another binding that overrides this binding. To determine whether the principal actually has the permission, use the `access` field in the [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].
.google.cloud.policysimulator.v1.AccessState access = 1 [(.google.api.field_behavior) = REQUIRED];
getAccessValue in interface BindingExplanationOrBuilderpublic AccessState getAccess()
Required. Indicates whether _this binding_ provides the specified permission to the specified principal for the specified resource. This field does _not_ indicate whether the principal actually has the permission for the resource. There might be another binding that overrides this binding. To determine whether the principal actually has the permission, use the `access` field in the [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].
.google.cloud.policysimulator.v1.AccessState access = 1 [(.google.api.field_behavior) = REQUIRED];
getAccess in interface BindingExplanationOrBuilderpublic String getRole()
The role that this binding grants. For example, `roles/compute.serviceAgent`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
string role = 2;getRole in interface BindingExplanationOrBuilderpublic com.google.protobuf.ByteString getRoleBytes()
The role that this binding grants. For example, `roles/compute.serviceAgent`. For a complete list of predefined IAM roles, as well as the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.
string role = 2;getRoleBytes in interface BindingExplanationOrBuilderpublic int getRolePermissionValue()
Indicates whether the role granted by this binding contains the specified permission.
.google.cloud.policysimulator.v1.BindingExplanation.RolePermission role_permission = 3;
getRolePermissionValue in interface BindingExplanationOrBuilderpublic BindingExplanation.RolePermission getRolePermission()
Indicates whether the role granted by this binding contains the specified permission.
.google.cloud.policysimulator.v1.BindingExplanation.RolePermission role_permission = 3;
getRolePermission in interface BindingExplanationOrBuilderpublic int getRolePermissionRelevanceValue()
The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.
.google.cloud.policysimulator.v1.HeuristicRelevance role_permission_relevance = 4;getRolePermissionRelevanceValue in interface BindingExplanationOrBuilderpublic HeuristicRelevance getRolePermissionRelevance()
The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.
.google.cloud.policysimulator.v1.HeuristicRelevance role_permission_relevance = 4;getRolePermissionRelevance in interface BindingExplanationOrBuilderpublic int getMembershipsCount()
BindingExplanationOrBuilderIndicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request. For example, suppose that a binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` The principal in the replayed access tuple is `user:bob@example.com`. This user is a principal of the group `group:product-eng@example.com`. For the first principal 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 principal 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.policysimulator.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
getMembershipsCount in interface BindingExplanationOrBuilderpublic boolean containsMemberships(String key)
Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request. For example, suppose that a binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` The principal in the replayed access tuple is `user:bob@example.com`. This user is a principal of the group `group:product-eng@example.com`. For the first principal 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 principal 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.policysimulator.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
containsMemberships in interface BindingExplanationOrBuilder@Deprecated public Map<String,BindingExplanation.AnnotatedMembership> getMemberships()
getMembershipsMap() instead.getMemberships in interface BindingExplanationOrBuilderpublic Map<String,BindingExplanation.AnnotatedMembership> getMembershipsMap()
Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request. For example, suppose that a binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` The principal in the replayed access tuple is `user:bob@example.com`. This user is a principal of the group `group:product-eng@example.com`. For the first principal 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 principal 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.policysimulator.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
getMembershipsMap in interface BindingExplanationOrBuilderpublic BindingExplanation.AnnotatedMembership getMembershipsOrDefault(String key, BindingExplanation.AnnotatedMembership defaultValue)
Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request. For example, suppose that a binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` The principal in the replayed access tuple is `user:bob@example.com`. This user is a principal of the group `group:product-eng@example.com`. For the first principal 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 principal 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.policysimulator.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
getMembershipsOrDefault in interface BindingExplanationOrBuilderpublic BindingExplanation.AnnotatedMembership getMembershipsOrThrow(String key)
Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly. Each key identifies a principal in the binding, and each value indicates whether the principal in the binding includes the principal in the request. For example, suppose that a binding includes the following principals: * `user:alice@example.com` * `group:product-eng@example.com` The principal in the replayed access tuple is `user:bob@example.com`. This user is a principal of the group `group:product-eng@example.com`. For the first principal 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 principal 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.policysimulator.v1.BindingExplanation.AnnotatedMembership> memberships = 5;
getMembershipsOrThrow in interface BindingExplanationOrBuilderpublic int getRelevanceValue()
The relevance of this binding to the overall determination for the entire policy.
.google.cloud.policysimulator.v1.HeuristicRelevance relevance = 6;getRelevanceValue in interface BindingExplanationOrBuilderpublic HeuristicRelevance getRelevance()
The relevance of this binding to the overall determination for the entire policy.
.google.cloud.policysimulator.v1.HeuristicRelevance relevance = 6;getRelevance in interface BindingExplanationOrBuilderpublic boolean hasCondition()
A condition expression that prevents this binding from granting access unless the expression evaluates to `true`. To learn about IAM Conditions, see https://cloud.google.com/iam/docs/conditions-overview.
.google.type.Expr condition = 7;hasCondition in interface BindingExplanationOrBuilderpublic com.google.type.Expr getCondition()
A condition expression that prevents this binding from granting access unless the expression evaluates to `true`. To learn about IAM Conditions, see https://cloud.google.com/iam/docs/conditions-overview.
.google.type.Expr condition = 7;getCondition in interface BindingExplanationOrBuilderpublic com.google.type.ExprOrBuilder getConditionOrBuilder()
A condition expression that prevents this binding from granting access unless the expression evaluates to `true`. To learn about IAM Conditions, see https://cloud.google.com/iam/docs/conditions-overview.
.google.type.Expr condition = 7;getConditionOrBuilder in interface BindingExplanationOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static BindingExplanation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BindingExplanation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BindingExplanation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BindingExplanation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BindingExplanation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BindingExplanation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BindingExplanation parseFrom(InputStream input) throws IOException
IOExceptionpublic static BindingExplanation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BindingExplanation parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static BindingExplanation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BindingExplanation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static BindingExplanation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic BindingExplanation.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static BindingExplanation.Builder newBuilder()
public static BindingExplanation.Builder newBuilder(BindingExplanation prototype)
public BindingExplanation.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected BindingExplanation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static BindingExplanation getDefaultInstance()
public static com.google.protobuf.Parser<BindingExplanation> parser()
public com.google.protobuf.Parser<BindingExplanation> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public BindingExplanation getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.