Class AccessTuple (1.44.0)

public final class AccessTuple extends GeneratedMessageV3 implements AccessTupleOrBuilder

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

Protobuf type google.cloud.policytroubleshooter.iam.v3.AccessTuple

Static Fields

CONDITION_CONTEXT_FIELD_NUMBER

public static final int CONDITION_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

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

PERMISSION_FQDN_FIELD_NUMBER

public static final int PERMISSION_FQDN_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 AccessTuple getDefaultInstance()
Returns
Type Description
AccessTuple

getDescriptor()

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

newBuilder()

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

newBuilder(AccessTuple prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<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

getConditionContext()

public ConditionContext getConditionContext()

Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules.

.google.cloud.policytroubleshooter.iam.v3.ConditionContext condition_context = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConditionContext

The conditionContext.

getConditionContextOrBuilder()

public ConditionContextOrBuilder getConditionContextOrBuilder()

Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules.

.google.cloud.policytroubleshooter.iam.v3.ConditionContext condition_context = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ConditionContextOrBuilder

getDefaultInstanceForType()

public AccessTuple getDefaultInstanceForType()
Returns
Type Description
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<AccessTuple> getParserForType()
Returns
Type Description
Parser<AccessTuple>
Overrides

getPermission()

public String getPermission()

Required. The IAM permission to check for, either in the v1 permission format or the v2 permission format.

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

For a list of IAM permissions in the v2 format, see https://cloud.google.com/iam/help/deny/supported-permissions.

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, either in the v1 permission format or the v2 permission format.

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

For a list of IAM permissions in the v2 format, see https://cloud.google.com/iam/help/deny/supported-permissions.

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.

getPermissionFqdn()

public String getPermissionFqdn()

Output only. The permission that Policy Troubleshooter checked for, in the v2 format.

string permission_fqdn = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The permissionFqdn.

getPermissionFqdnBytes()

public ByteString getPermissionFqdnBytes()

Output only. The permission that Policy Troubleshooter checked for, in the v2 format.

string permission_fqdn = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for permissionFqdn.

getPrincipal()

public String getPrincipal()

Required. The email address of the principal whose access you want to check. 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 email address of the principal whose access you want to check. 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

hasConditionContext()

public boolean hasConditionContext()

Optional. Additional context for the request, such as the request time or IP address. This context allows Policy Troubleshooter to troubleshoot conditional role bindings and deny rules.

.google.cloud.policytroubleshooter.iam.v3.ConditionContext condition_context = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the conditionContext field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AccessTuple.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
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 AccessTuple.Builder toBuilder()
Returns
Type Description
AccessTuple.Builder

writeTo(CodedOutputStream output)

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