Interface DenyRuleOrBuilder (1.5.1)

Version 1.5.1

• 1.41.0 (latest)
• 1.40.1
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.1
• 1.17.1
• 1.16.1
• 1.10.0
• 1.9.3
• 1.8.0
• 1.7.0
• 1.6.23
• 1.5.1
• 1.4.1
• 1.3.4
• 1.2.12

public interface DenyRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDenialCondition()

public abstract Expr getDenialCondition()

The condition that determines whether this deny rule applies to a request. If the condition expression evaluates to true, then the deny rule is applied; otherwise, the deny rule is not applied. Each deny rule is evaluated independently. If this deny rule does not apply to a request, other deny rules might still apply. The condition can use CEL functions that evaluate resource tags. Other functions and operators are not supported.

.google.type.Expr denial_condition = 5;

Returns

Type	Description
com.google.type.Expr	The denialCondition.

getDenialConditionOrBuilder()

public abstract ExprOrBuilder getDenialConditionOrBuilder()

The condition that determines whether this deny rule applies to a request. If the condition expression evaluates to true, then the deny rule is applied; otherwise, the deny rule is not applied. Each deny rule is evaluated independently. If this deny rule does not apply to a request, other deny rules might still apply. The condition can use CEL functions that evaluate resource tags. Other functions and operators are not supported.

.google.type.Expr denial_condition = 5;

Returns

Type	Description
com.google.type.ExprOrBuilder

getDeniedPermissions(int index)

public abstract String getDeniedPermissions(int index)

The permissions that are explicitly denied by this rule. Each permission uses the format {service_fqdn}/{resource}.{verb}, where {service_fqdn} is the fully qualified domain name for the service. For example, iam.googleapis.com/roles.list.

repeated string denied_permissions = 3;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The deniedPermissions at the given index.

getDeniedPermissionsBytes(int index)

public abstract ByteString getDeniedPermissionsBytes(int index)

The permissions that are explicitly denied by this rule. Each permission uses the format {service_fqdn}/{resource}.{verb}, where {service_fqdn} is the fully qualified domain name for the service. For example, iam.googleapis.com/roles.list.

repeated string denied_permissions = 3;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the deniedPermissions at the given index.

getDeniedPermissionsCount()

public abstract int getDeniedPermissionsCount()

The permissions that are explicitly denied by this rule. Each permission uses the format {service_fqdn}/{resource}.{verb}, where {service_fqdn} is the fully qualified domain name for the service. For example, iam.googleapis.com/roles.list.

repeated string denied_permissions = 3;

Returns

Type	Description
int	The count of deniedPermissions.

getDeniedPermissionsList()

public abstract List<String> getDeniedPermissionsList()

The permissions that are explicitly denied by this rule. Each permission uses the format {service_fqdn}/{resource}.{verb}, where {service_fqdn} is the fully qualified domain name for the service. For example, iam.googleapis.com/roles.list.

repeated string denied_permissions = 3;

Returns

Type	Description
List<String>	A list containing the deniedPermissions.

getDeniedPrincipals(int index)

public abstract String getDeniedPrincipals(int index)

The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values:

• principalSet://goog/public:all: A special identifier that represents any user who is on the internet, even if they do not have a Google Account or are not logged in.
• principal://goog/subject/{email_id}: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, principal://goog/subject/[e-mail].
• deleted:principal://goog/subject/{email_id}?uid={uid}: A specific Google Account that was deleted recently. For example, deleted:principal://goog/subject/[e-mail]?uid=1234567890. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account.
• principalSet://goog/group/{group_id}: A Google group. For example, principalSet://goog/group/[e-mail].
• deleted:principalSet://goog/group/{group_id}?uid={uid}: A Google group that was deleted recently. For example, deleted:principalSet://goog/group/[e-mail]?uid=1234567890. If the Google group is restored, this identifier reverts to the standard identifier for a Google group.
• principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}: A Google Cloud service account. For example, principal://iam.googleapis.com/projects/-/serviceAccounts/[e-mail].
• deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}: A Google Cloud service account that was deleted recently. For example, deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/[e-mail]?uid=1234567890. If the service account is undeleted, this identifier reverts to the standard identifier for a service account.
• principalSet://goog/cloudIdentityCustomerId/{customer_id}: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, principalSet://goog/cloudIdentityCustomerId/C01Abc35.

repeated string denied_principals = 1;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The deniedPrincipals at the given index.

getDeniedPrincipalsBytes(int index)

public abstract ByteString getDeniedPrincipalsBytes(int index)

The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values:

• principalSet://goog/public:all: A special identifier that represents any user who is on the internet, even if they do not have a Google Account or are not logged in.
• principal://goog/subject/{email_id}: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, principal://goog/subject/[e-mail].
• deleted:principal://goog/subject/{email_id}?uid={uid}: A specific Google Account that was deleted recently. For example, deleted:principal://goog/subject/[e-mail]?uid=1234567890. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account.
• principalSet://goog/group/{group_id}: A Google group. For example, principalSet://goog/group/[e-mail].
• deleted:principalSet://goog/group/{group_id}?uid={uid}: A Google group that was deleted recently. For example, deleted:principalSet://goog/group/[e-mail]?uid=1234567890. If the Google group is restored, this identifier reverts to the standard identifier for a Google group.
• principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}: A Google Cloud service account. For example, principal://iam.googleapis.com/projects/-/serviceAccounts/[e-mail].
• deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}: A Google Cloud service account that was deleted recently. For example, deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/[e-mail]?uid=1234567890. If the service account is undeleted, this identifier reverts to the standard identifier for a service account.
• principalSet://goog/cloudIdentityCustomerId/{customer_id}: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, principalSet://goog/cloudIdentityCustomerId/C01Abc35.

repeated string denied_principals = 1;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the deniedPrincipals at the given index.

getDeniedPrincipalsCount()

public abstract int getDeniedPrincipalsCount()

The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values:

• principalSet://goog/public:all: A special identifier that represents any user who is on the internet, even if they do not have a Google Account or are not logged in.
• principal://goog/subject/{email_id}: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, principal://goog/subject/[e-mail].
• deleted:principal://goog/subject/{email_id}?uid={uid}: A specific Google Account that was deleted recently. For example, deleted:principal://goog/subject/[e-mail]?uid=1234567890. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account.
• principalSet://goog/group/{group_id}: A Google group. For example, principalSet://goog/group/[e-mail].
• deleted:principalSet://goog/group/{group_id}?uid={uid}: A Google group that was deleted recently. For example, deleted:principalSet://goog/group/[e-mail]?uid=1234567890. If the Google group is restored, this identifier reverts to the standard identifier for a Google group.
• principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}: A Google Cloud service account. For example, principal://iam.googleapis.com/projects/-/serviceAccounts/[e-mail].
• deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}: A Google Cloud service account that was deleted recently. For example, deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/[e-mail]?uid=1234567890. If the service account is undeleted, this identifier reverts to the standard identifier for a service account.
• principalSet://goog/cloudIdentityCustomerId/{customer_id}: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, principalSet://goog/cloudIdentityCustomerId/C01Abc35.

repeated string denied_principals = 1;

Returns

Type	Description
int	The count of deniedPrincipals.

getDeniedPrincipalsList()

public abstract List<String> getDeniedPrincipalsList()

The identities that are prevented from using one or more permissions on Google Cloud resources. This field can contain the following values:

• principalSet://goog/public:all: A special identifier that represents any user who is on the internet, even if they do not have a Google Account or are not logged in.
• principal://goog/subject/{email_id}: A specific Google Account. Includes Gmail, Cloud Identity, and Google Workspace user accounts. For example, principal://goog/subject/[e-mail].
• deleted:principal://goog/subject/{email_id}?uid={uid}: A specific Google Account that was deleted recently. For example, deleted:principal://goog/subject/[e-mail]?uid=1234567890. If the Google Account is recovered, this identifier reverts to the standard identifier for a Google Account.
• principalSet://goog/group/{group_id}: A Google group. For example, principalSet://goog/group/[e-mail].
• deleted:principalSet://goog/group/{group_id}?uid={uid}: A Google group that was deleted recently. For example, deleted:principalSet://goog/group/[e-mail]?uid=1234567890. If the Google group is restored, this identifier reverts to the standard identifier for a Google group.
• principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}: A Google Cloud service account. For example, principal://iam.googleapis.com/projects/-/serviceAccounts/[e-mail].
• deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/{service_account_id}?uid={uid}: A Google Cloud service account that was deleted recently. For example, deleted:principal://iam.googleapis.com/projects/-/serviceAccounts/[e-mail]?uid=1234567890. If the service account is undeleted, this identifier reverts to the standard identifier for a service account.
• principalSet://goog/cloudIdentityCustomerId/{customer_id}: All of the principals associated with the specified Google Workspace or Cloud Identity customer ID. For example, principalSet://goog/cloudIdentityCustomerId/C01Abc35.

repeated string denied_principals = 1;

Returns

Type	Description
List<String>	A list containing the deniedPrincipals.

getExceptionPermissions(int index)

public abstract String getExceptionPermissions(int index)

Specifies the permissions that this rule excludes from the set of denied permissions given by denied_permissions. If a permission appears in denied_permissions and in exception_permissions then it will not be denied. The excluded permissions can be specified using the same syntax as denied_permissions.

repeated string exception_permissions = 4;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The exceptionPermissions at the given index.

getExceptionPermissionsBytes(int index)

public abstract ByteString getExceptionPermissionsBytes(int index)

Specifies the permissions that this rule excludes from the set of denied permissions given by denied_permissions. If a permission appears in denied_permissions and in exception_permissions then it will not be denied. The excluded permissions can be specified using the same syntax as denied_permissions.

repeated string exception_permissions = 4;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the exceptionPermissions at the given index.

getExceptionPermissionsCount()

public abstract int getExceptionPermissionsCount()

Specifies the permissions that this rule excludes from the set of denied permissions given by denied_permissions. If a permission appears in denied_permissions and in exception_permissions then it will not be denied. The excluded permissions can be specified using the same syntax as denied_permissions.

repeated string exception_permissions = 4;

Returns

Type	Description
int	The count of exceptionPermissions.

getExceptionPermissionsList()

public abstract List<String> getExceptionPermissionsList()

Specifies the permissions that this rule excludes from the set of denied permissions given by denied_permissions. If a permission appears in denied_permissions and in exception_permissions then it will not be denied. The excluded permissions can be specified using the same syntax as denied_permissions.

repeated string exception_permissions = 4;

Returns

Type	Description
List<String>	A list containing the exceptionPermissions.

getExceptionPrincipals(int index)

public abstract String getExceptionPrincipals(int index)

The identities that are excluded from the deny rule, even if they are listed in the denied_principals. For example, you could add a Google group to the denied_principals, then exclude specific users who belong to that group. This field can contain the same values as the denied_principals field, excluding principalSet://goog/public:all, which represents all users on the internet.

repeated string exception_principals = 2;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The exceptionPrincipals at the given index.

getExceptionPrincipalsBytes(int index)

public abstract ByteString getExceptionPrincipalsBytes(int index)

The identities that are excluded from the deny rule, even if they are listed in the denied_principals. For example, you could add a Google group to the denied_principals, then exclude specific users who belong to that group. This field can contain the same values as the denied_principals field, excluding principalSet://goog/public:all, which represents all users on the internet.

repeated string exception_principals = 2;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the exceptionPrincipals at the given index.

getExceptionPrincipalsCount()

public abstract int getExceptionPrincipalsCount()

The identities that are excluded from the deny rule, even if they are listed in the denied_principals. For example, you could add a Google group to the denied_principals, then exclude specific users who belong to that group. This field can contain the same values as the denied_principals field, excluding principalSet://goog/public:all, which represents all users on the internet.

repeated string exception_principals = 2;

Returns

Type	Description
int	The count of exceptionPrincipals.

getExceptionPrincipalsList()

public abstract List<String> getExceptionPrincipalsList()

The identities that are excluded from the deny rule, even if they are listed in the denied_principals. For example, you could add a Google group to the denied_principals, then exclude specific users who belong to that group. This field can contain the same values as the denied_principals field, excluding principalSet://goog/public:all, which represents all users on the internet.

repeated string exception_principals = 2;

Returns

Type	Description
List<String>	A list containing the exceptionPrincipals.

hasDenialCondition()

public abstract boolean hasDenialCondition()

The condition that determines whether this deny rule applies to a request. If the condition expression evaluates to true, then the deny rule is applied; otherwise, the deny rule is not applied. Each deny rule is evaluated independently. If this deny rule does not apply to a request, other deny rules might still apply. The condition can use CEL functions that evaluate resource tags. Other functions and operators are not supported.

.google.type.Expr denial_condition = 5;

Returns

Type	Description
boolean	Whether the denialCondition field is set.