Package com.google.cloud.policysimulator.v1

Interface ExplainedPolicyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ExplainedPolicy, ExplainedPolicy.Builder
    public interface ExplainedPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      AccessState getAccess()
      Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource.
      int getAccessValue()
      Indicates whether _this policy_ provides the specified permission to the specified principal for the specified resource.
      BindingExplanation getBindingExplanations​(int index)
      Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.
      int getBindingExplanationsCount()
      Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.
      List<BindingExplanation> getBindingExplanationsList()
      Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.
      BindingExplanationOrBuilder getBindingExplanationsOrBuilder​(int index)
      Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.
      List<? extends BindingExplanationOrBuilder> getBindingExplanationsOrBuilderList()
      Details about how each binding in the policy affects the principal's ability, or inability, to use the permission for the resource.
      String getFullResourceName()
      The full resource name that identifies the resource.
      com.google.protobuf.ByteString getFullResourceNameBytes()
      The full resource name that identifies the resource.
      com.google.iam.v1.Policy getPolicy()
      The IAM policy attached to the resource.
      com.google.iam.v1.PolicyOrBuilder getPolicyOrBuilder()
      The IAM policy attached to the resource.
      HeuristicRelevance getRelevance()
      The relevance of this policy to the overall determination in the [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].
      int getRelevanceValue()
      The relevance of this policy to the overall determination in the [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].
      boolean hasPolicy()
      The IAM policy attached to the resource.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getAccessValue

        int getAccessValue()
         Indicates whether _this policy_ 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 policy that overrides
 this policy. 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;
        Returns:
        The enum numeric value on the wire for access.

      • getAccess

        AccessState getAccess()
         Indicates whether _this policy_ 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 policy that overrides
 this policy. 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;
        Returns:
        The access.

      • getFullResourceName

        String getFullResourceName()
         The full resource name that identifies the resource. For example,
 `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.

 For examples of full resource names for Google Cloud services, see
 https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
        string full_resource_name = 2;
        Returns:
        The fullResourceName.

      • getFullResourceNameBytes

        com.google.protobuf.ByteString getFullResourceNameBytes()
         The full resource name that identifies the resource. For example,
 `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.

 For examples of full resource names for Google Cloud services, see
 https://cloud.google.com/iam/help/troubleshooter/full-resource-names.
        string full_resource_name = 2;
        Returns:
        The bytes for fullResourceName.

      • hasPolicy

        boolean hasPolicy()
         The IAM policy attached to the resource.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is empty.
        .google.iam.v1.Policy policy = 3;
        Returns:
        Whether the policy field is set.

      • getPolicy

        com.google.iam.v1.Policy getPolicy()
         The IAM policy attached to the resource.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is empty.
        .google.iam.v1.Policy policy = 3;
        Returns:
        The policy.

      • getPolicyOrBuilder

        com.google.iam.v1.PolicyOrBuilder getPolicyOrBuilder()
         The IAM policy attached to the resource.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is empty.
        .google.iam.v1.Policy policy = 3;

      • getBindingExplanationsList

        List<BindingExplanation> getBindingExplanationsList()
         Details about how each binding in the policy affects the principal's
 ability, or inability, to use the permission for the resource.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.
        repeated .google.cloud.policysimulator.v1.BindingExplanation binding_explanations = 4;

      • getBindingExplanations

        BindingExplanation getBindingExplanations​(int index)
         Details about how each binding in the policy affects the principal's
 ability, or inability, to use the permission for the resource.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.
        repeated .google.cloud.policysimulator.v1.BindingExplanation binding_explanations = 4;

      • getBindingExplanationsCount

        int getBindingExplanationsCount()
         Details about how each binding in the policy affects the principal's
 ability, or inability, to use the permission for the resource.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.
        repeated .google.cloud.policysimulator.v1.BindingExplanation binding_explanations = 4;

      • getBindingExplanationsOrBuilderList

        List<? extends BindingExplanationOrBuilder> getBindingExplanationsOrBuilderList()
         Details about how each binding in the policy affects the principal's
 ability, or inability, to use the permission for the resource.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.
        repeated .google.cloud.policysimulator.v1.BindingExplanation binding_explanations = 4;

      • getBindingExplanationsOrBuilder

        BindingExplanationOrBuilder getBindingExplanationsOrBuilder​(int index)
         Details about how each binding in the policy affects the principal's
 ability, or inability, to use the permission for the resource.

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.
        repeated .google.cloud.policysimulator.v1.BindingExplanation binding_explanations = 4;

      • getRelevanceValue

        int getRelevanceValue()
         The relevance of this policy to the overall determination in the
 [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.
        .google.cloud.policysimulator.v1.HeuristicRelevance relevance = 5;
        Returns:
        The enum numeric value on the wire for relevance.

      • getRelevance

        HeuristicRelevance getRelevance()
         The relevance of this policy to the overall determination in the
 [TroubleshootIamPolicyResponse][IamChecker.TroubleshootIamPolicyResponse].

 If the user who created the
 [Replay][google.cloud.policysimulator.v1.Replay] does not have
 access to the policy, this field is omitted.
        .google.cloud.policysimulator.v1.HeuristicRelevance relevance = 5;
        Returns:
        The relevance.