Class AuthorizationPolicy

  • All Implemented Interfaces:
    AuthorizationPolicyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class AuthorizationPolicy
    extends com.google.protobuf.GeneratedMessageV3
    implements AuthorizationPolicyOrBuilder
     AuthorizationPolicy is a resource that specifies how a server
     should authorize incoming connections. This resource in itself does
     not change the configuration unless it's attached to a target https
     proxy or endpoint config selector resource.
     
    Protobuf type google.cloud.networksecurity.v1beta1.AuthorizationPolicy
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getName

        public String getName()
         Required. Name of the AuthorizationPolicy resource. It matches pattern
         `projects/{project}/locations/{location}/authorizationPolicies/<authorization_policy>`.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getName in interface AuthorizationPolicyOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. Name of the AuthorizationPolicy resource. It matches pattern
         `projects/{project}/locations/{location}/authorizationPolicies/<authorization_policy>`.
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNameBytes in interface AuthorizationPolicyOrBuilder
        Returns:
        The bytes for name.
      • getDescription

        public String getDescription()
         Optional. Free-text description of the resource.
         
        string description = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescription in interface AuthorizationPolicyOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         Optional. Free-text description of the resource.
         
        string description = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDescriptionBytes in interface AuthorizationPolicyOrBuilder
        Returns:
        The bytes for description.
      • hasCreateTime

        public boolean hasCreateTime()
         Output only. The timestamp when the resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface AuthorizationPolicyOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. The timestamp when the resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface AuthorizationPolicyOrBuilder
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The timestamp when the resource was created.
         
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface AuthorizationPolicyOrBuilder
      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. The timestamp when the resource was updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface AuthorizationPolicyOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. The timestamp when the resource was updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface AuthorizationPolicyOrBuilder
        Returns:
        The updateTime.
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The timestamp when the resource was updated.
         
        .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface AuthorizationPolicyOrBuilder
      • containsLabels

        public boolean containsLabels​(String key)
         Optional. Set of label tags associated with the AuthorizationPolicy
         resource.
         
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        containsLabels in interface AuthorizationPolicyOrBuilder
      • getLabelsMap

        public Map<String,​String> getLabelsMap()
         Optional. Set of label tags associated with the AuthorizationPolicy
         resource.
         
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsMap in interface AuthorizationPolicyOrBuilder
      • getLabelsOrDefault

        public String getLabelsOrDefault​(String key,
                                         String defaultValue)
         Optional. Set of label tags associated with the AuthorizationPolicy
         resource.
         
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrDefault in interface AuthorizationPolicyOrBuilder
      • getLabelsOrThrow

        public String getLabelsOrThrow​(String key)
         Optional. Set of label tags associated with the AuthorizationPolicy
         resource.
         
        map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getLabelsOrThrow in interface AuthorizationPolicyOrBuilder
      • getActionValue

        public int getActionValue()
         Required. The action to take when a rule match is found. Possible values
         are "ALLOW" or "DENY".
         
        .google.cloud.networksecurity.v1beta1.AuthorizationPolicy.Action action = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getActionValue in interface AuthorizationPolicyOrBuilder
        Returns:
        The enum numeric value on the wire for action.
      • getAction

        public AuthorizationPolicy.Action getAction()
         Required. The action to take when a rule match is found. Possible values
         are "ALLOW" or "DENY".
         
        .google.cloud.networksecurity.v1beta1.AuthorizationPolicy.Action action = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getAction in interface AuthorizationPolicyOrBuilder
        Returns:
        The action.
      • getRulesList

        public List<AuthorizationPolicy.Rule> getRulesList()
         Optional. List of rules to match. Note that at least one of the rules must
         match in order for the action specified in the 'action' field to be taken.
         A rule is a match if there is a matching source and destination. If left
         blank, the action specified in the `action` field will be applied on every
         request.
         
        repeated .google.cloud.networksecurity.v1beta1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRulesList in interface AuthorizationPolicyOrBuilder
      • getRulesOrBuilderList

        public List<? extends AuthorizationPolicy.RuleOrBuilder> getRulesOrBuilderList()
         Optional. List of rules to match. Note that at least one of the rules must
         match in order for the action specified in the 'action' field to be taken.
         A rule is a match if there is a matching source and destination. If left
         blank, the action specified in the `action` field will be applied on every
         request.
         
        repeated .google.cloud.networksecurity.v1beta1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRulesOrBuilderList in interface AuthorizationPolicyOrBuilder
      • getRulesCount

        public int getRulesCount()
         Optional. List of rules to match. Note that at least one of the rules must
         match in order for the action specified in the 'action' field to be taken.
         A rule is a match if there is a matching source and destination. If left
         blank, the action specified in the `action` field will be applied on every
         request.
         
        repeated .google.cloud.networksecurity.v1beta1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRulesCount in interface AuthorizationPolicyOrBuilder
      • getRules

        public AuthorizationPolicy.Rule getRules​(int index)
         Optional. List of rules to match. Note that at least one of the rules must
         match in order for the action specified in the 'action' field to be taken.
         A rule is a match if there is a matching source and destination. If left
         blank, the action specified in the `action` field will be applied on every
         request.
         
        repeated .google.cloud.networksecurity.v1beta1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRules in interface AuthorizationPolicyOrBuilder
      • getRulesOrBuilder

        public AuthorizationPolicy.RuleOrBuilder getRulesOrBuilder​(int index)
         Optional. List of rules to match. Note that at least one of the rules must
         match in order for the action specified in the 'action' field to be taken.
         A rule is a match if there is a matching source and destination. If left
         blank, the action specified in the `action` field will be applied on every
         request.
         
        repeated .google.cloud.networksecurity.v1beta1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRulesOrBuilder in interface AuthorizationPolicyOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static AuthorizationPolicy parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AuthorizationPolicy parseFrom​(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AuthorizationPolicy parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AuthorizationPolicy parseFrom​(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AuthorizationPolicy parseFrom​(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AuthorizationPolicy parseFrom​(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static AuthorizationPolicy parseFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Throws:
        IOException
      • newBuilderForType

        public AuthorizationPolicy.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public AuthorizationPolicy.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected AuthorizationPolicy.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<AuthorizationPolicy> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public AuthorizationPolicy getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder