Class Explanations.AccessTuple (1.43.0)

public static final class Explanations.AccessTuple extends GeneratedMessageV3 implements Explanations.AccessTupleOrBuilder

Information about the principal, resource, and permission to check.

Protobuf type google.cloud.policytroubleshooter.v1.AccessTuple

Static Fields

FULL_RESOURCE_NAME_FIELD_NUMBER

public static final int FULL_RESOURCE_NAME_FIELD_NUMBER
Field Value
Type Description
int

PERMISSION_FIELD_NUMBER

public static final int PERMISSION_FIELD_NUMBER
Field Value
Type Description
int

PRINCIPAL_FIELD_NUMBER

public static final int PRINCIPAL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Explanations.AccessTuple getDefaultInstance()
Returns
Type Description
Explanations.AccessTuple

getDescriptor()

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

newBuilder()

public static Explanations.AccessTuple.Builder newBuilder()
Returns
Type Description
Explanations.AccessTuple.Builder

newBuilder(Explanations.AccessTuple prototype)

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

parseDelimitedFrom(InputStream input)

public static Explanations.AccessTuple parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Explanations.AccessTuple
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Explanations.AccessTuple parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Explanations.AccessTuple
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Explanations.AccessTuple parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Explanations.AccessTuple
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Explanations.AccessTuple parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Explanations.AccessTuple
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Explanations.AccessTuple parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Explanations.AccessTuple
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Explanations.AccessTuple> parser()
Returns
Type Description
Parser<AccessTuple>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Explanations.AccessTuple getDefaultInstanceForType()
Returns
Type Description
Explanations.AccessTuple

getFullResourceName()

public String getFullResourceName()

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

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 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The fullResourceName.

getFullResourceNameBytes()

public ByteString getFullResourceNameBytes()

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

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 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for fullResourceName.

getParserForType()

public Parser<Explanations.AccessTuple> getParserForType()
Returns
Type Description
Parser<AccessTuple>
Overrides

getPermission()

public String getPermission()

Required. The IAM permission to check for the specified principal and resource.

For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference.

For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.

string permission = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The permission.

getPermissionBytes()

public ByteString getPermissionBytes()

Required. The IAM permission to check for the specified principal and resource.

For a complete list of IAM permissions, see https://cloud.google.com/iam/help/permissions/reference.

For a complete list of predefined IAM roles and the permissions in each role, see https://cloud.google.com/iam/help/roles/reference.

string permission = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for permission.

getPrincipal()

public String getPrincipal()

Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, alice@example.com or my-service-account@my-project.iam.gserviceaccount.com.

The principal must be a Google Account or a service account. Other types of principals are not supported.

string principal = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The principal.

getPrincipalBytes()

public ByteString getPrincipalBytes()

Required. The principal whose access you want to check, in the form of the email address that represents that principal. For example, alice@example.com or my-service-account@my-project.iam.gserviceaccount.com.

The principal must be a Google Account or a service account. Other types of principals are not supported.

string principal = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for principal.

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 Explanations.AccessTuple.Builder newBuilderForType()
Returns
Type Description
Explanations.AccessTuple.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Explanations.AccessTuple.Builder toBuilder()
Returns
Type Description
Explanations.AccessTuple.Builder

writeTo(CodedOutputStream output)

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