Class ExplainedAccess (0.31.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
Type Description
int

ERRORS_FIELD_NUMBER

public static final int ERRORS_FIELD_NUMBER
Field Value
Type Description
int

POLICIES_FIELD_NUMBER

public static final int POLICIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExplainedAccess getDefaultInstance()
Returns
Type Description
ExplainedAccess

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExplainedAccess.Builder newBuilder()
Returns
Type Description
ExplainedAccess.Builder

newBuilder(ExplainedAccess prototype)

public static ExplainedAccess.Builder newBuilder(ExplainedAccess prototype)
Parameter
Name Description
prototype ExplainedAccess
Returns
Type Description
ExplainedAccess.Builder

parseDelimitedFrom(InputStream input)

public static ExplainedAccess parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExplainedAccess parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExplainedAccess parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExplainedAccess parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExplainedAccess parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExplainedAccess parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExplainedAccess parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExplainedAccess
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExplainedAccess> parser()
Returns
Type Description
Parser<ExplainedAccess>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
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
Type Description
int

The enum numeric value on the wire for accessState.

getDefaultInstanceForType()

public ExplainedAccess getDefaultInstanceForType()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.rpc.StatusOrBuilder>

getParserForType()

public Parser<ExplainedAccess> getParserForType()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.policysimulator.v1.ExplainedPolicyOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExplainedAccess.Builder newBuilderForType()
Returns
Type Description
ExplainedAccess.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExplainedAccess.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExplainedAccess.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExplainedAccess.Builder toBuilder()
Returns
Type Description
ExplainedAccess.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException