Class AccessTuple.Builder (1.31.0)

public static final class AccessTuple.Builder extends GeneratedMessageV3.Builder<AccessTuple.Builder> implements AccessTupleOrBuilder

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

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AccessTuple.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AccessTuple.Builder
Overrides

build()

public AccessTuple build()
Returns
TypeDescription
AccessTuple

buildPartial()

public AccessTuple buildPartial()
Returns
TypeDescription
AccessTuple

clear()

public AccessTuple.Builder clear()
Returns
TypeDescription
AccessTuple.Builder
Overrides

clearConditionContext()

public AccessTuple.Builder clearConditionContext()

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
TypeDescription
AccessTuple.Builder

clearField(Descriptors.FieldDescriptor field)

public AccessTuple.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AccessTuple.Builder
Overrides

clearFullResourceName()

public AccessTuple.Builder clearFullResourceName()

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
TypeDescription
AccessTuple.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AccessTuple.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AccessTuple.Builder
Overrides

clearPermission()

public AccessTuple.Builder clearPermission()

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
TypeDescription
AccessTuple.Builder

This builder for chaining.

clearPermissionFqdn()

public AccessTuple.Builder clearPermissionFqdn()

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

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

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

clearPrincipal()

public AccessTuple.Builder clearPrincipal()

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
TypeDescription
AccessTuple.Builder

This builder for chaining.

clone()

public AccessTuple.Builder clone()
Returns
TypeDescription
AccessTuple.Builder
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
TypeDescription
ConditionContext

The conditionContext.

getConditionContextBuilder()

public ConditionContext.Builder getConditionContextBuilder()

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
TypeDescription
ConditionContext.Builder

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
TypeDescription
ConditionContextOrBuilder

getDefaultInstanceForType()

public AccessTuple getDefaultInstanceForType()
Returns
TypeDescription
AccessTuple

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for fullResourceName.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for principal.

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
TypeDescription
boolean

Whether the conditionContext field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeConditionContext(ConditionContext value)

public AccessTuple.Builder mergeConditionContext(ConditionContext value)

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];

Parameter
NameDescription
valueConditionContext
Returns
TypeDescription
AccessTuple.Builder

mergeFrom(AccessTuple other)

public AccessTuple.Builder mergeFrom(AccessTuple other)
Parameter
NameDescription
otherAccessTuple
Returns
TypeDescription
AccessTuple.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AccessTuple.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AccessTuple.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AccessTuple.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AccessTuple.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AccessTuple.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AccessTuple.Builder
Overrides

setConditionContext(ConditionContext value)

public AccessTuple.Builder setConditionContext(ConditionContext value)

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];

Parameter
NameDescription
valueConditionContext
Returns
TypeDescription
AccessTuple.Builder

setConditionContext(ConditionContext.Builder builderForValue)

public AccessTuple.Builder setConditionContext(ConditionContext.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueConditionContext.Builder
Returns
TypeDescription
AccessTuple.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AccessTuple.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AccessTuple.Builder
Overrides

setFullResourceName(String value)

public AccessTuple.Builder setFullResourceName(String value)

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];

Parameter
NameDescription
valueString

The fullResourceName to set.

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

setFullResourceNameBytes(ByteString value)

public AccessTuple.Builder setFullResourceNameBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for fullResourceName to set.

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

setPermission(String value)

public AccessTuple.Builder setPermission(String value)

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];

Parameter
NameDescription
valueString

The permission to set.

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

setPermissionBytes(ByteString value)

public AccessTuple.Builder setPermissionBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for permission to set.

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

setPermissionFqdn(String value)

public AccessTuple.Builder setPermissionFqdn(String value)

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

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

Parameter
NameDescription
valueString

The permissionFqdn to set.

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

setPermissionFqdnBytes(ByteString value)

public AccessTuple.Builder setPermissionFqdnBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for permissionFqdn to set.

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

setPrincipal(String value)

public AccessTuple.Builder setPrincipal(String value)

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];

Parameter
NameDescription
valueString

The principal to set.

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

setPrincipalBytes(ByteString value)

public AccessTuple.Builder setPrincipalBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for principal to set.

Returns
TypeDescription
AccessTuple.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AccessTuple.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AccessTuple.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AccessTuple.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AccessTuple.Builder
Overrides