Class AuthzPolicy.Builder (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 static final class AuthzPolicy.Builder extends GeneratedMessage.Builder<AuthzPolicy.Builder> implements AuthzPolicyOrBuilder

AuthzPolicy is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.

Protobuf type google.cloud.networksecurity.v1.AuthzPolicy

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AuthzPolicy.Builder

Implements

AuthzPolicyOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllHttpRules(Iterable<? extends AuthzPolicy.AuthzRule> values)

public AuthzPolicy.Builder addAllHttpRules(Iterable<? extends AuthzPolicy.AuthzRule> values)

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
values	Iterable<? extends com.google.cloud.networksecurity.v1.AuthzPolicy.AuthzRule>

Returns
Type	Description
AuthzPolicy.Builder

addHttpRules(AuthzPolicy.AuthzRule value)

public AuthzPolicy.Builder addHttpRules(AuthzPolicy.AuthzRule value)

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
value	AuthzPolicy.AuthzRule

Returns
Type	Description
AuthzPolicy.Builder

addHttpRules(AuthzPolicy.AuthzRule.Builder builderForValue)

public AuthzPolicy.Builder addHttpRules(AuthzPolicy.AuthzRule.Builder builderForValue)

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
builderForValue	AuthzPolicy.AuthzRule.Builder

Returns
Type	Description
AuthzPolicy.Builder

addHttpRules(int index, AuthzPolicy.AuthzRule value)

public AuthzPolicy.Builder addHttpRules(int index, AuthzPolicy.AuthzRule value)

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

Parameters
Name	Description
index	int
value	AuthzPolicy.AuthzRule

Returns
Type	Description
AuthzPolicy.Builder

addHttpRules(int index, AuthzPolicy.AuthzRule.Builder builderForValue)

public AuthzPolicy.Builder addHttpRules(int index, AuthzPolicy.AuthzRule.Builder builderForValue)

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

Parameters
Name	Description
index	int
builderForValue	AuthzPolicy.AuthzRule.Builder

Returns
Type	Description
AuthzPolicy.Builder

addHttpRulesBuilder()

public AuthzPolicy.AuthzRule.Builder addHttpRulesBuilder()

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
AuthzPolicy.AuthzRule.Builder

addHttpRulesBuilder(int index)

public AuthzPolicy.AuthzRule.Builder addHttpRulesBuilder(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.Builder

build()

public AuthzPolicy build()

Returns
Type	Description
AuthzPolicy

buildPartial()

public AuthzPolicy buildPartial()

Returns
Type	Description
AuthzPolicy

clear()

public AuthzPolicy.Builder clear()

Returns
Type	Description
AuthzPolicy.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAction()

public AuthzPolicy.Builder clearAction()

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.Builder	This builder for chaining.

clearCreateTime()

public AuthzPolicy.Builder clearCreateTime()

Output only. The timestamp when the resource was created.

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

Returns
Type	Description
AuthzPolicy.Builder

clearCustomProvider()

public AuthzPolicy.Builder clearCustomProvider()

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.Builder

clearDescription()

public AuthzPolicy.Builder clearDescription()

Optional. A human-readable description of the resource.

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

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

clearHttpRules()

public AuthzPolicy.Builder clearHttpRules()

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
AuthzPolicy.Builder

clearLabels()

public AuthzPolicy.Builder clearLabels()

Returns
Type	Description
AuthzPolicy.Builder

clearName()

public AuthzPolicy.Builder clearName()

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
AuthzPolicy.Builder	This builder for chaining.

clearPolicyProfile()

public AuthzPolicy.Builder clearPolicyProfile()

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.Builder	This builder for chaining.

clearTarget()

public AuthzPolicy.Builder clearTarget()

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.Builder

clearUpdateTime()

public AuthzPolicy.Builder clearUpdateTime()

Output only. The timestamp when the resource was updated.

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

Returns
Type	Description
AuthzPolicy.Builder

containsLabels(String key)

public 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 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 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 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The timestamp when the resource was created.

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

Returns
Type	Description
Builder

getCreateTimeOrBuilder()

public 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 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.

getCustomProviderBuilder()

public AuthzPolicy.CustomProvider.Builder getCustomProviderBuilder()

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.Builder

getCustomProviderOrBuilder()

public 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

getDefaultInstanceForType()

public AuthzPolicy getDefaultInstanceForType()

Returns
Type	Description
AuthzPolicy

getDescription()

public 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 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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getHttpRules(int index)

public 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

getHttpRulesBuilder(int index)

public AuthzPolicy.AuthzRule.Builder getHttpRulesBuilder(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.Builder

getHttpRulesBuilderList()

public List<AuthzPolicy.AuthzRule.Builder> getHttpRulesBuilderList()

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<Builder>

getHttpRulesCount()

public 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 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public 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 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 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 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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getName()

public 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 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 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 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 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.

getTargetBuilder()

public AuthzPolicy.Target.Builder getTargetBuilder()

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.Builder

getTargetOrBuilder()

public 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 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The timestamp when the resource was updated.

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

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

public AuthzPolicy.Builder mergeCreateTime(Timestamp value)

Output only. The timestamp when the resource was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthzPolicy.Builder

mergeCustomProvider(AuthzPolicy.CustomProvider value)

public AuthzPolicy.Builder mergeCustomProvider(AuthzPolicy.CustomProvider value)

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

Parameter
Name	Description
value	AuthzPolicy.CustomProvider

Returns
Type	Description
AuthzPolicy.Builder

mergeFrom(AuthzPolicy other)

public AuthzPolicy.Builder mergeFrom(AuthzPolicy other)

Parameter
Name	Description
other	AuthzPolicy

Returns
Type	Description
AuthzPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuthzPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AuthzPolicy.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public AuthzPolicy.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
AuthzPolicy.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeTarget(AuthzPolicy.Target value)

public AuthzPolicy.Builder mergeTarget(AuthzPolicy.Target value)

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

Parameter
Name	Description
value	AuthzPolicy.Target

Returns
Type	Description
AuthzPolicy.Builder

mergeUpdateTime(Timestamp value)

public AuthzPolicy.Builder mergeUpdateTime(Timestamp value)

Output only. The timestamp when the resource was updated.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthzPolicy.Builder

putAllLabels(Map<String,String> values)

public AuthzPolicy.Builder putAllLabels(Map<String,String> values)

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
values	Map<String,String>

Returns
Type	Description
AuthzPolicy.Builder

putLabels(String key, String value)

public AuthzPolicy.Builder putLabels(String key, String value)

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
value	String

Returns
Type	Description
AuthzPolicy.Builder

removeHttpRules(int index)

public AuthzPolicy.Builder removeHttpRules(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.Builder

removeLabels(String key)

public AuthzPolicy.Builder removeLabels(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
AuthzPolicy.Builder

setAction(AuthzPolicy.AuthzAction value)

public AuthzPolicy.Builder setAction(AuthzPolicy.AuthzAction value)

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

Parameter
Name	Description
value	AuthzPolicy.AuthzAction The action to set.

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

setActionValue(int value)

public AuthzPolicy.Builder setActionValue(int value)

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

Parameter
Name	Description
value	int The enum numeric value on the wire for action to set.

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

setCreateTime(Timestamp value)

public AuthzPolicy.Builder setCreateTime(Timestamp value)

Output only. The timestamp when the resource was created.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthzPolicy.Builder

setCreateTime(Timestamp.Builder builderForValue)

public AuthzPolicy.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when the resource was created.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
AuthzPolicy.Builder

setCustomProvider(AuthzPolicy.CustomProvider value)

public AuthzPolicy.Builder setCustomProvider(AuthzPolicy.CustomProvider value)

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

Parameter
Name	Description
value	AuthzPolicy.CustomProvider

Returns
Type	Description
AuthzPolicy.Builder

setCustomProvider(AuthzPolicy.CustomProvider.Builder builderForValue)

public AuthzPolicy.Builder setCustomProvider(AuthzPolicy.CustomProvider.Builder builderForValue)

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

Parameter
Name	Description
builderForValue	AuthzPolicy.CustomProvider.Builder

Returns
Type	Description
AuthzPolicy.Builder

setDescription(String value)

public AuthzPolicy.Builder setDescription(String value)

Optional. A human-readable description of the resource.

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

Parameter
Name	Description
value	String The description to set.

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public AuthzPolicy.Builder setDescriptionBytes(ByteString value)

Optional. A human-readable description of the resource.

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

Parameter
Name	Description
value	ByteString The bytes for description to set.

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

setHttpRules(int index, AuthzPolicy.AuthzRule value)

public AuthzPolicy.Builder setHttpRules(int index, AuthzPolicy.AuthzRule value)

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

Parameters
Name	Description
index	int
value	AuthzPolicy.AuthzRule

Returns
Type	Description
AuthzPolicy.Builder

setHttpRules(int index, AuthzPolicy.AuthzRule.Builder builderForValue)

public AuthzPolicy.Builder setHttpRules(int index, AuthzPolicy.AuthzRule.Builder builderForValue)

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

Parameters
Name	Description
index	int
builderForValue	AuthzPolicy.AuthzRule.Builder

Returns
Type	Description
AuthzPolicy.Builder

setName(String value)

public AuthzPolicy.Builder setName(String value)

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

setNameBytes(ByteString value)

public AuthzPolicy.Builder setNameBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

setPolicyProfile(AuthzPolicy.PolicyProfile value)

public AuthzPolicy.Builder setPolicyProfile(AuthzPolicy.PolicyProfile value)

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

Parameter
Name	Description
value	AuthzPolicy.PolicyProfile The policyProfile to set.

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

setPolicyProfileValue(int value)

public AuthzPolicy.Builder setPolicyProfileValue(int value)

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

Parameter
Name	Description
value	int The enum numeric value on the wire for policyProfile to set.

Returns
Type	Description
AuthzPolicy.Builder	This builder for chaining.

setTarget(AuthzPolicy.Target value)

public AuthzPolicy.Builder setTarget(AuthzPolicy.Target value)

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

Parameter
Name	Description
value	AuthzPolicy.Target

Returns
Type	Description
AuthzPolicy.Builder

setTarget(AuthzPolicy.Target.Builder builderForValue)

public AuthzPolicy.Builder setTarget(AuthzPolicy.Target.Builder builderForValue)

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

Parameter
Name	Description
builderForValue	AuthzPolicy.Target.Builder

Returns
Type	Description
AuthzPolicy.Builder

setUpdateTime(Timestamp value)

public AuthzPolicy.Builder setUpdateTime(Timestamp value)

Output only. The timestamp when the resource was updated.

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

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
AuthzPolicy.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public AuthzPolicy.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The timestamp when the resource was updated.

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
AuthzPolicy.Builder