Class ExplainedAccess (0.16.0)

public final class ExplainedAccess extends GeneratedMessageV3 implements ExplainedAccessOrBuilder

Details about how a set of policies, listed in ExplainedPolicy, resulted in a certain AccessState when replaying an access tuple.

Protobuf type google.cloud.policysimulator.v1.ExplainedAccess

Static Fields

ACCESS_STATE_FIELD_NUMBER

public static final int ACCESS_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

ERRORS_FIELD_NUMBER

public static final int ERRORS_FIELD_NUMBER
Field Value
TypeDescription
int

POLICIES_FIELD_NUMBER

public static final int POLICIES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExplainedAccess getDefaultInstance()
Returns
TypeDescription
ExplainedAccess

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExplainedAccess.Builder newBuilder()
Returns
TypeDescription
ExplainedAccess.Builder

newBuilder(ExplainedAccess prototype)

public static ExplainedAccess.Builder newBuilder(ExplainedAccess prototype)
Parameter
NameDescription
prototypeExplainedAccess
Returns
TypeDescription
ExplainedAccess.Builder

parseDelimitedFrom(InputStream input)

public static ExplainedAccess parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExplainedAccess parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainedAccess parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainedAccess parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExplainedAccess parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExplainedAccess parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExplainedAccess
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExplainedAccess> parser()
Returns
TypeDescription
Parser<ExplainedAccess>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAccessState()

public AccessState getAccessState()

Whether the principal in the access tuple has permission to access the resource in the access tuple under the given policies.

.google.cloud.policysimulator.v1.AccessState access_state = 1;

Returns
TypeDescription
AccessState

The accessState.

getAccessStateValue()

public int getAccessStateValue()

Whether the principal in the access tuple has permission to access the resource in the access tuple under the given policies.

.google.cloud.policysimulator.v1.AccessState access_state = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for accessState.

getDefaultInstanceForType()

public ExplainedAccess getDefaultInstanceForType()
Returns
TypeDescription
ExplainedAccess

getErrors(int index)

public Status getErrors(int index)

If the AccessState is UNKNOWN, this field contains a list of errors explaining why the result is UNKNOWN.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.rpc.Status errors = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
com.google.rpc.Status

getErrorsCount()

public int getErrorsCount()

If the AccessState is UNKNOWN, this field contains a list of errors explaining why the result is UNKNOWN.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.rpc.Status errors = 3;

Returns
TypeDescription
int

getErrorsList()

public List<Status> getErrorsList()

If the AccessState is UNKNOWN, this field contains a list of errors explaining why the result is UNKNOWN.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.rpc.Status errors = 3;

Returns
TypeDescription
List<com.google.rpc.Status>

getErrorsOrBuilder(int index)

public StatusOrBuilder getErrorsOrBuilder(int index)

If the AccessState is UNKNOWN, this field contains a list of errors explaining why the result is UNKNOWN.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.rpc.Status errors = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
com.google.rpc.StatusOrBuilder

getErrorsOrBuilderList()

public List<? extends StatusOrBuilder> getErrorsOrBuilderList()

If the AccessState is UNKNOWN, this field contains a list of errors explaining why the result is UNKNOWN.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.rpc.Status errors = 3;

Returns
TypeDescription
List<? extends com.google.rpc.StatusOrBuilder>

getParserForType()

public Parser<ExplainedAccess> getParserForType()
Returns
TypeDescription
Parser<ExplainedAccess>
Overrides

getPolicies(int index)

public ExplainedPolicy getPolicies(int index)

If the AccessState is UNKNOWN, this field contains the policies that led to that result.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.cloud.policysimulator.v1.ExplainedPolicy policies = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedPolicy

getPoliciesCount()

public int getPoliciesCount()

If the AccessState is UNKNOWN, this field contains the policies that led to that result.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.cloud.policysimulator.v1.ExplainedPolicy policies = 2;

Returns
TypeDescription
int

getPoliciesList()

public List<ExplainedPolicy> getPoliciesList()

If the AccessState is UNKNOWN, this field contains the policies that led to that result.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.cloud.policysimulator.v1.ExplainedPolicy policies = 2;

Returns
TypeDescription
List<ExplainedPolicy>

getPoliciesOrBuilder(int index)

public ExplainedPolicyOrBuilder getPoliciesOrBuilder(int index)

If the AccessState is UNKNOWN, this field contains the policies that led to that result.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.cloud.policysimulator.v1.ExplainedPolicy policies = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ExplainedPolicyOrBuilder

getPoliciesOrBuilderList()

public List<? extends ExplainedPolicyOrBuilder> getPoliciesOrBuilderList()

If the AccessState is UNKNOWN, this field contains the policies that led to that result.

If the AccessState is GRANTED or NOT_GRANTED, this field is omitted.

repeated .google.cloud.policysimulator.v1.ExplainedPolicy policies = 2;

Returns
TypeDescription
List<? extends com.google.cloud.policysimulator.v1.ExplainedPolicyOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExplainedAccess.Builder newBuilderForType()
Returns
TypeDescription
ExplainedAccess.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainedAccess.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExplainedAccess.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExplainedAccess.Builder toBuilder()
Returns
TypeDescription
ExplainedAccess.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException