Class BindingExplanation
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.policysimulator.v1.BindingExplanation
- All Implemented Interfaces:
BindingExplanationOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class BindingExplanation
extends com.google.protobuf.GeneratedMessage
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- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classDetails about whether the binding includes the principal.static interfacestatic final classDetails about how a binding in a policy affects a principal's ability to use a permission.static enumWhether the binding includes the principal.static enumWhether a role includes a specific permission.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanIndicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly.booleanRequired.intRequired.A condition expression that prevents this binding from granting access unless the expression evaluates to `true`.A condition expression that prevents this binding from granting access unless the expression evaluates to `true`.static BindingExplanationstatic final com.google.protobuf.Descriptors.DescriptorDeprecated.intIndicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly.Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly.getMembershipsOrDefault(String key, BindingExplanation.AnnotatedMembership defaultValue) Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly.Indicates whether each principal in the binding includes the principal specified in the request, either directly or indirectly.com.google.protobuf.Parser<BindingExplanation>The relevance of this binding to the overall determination for the entire policy.intThe relevance of this binding to the overall determination for the entire policy.getRole()The role that this binding grants.com.google.protobuf.ByteStringThe role that this binding grants.Indicates whether the role granted by this binding contains the specified permission.The relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.intThe relevance of the permission's existence, or nonexistence, in the role to the overall determination for the entire policy.intIndicates whether the role granted by this binding contains the specified permission.intbooleanA condition expression that prevents this binding from granting access unless the expression evaluates to `true`.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic BindingExplanation.Builderstatic BindingExplanation.BuildernewBuilder(BindingExplanation prototype) protected BindingExplanation.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static BindingExplanationparseDelimitedFrom(InputStream input) static BindingExplanationparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BindingExplanationparseFrom(byte[] data) static BindingExplanationparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BindingExplanationparseFrom(com.google.protobuf.ByteString data) static BindingExplanationparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BindingExplanationparseFrom(com.google.protobuf.CodedInputStream input) static BindingExplanationparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BindingExplanationparseFrom(InputStream input) static BindingExplanationparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BindingExplanationparseFrom(ByteBuffer data) static BindingExplanationparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<BindingExplanation>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
ACCESS_FIELD_NUMBER
public static final int ACCESS_FIELD_NUMBER- See Also:
-
ROLE_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER- See Also:
-
ROLE_PERMISSION_FIELD_NUMBER
public static final int ROLE_PERMISSION_FIELD_NUMBER- See Also:
-
ROLE_PERMISSION_RELEVANCE_FIELD_NUMBER
public static final int ROLE_PERMISSION_RELEVANCE_FIELD_NUMBER- See Also:
-
MEMBERSHIPS_FIELD_NUMBER
public static final int MEMBERSHIPS_FIELD_NUMBER- See Also:
-
RELEVANCE_FIELD_NUMBER
public static final int RELEVANCE_FIELD_NUMBER- See Also:
-
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getAccessValue
public 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][google.cloud.policytroubleshooter.v3.TroubleshootIamPolicyResponse].
.google.cloud.policysimulator.v1.AccessState access = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getAccessValuein interfaceBindingExplanationOrBuilder- Returns:
- The enum numeric value on the wire for access.
-
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][google.cloud.policytroubleshooter.v3.TroubleshootIamPolicyResponse].
.google.cloud.policysimulator.v1.AccessState access = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getAccessin interfaceBindingExplanationOrBuilder- Returns:
- The access.
-
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;- Specified by:
getRolein interfaceBindingExplanationOrBuilder- Returns:
- The role.
-
getRoleBytes
public 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;- Specified by:
getRoleBytesin interfaceBindingExplanationOrBuilder- Returns:
- The bytes for role.
-
getRolePermissionValue
public int getRolePermissionValue()Indicates whether the role granted by this binding contains the specified permission.
.google.cloud.policysimulator.v1.BindingExplanation.RolePermission role_permission = 3;- Specified by:
getRolePermissionValuein interfaceBindingExplanationOrBuilder- Returns:
- The enum numeric value on the wire for rolePermission.
-
getRolePermission
Indicates whether the role granted by this binding contains the specified permission.
.google.cloud.policysimulator.v1.BindingExplanation.RolePermission role_permission = 3;- Specified by:
getRolePermissionin interfaceBindingExplanationOrBuilder- Returns:
- The rolePermission.
-
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.policysimulator.v1.HeuristicRelevance role_permission_relevance = 4;- Specified by:
getRolePermissionRelevanceValuein interfaceBindingExplanationOrBuilder- Returns:
- The enum numeric value on the wire for rolePermissionRelevance.
-
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;- Specified by:
getRolePermissionRelevancein interfaceBindingExplanationOrBuilder- Returns:
- The rolePermissionRelevance.
-
getMembershipsCount
public int getMembershipsCount()Description copied from interface: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;- Specified by:
getMembershipsCountin interfaceBindingExplanationOrBuilder
-
containsMemberships
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;- Specified by:
containsMembershipsin interfaceBindingExplanationOrBuilder
-
getMemberships
Deprecated.UsegetMembershipsMap()instead.- Specified by:
getMembershipsin interfaceBindingExplanationOrBuilder
-
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;- Specified by:
getMembershipsMapin interfaceBindingExplanationOrBuilder
-
getMembershipsOrDefault
public 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;- Specified by:
getMembershipsOrDefaultin interfaceBindingExplanationOrBuilder
-
getMembershipsOrThrow
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;- Specified by:
getMembershipsOrThrowin interfaceBindingExplanationOrBuilder
-
getRelevanceValue
public int getRelevanceValue()The relevance of this binding to the overall determination for the entire policy.
.google.cloud.policysimulator.v1.HeuristicRelevance relevance = 6;- Specified by:
getRelevanceValuein interfaceBindingExplanationOrBuilder- Returns:
- The enum numeric value on the wire for relevance.
-
getRelevance
The relevance of this binding to the overall determination for the entire policy.
.google.cloud.policysimulator.v1.HeuristicRelevance relevance = 6;- Specified by:
getRelevancein interfaceBindingExplanationOrBuilder- Returns:
- The relevance.
-
hasCondition
public 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;- Specified by:
hasConditionin interfaceBindingExplanationOrBuilder- Returns:
- Whether the condition field is set.
-
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;- Specified by:
getConditionin interfaceBindingExplanationOrBuilder- Returns:
- The condition.
-
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;- Specified by:
getConditionOrBuilderin interfaceBindingExplanationOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static BindingExplanation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BindingExplanation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BindingExplanation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BindingExplanation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BindingExplanation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BindingExplanation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static BindingExplanation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static BindingExplanation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static BindingExplanation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static BindingExplanation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected BindingExplanation.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-