Class ClientSideAccessBoundaryRule (1.42.1)

public final class ClientSideAccessBoundaryRule extends GeneratedMessage 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > ClientSideAccessBoundaryRule

Static Fields

AVAILABLE_PERMISSIONS_FIELD_NUMBER

public static final int AVAILABLE_PERMISSIONS_FIELD_NUMBER
Field Value
Type Description
int

AVAILABLE_RESOURCE_FIELD_NUMBER

public static final int AVAILABLE_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

COMPILED_AVAILABILITY_CONDITION_FIELD_NUMBER

public static final int COMPILED_AVAILABILITY_CONDITION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ClientSideAccessBoundaryRule getDefaultInstance()
Returns
Type Description
ClientSideAccessBoundaryRule

getDescriptor()

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

newBuilder()

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

newBuilder(ClientSideAccessBoundaryRule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ClientSideAccessBoundaryRule> parser()
Returns
Type Description
Parser<ClientSideAccessBoundaryRule>

Methods

equals(Object obj)

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

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.

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

getParserForType()

public Parser<ClientSideAccessBoundaryRule> getParserForType()
Returns
Type Description
Parser<ClientSideAccessBoundaryRule>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ClientSideAccessBoundaryRule.Builder newBuilderForType()
Returns
Type Description
ClientSideAccessBoundaryRule.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ClientSideAccessBoundaryRule.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ClientSideAccessBoundaryRule.Builder
Overrides

toBuilder()

public ClientSideAccessBoundaryRule.Builder toBuilder()
Returns
Type Description
ClientSideAccessBoundaryRule.Builder

writeTo(CodedOutputStream output)

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