Class Explanations.AccessTuple.Builder (1.22.0)

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

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

Protobuf type google.cloud.policytroubleshooter.v1.AccessTuple

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Explanations.AccessTuple build()
Returns
TypeDescription
Explanations.AccessTuple

buildPartial()

public Explanations.AccessTuple buildPartial()
Returns
TypeDescription
Explanations.AccessTuple

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFullResourceName()

public Explanations.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
Explanations.AccessTuple.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPermission()

public Explanations.AccessTuple.Builder clearPermission()

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

This builder for chaining.

clearPrincipal()

public Explanations.AccessTuple.Builder clearPrincipal()

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

This builder for chaining.

clone()

public Explanations.AccessTuple.Builder clone()
Returns
TypeDescription
Explanations.AccessTuple.Builder
Overrides

getDefaultInstanceForType()

public Explanations.AccessTuple getDefaultInstanceForType()
Returns
TypeDescription
Explanations.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 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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for principal.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(Explanations.AccessTuple other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFullResourceName(String value)

public Explanations.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
Explanations.AccessTuple.Builder

This builder for chaining.

setFullResourceNameBytes(ByteString value)

public Explanations.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
Explanations.AccessTuple.Builder

This builder for chaining.

setPermission(String value)

public Explanations.AccessTuple.Builder setPermission(String value)

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

Parameter
NameDescription
valueString

The permission to set.

Returns
TypeDescription
Explanations.AccessTuple.Builder

This builder for chaining.

setPermissionBytes(ByteString value)

public Explanations.AccessTuple.Builder setPermissionBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for permission to set.

Returns
TypeDescription
Explanations.AccessTuple.Builder

This builder for chaining.

setPrincipal(String value)

public Explanations.AccessTuple.Builder setPrincipal(String value)

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

Parameter
NameDescription
valueString

The principal to set.

Returns
TypeDescription
Explanations.AccessTuple.Builder

This builder for chaining.

setPrincipalBytes(ByteString value)

public Explanations.AccessTuple.Builder setPrincipalBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for principal to set.

Returns
TypeDescription
Explanations.AccessTuple.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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