Interface AuthzPolicyOrBuilder (0.94.0)

0.94.0 (latest) 0.91.0 0.90.0 0.88.0 0.86.0 0.85.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.75.0 0.73.0 0.71.0 0.70.0 0.67.0 0.66.0 0.65.0 0.63.0 0.62.0 0.61.0 0.60.0 0.59.0 0.58.0 0.57.0 0.56.0 0.55.0 0.54.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.4 0.5.1 0.4.4

public interface AuthzPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Set of labels associated with the AuthzPolicy resource.

The format must comply with the following requirements.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getAction()

public abstract AuthzPolicy.AuthzAction getAction()

Required. Can be one of ALLOW, DENY, CUSTOM.

When the action is CUSTOM, customProvider must be specified.

When the action is ALLOW, only requests matching the policy will be allowed.

When the action is DENY, only requests matching the policy will be denied.

When a request arrives, the policies are evaluated in the following order:

1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request.

2. If there are any DENY policies that match the request, the request is denied.

3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed.

4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.

.google.cloud.networksecurity.v1.AuthzPolicy.AuthzAction action = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AuthzPolicy.AuthzAction	The action.

getActionValue()

public abstract int getActionValue()

Required. Can be one of ALLOW, DENY, CUSTOM.

When the action is CUSTOM, customProvider must be specified.

When the action is ALLOW, only requests matching the policy will be allowed.

When the action is DENY, only requests matching the policy will be denied.

When a request arrives, the policies are evaluated in the following order:

1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request.

2. If there are any DENY policies that match the request, the request is denied.

3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed.

4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.

.google.cloud.networksecurity.v1.AuthzPolicy.AuthzAction action = 8 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for action.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCustomProvider()

public abstract AuthzPolicy.CustomProvider getCustomProvider()

Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified.

.google.cloud.networksecurity.v1.AuthzPolicy.CustomProvider custom_provider = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AuthzPolicy.CustomProvider	The customProvider.

getCustomProviderOrBuilder()

public abstract AuthzPolicy.CustomProviderOrBuilder getCustomProviderOrBuilder()

Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified.

.google.cloud.networksecurity.v1.AuthzPolicy.CustomProvider custom_provider = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
AuthzPolicy.CustomProviderOrBuilder

getDescription()

public abstract String getDescription()

Optional. A human-readable description of the resource.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. A human-readable description of the resource.

string description = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for description.

getHttpRules(int index)

public abstract AuthzPolicy.AuthzRule getHttpRules(int index)

Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules.

repeated .google.cloud.networksecurity.v1.AuthzPolicy.AuthzRule http_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
AuthzPolicy.AuthzRule

getHttpRulesCount()

public abstract int getHttpRulesCount()

Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules.

repeated .google.cloud.networksecurity.v1.AuthzPolicy.AuthzRule http_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getHttpRulesList()

public abstract List<AuthzPolicy.AuthzRule> getHttpRulesList()

Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules.

repeated .google.cloud.networksecurity.v1.AuthzPolicy.AuthzRule http_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<AuthzRule>

getHttpRulesOrBuilder(int index)

public abstract AuthzPolicy.AuthzRuleOrBuilder getHttpRulesOrBuilder(int index)

Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules.

repeated .google.cloud.networksecurity.v1.AuthzPolicy.AuthzRule http_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
AuthzPolicy.AuthzRuleOrBuilder

getHttpRulesOrBuilderList()

public abstract List<? extends AuthzPolicy.AuthzRuleOrBuilder> getHttpRulesOrBuilderList()

Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. Limited to 5 rules.

repeated .google.cloud.networksecurity.v1.AuthzPolicy.AuthzRule http_rules = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<? extends com.google.cloud.networksecurity.v1.AuthzPolicy.AuthzRuleOrBuilder>

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Set of labels associated with the AuthzPolicy resource.

The format must comply with the following requirements.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Set of labels associated with the AuthzPolicy resource.

The format must comply with the following requirements.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Set of labels associated with the AuthzPolicy resource.

The format must comply with the following requirements.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Set of labels associated with the AuthzPolicy resource.

The format must comply with the following requirements.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
key	String

Returns
Type	Description
String

getName()

public abstract String getName()

Required. Identifier. Name of the AuthzPolicy resource in the following format: projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. Identifier. Name of the AuthzPolicy resource in the following format: projects/{project}/locations/{location}/authzPolicies/{authz_policy}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getPolicyProfile()

public abstract AuthzPolicy.PolicyProfile getPolicyProfile()

Optional. Immutable. Defines the type of authorization being performed. If not specified, REQUEST_AUTHZ is applied. This field cannot be changed once AuthzPolicy is created.

.google.cloud.networksecurity.v1.AuthzPolicy.PolicyProfile policy_profile = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
AuthzPolicy.PolicyProfile	The policyProfile.

getPolicyProfileValue()

public abstract int getPolicyProfileValue()

Optional. Immutable. Defines the type of authorization being performed. If not specified, REQUEST_AUTHZ is applied. This field cannot be changed once AuthzPolicy is created.

.google.cloud.networksecurity.v1.AuthzPolicy.PolicyProfile policy_profile = 11 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int	The enum numeric value on the wire for policyProfile.

getTarget()

public abstract AuthzPolicy.Target getTarget()

Required. Specifies the set of resources to which this policy should be applied to.

.google.cloud.networksecurity.v1.AuthzPolicy.Target target = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AuthzPolicy.Target	The target.

getTargetOrBuilder()

public abstract AuthzPolicy.TargetOrBuilder getTargetOrBuilder()

Required. Specifies the set of resources to which this policy should be applied to.

.google.cloud.networksecurity.v1.AuthzPolicy.Target target = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
AuthzPolicy.TargetOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasCustomProvider()

public abstract boolean hasCustomProvider()

Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified.

.google.cloud.networksecurity.v1.AuthzPolicy.CustomProvider custom_provider = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the customProvider field is set.

hasTarget()

public abstract boolean hasTarget()

Required. Specifies the set of resources to which this policy should be applied to.

.google.cloud.networksecurity.v1.AuthzPolicy.Target target = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the target field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.