Package com.google.cloud.networksecurity.v1

Interface AuthzPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AuthzPolicy, AuthzPolicy.Builder
@Generated public interface AuthzPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The timestamp when the resource was created.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The timestamp when the resource was created.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The timestamp when the resource was created.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The timestamp when the resource was updated.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The timestamp when the resource was updated.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The timestamp when the resource was updated.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDescription

      String getDescription()
       Optional. A human-readable description of the resource.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A human-readable description of the resource.
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getLabelsCount

      int getLabelsCount()
       Optional. Set of labels associated with the `AuthzPolicy` resource.

 The format must comply with [the following
 requirements](/compute/docs/labeling-resources#requirements).
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • containsLabels

      boolean containsLabels(String key)
       Optional. Set of labels associated with the `AuthzPolicy` resource.

 The format must comply with [the following
 requirements](/compute/docs/labeling-resources#requirements).
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. Set of labels associated with the `AuthzPolicy` resource.

 The format must comply with [the following
 requirements](/compute/docs/labeling-resources#requirements).
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional. Set of labels associated with the `AuthzPolicy` resource.

 The format must comply with [the following
 requirements](/compute/docs/labeling-resources#requirements).
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. Set of labels associated with the `AuthzPolicy` resource.

 The format must comply with [the following
 requirements](/compute/docs/labeling-resources#requirements).
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

    • hasTarget

      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:
      Whether the target field is set.

    • getTarget

      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:
      The target.

    • getTargetOrBuilder

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

    • getHttpRulesList

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

    • getHttpRules

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

    • getHttpRulesCount

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

    • getHttpRulesOrBuilderList

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

    • getHttpRulesOrBuilder

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

    • getActionValue

      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:
      The enum numeric value on the wire for action.

    • getAction

      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:
      The action.

    • hasCustomProvider

      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:
      Whether the customProvider field is set.

    • getCustomProvider

      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:
      The customProvider.

    • getCustomProviderOrBuilder

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

    • getPolicyProfileValue

      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:
      The enum numeric value on the wire for policyProfile.

    • getPolicyProfile

      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:
      The policyProfile.