Class ClientSideAccessBoundaryRule.Builder (1.42.1)

public static final class ClientSideAccessBoundaryRule.Builder extends GeneratedMessage.Builder<ClientSideAccessBoundaryRule.Builder> implements ClientSideAccessBoundaryRuleOrBuilder

An access boundary rule that defines an upper bound of IAM permissions on a single resource. This proto has a compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto). It is used to format the access boundary restriction in the Client-Side CAB access token.

Protobuf type cloud.identity.unifiedauth.proto.ClientSideAccessBoundaryRule

Static Methods

getDescriptor()

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

Methods

addAllAvailablePermissions(Iterable<String> values)

public ClientSideAccessBoundaryRule.Builder addAllAvailablePermissions(Iterable<String> values)

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Parameter
Name Description
values Iterable<String>

The availablePermissions to add.

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

This builder for chaining.

addAvailablePermissions(String value)

public ClientSideAccessBoundaryRule.Builder addAvailablePermissions(String value)

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Parameter
Name Description
value String

The availablePermissions to add.

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

This builder for chaining.

addAvailablePermissionsBytes(ByteString value)

public ClientSideAccessBoundaryRule.Builder addAvailablePermissionsBytes(ByteString value)

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Parameter
Name Description
value ByteString

The bytes of the availablePermissions to add.

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

This builder for chaining.

build()

public ClientSideAccessBoundaryRule build()
Returns
Type Description
ClientSideAccessBoundaryRule

buildPartial()

public ClientSideAccessBoundaryRule buildPartial()
Returns
Type Description
ClientSideAccessBoundaryRule

clear()

public ClientSideAccessBoundaryRule.Builder clear()
Returns
Type Description
ClientSideAccessBoundaryRule.Builder
Overrides

clearAvailablePermissions()

public ClientSideAccessBoundaryRule.Builder clearAvailablePermissions()

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

This builder for chaining.

clearAvailableResource()

public ClientSideAccessBoundaryRule.Builder clearAvailableResource()

The full resource name of a Google Cloud resource entity. The format definition is at https://cloud.google.com/apis/design/resource_names.

Example value: //cloudresourcemanager.googleapis.com/projects/my-project.

string available_resource = 1 [features = { ... }

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

This builder for chaining.

clearCompiledAvailabilityCondition()

public ClientSideAccessBoundaryRule.Builder clearCompiledAvailabilityCondition()

The compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto) with limited function support.

.google.api.expr.Expr compiled_availability_condition = 4;

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

getAvailablePermissions(int index)

public String getAvailablePermissions(int index)

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The availablePermissions at the given index.

getAvailablePermissionsBytes(int index)

public ByteString getAvailablePermissionsBytes(int index)

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the availablePermissions at the given index.

getAvailablePermissionsCount()

public int getAvailablePermissionsCount()

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Returns
Type Description
int

The count of availablePermissions.

getAvailablePermissionsList()

public ProtocolStringList getAvailablePermissionsList()

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Returns
Type Description
ProtocolStringList

A list containing the availablePermissions.

getAvailableResource()

public String getAvailableResource()

The full resource name of a Google Cloud resource entity. The format definition is at https://cloud.google.com/apis/design/resource_names.

Example value: //cloudresourcemanager.googleapis.com/projects/my-project.

string available_resource = 1 [features = { ... }

Returns
Type Description
String

The availableResource.

getAvailableResourceBytes()

public ByteString getAvailableResourceBytes()

The full resource name of a Google Cloud resource entity. The format definition is at https://cloud.google.com/apis/design/resource_names.

Example value: //cloudresourcemanager.googleapis.com/projects/my-project.

string available_resource = 1 [features = { ... }

Returns
Type Description
ByteString

The bytes for availableResource.

getCompiledAvailabilityCondition()

public Expr getCompiledAvailabilityCondition()

The compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto) with limited function support.

.google.api.expr.Expr compiled_availability_condition = 4;

Returns
Type Description
dev.cel.expr.Expr

The compiledAvailabilityCondition.

getCompiledAvailabilityConditionBuilder()

public Expr.Builder getCompiledAvailabilityConditionBuilder()

The compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto) with limited function support.

.google.api.expr.Expr compiled_availability_condition = 4;

Returns
Type Description
dev.cel.expr.Expr.Builder

getCompiledAvailabilityConditionOrBuilder()

public ExprOrBuilder getCompiledAvailabilityConditionOrBuilder()

The compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto) with limited function support.

.google.api.expr.Expr compiled_availability_condition = 4;

Returns
Type Description
dev.cel.expr.ExprOrBuilder

getDefaultInstanceForType()

public ClientSideAccessBoundaryRule getDefaultInstanceForType()
Returns
Type Description
ClientSideAccessBoundaryRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

hasCompiledAvailabilityCondition()

public boolean hasCompiledAvailabilityCondition()

The compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto) with limited function support.

.google.api.expr.Expr compiled_availability_condition = 4;

Returns
Type Description
boolean

Whether the compiledAvailabilityCondition field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCompiledAvailabilityCondition(Expr value)

public ClientSideAccessBoundaryRule.Builder mergeCompiledAvailabilityCondition(Expr value)

The compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto) with limited function support.

.google.api.expr.Expr compiled_availability_condition = 4;

Parameter
Name Description
value dev.cel.expr.Expr
Returns
Type Description
ClientSideAccessBoundaryRule.Builder

mergeFrom(ClientSideAccessBoundaryRule other)

public ClientSideAccessBoundaryRule.Builder mergeFrom(ClientSideAccessBoundaryRule other)
Parameter
Name Description
other ClientSideAccessBoundaryRule
Returns
Type Description
ClientSideAccessBoundaryRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ClientSideAccessBoundaryRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClientSideAccessBoundaryRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ClientSideAccessBoundaryRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ClientSideAccessBoundaryRule.Builder
Overrides

setAvailablePermissions(int index, String value)

public ClientSideAccessBoundaryRule.Builder setAvailablePermissions(int index, String value)

A list of permissions that may be allowed for use on the specified resource.

The only supported values in the list are IAM roles, following the format of [google.iam.v1.Binding.role][].

Example value: inRole:roles/logging.viewer for predefined roles and inRole:organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

repeated string available_permissions = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The availablePermissions to set.

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

This builder for chaining.

setAvailableResource(String value)

public ClientSideAccessBoundaryRule.Builder setAvailableResource(String value)

The full resource name of a Google Cloud resource entity. The format definition is at https://cloud.google.com/apis/design/resource_names.

Example value: //cloudresourcemanager.googleapis.com/projects/my-project.

string available_resource = 1 [features = { ... }

Parameter
Name Description
value String

The availableResource to set.

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

This builder for chaining.

setAvailableResourceBytes(ByteString value)

public ClientSideAccessBoundaryRule.Builder setAvailableResourceBytes(ByteString value)

The full resource name of a Google Cloud resource entity. The format definition is at https://cloud.google.com/apis/design/resource_names.

Example value: //cloudresourcemanager.googleapis.com/projects/my-project.

string available_resource = 1 [features = { ... }

Parameter
Name Description
value ByteString

The bytes for availableResource to set.

Returns
Type Description
ClientSideAccessBoundaryRule.Builder

This builder for chaining.

setCompiledAvailabilityCondition(Expr value)

public ClientSideAccessBoundaryRule.Builder setCompiledAvailabilityCondition(Expr value)

The compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto) with limited function support.

.google.api.expr.Expr compiled_availability_condition = 4;

Parameter
Name Description
value dev.cel.expr.Expr
Returns
Type Description
ClientSideAccessBoundaryRule.Builder

setCompiledAvailabilityCondition(Expr.Builder builderForValue)

public ClientSideAccessBoundaryRule.Builder setCompiledAvailabilityCondition(Expr.Builder builderForValue)

The compiled version of the availability_condition in the STS API AccessBoundaryRule (google3/google/identity/sts/v1/access_boundary.proto) with limited function support.

.google.api.expr.Expr compiled_availability_condition = 4;

Parameter
Name Description
builderForValue dev.cel.expr.Expr.Builder
Returns
Type Description
ClientSideAccessBoundaryRule.Builder