Class AuthorizationPolicy
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.networksecurity.v1.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 typegoogle.cloud.networksecurity.v1.AuthorizationPolicy
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AuthorizationPolicy.Action
Possible values that define what action to take.static class
AuthorizationPolicy.Builder
AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections.static class
AuthorizationPolicy.Rule
Specification of rules.static interface
AuthorizationPolicy.RuleOrBuilder
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
ACTION_FIELD_NUMBER
static int
CREATE_TIME_FIELD_NUMBER
static int
DESCRIPTION_FIELD_NUMBER
static int
LABELS_FIELD_NUMBER
static int
NAME_FIELD_NUMBER
static int
RULES_FIELD_NUMBER
static int
UPDATE_TIME_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
containsLabels(String key)
Optional.boolean
equals(Object obj)
AuthorizationPolicy.Action
getAction()
Required.int
getActionValue()
Required.com.google.protobuf.Timestamp
getCreateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getCreateTimeOrBuilder()
Output only.static AuthorizationPolicy
getDefaultInstance()
AuthorizationPolicy
getDefaultInstanceForType()
String
getDescription()
Optional.com.google.protobuf.ByteString
getDescriptionBytes()
Optional.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
Map<String,String>
getLabels()
Deprecated.int
getLabelsCount()
Optional.Map<String,String>
getLabelsMap()
Optional.String
getLabelsOrDefault(String key, String defaultValue)
Optional.String
getLabelsOrThrow(String key)
Optional.String
getName()
Required.com.google.protobuf.ByteString
getNameBytes()
Required.com.google.protobuf.Parser<AuthorizationPolicy>
getParserForType()
AuthorizationPolicy.Rule
getRules(int index)
Optional.int
getRulesCount()
Optional.List<AuthorizationPolicy.Rule>
getRulesList()
Optional.AuthorizationPolicy.RuleOrBuilder
getRulesOrBuilder(int index)
Optional.List<? extends AuthorizationPolicy.RuleOrBuilder>
getRulesOrBuilderList()
Optional.int
getSerializedSize()
com.google.protobuf.Timestamp
getUpdateTime()
Output only.com.google.protobuf.TimestampOrBuilder
getUpdateTimeOrBuilder()
Output only.boolean
hasCreateTime()
Output only.int
hashCode()
boolean
hasUpdateTime()
Output only.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static AuthorizationPolicy.Builder
newBuilder()
static AuthorizationPolicy.Builder
newBuilder(AuthorizationPolicy prototype)
AuthorizationPolicy.Builder
newBuilderForType()
protected AuthorizationPolicy.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AuthorizationPolicy
parseDelimitedFrom(InputStream input)
static AuthorizationPolicy
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthorizationPolicy
parseFrom(byte[] data)
static AuthorizationPolicy
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthorizationPolicy
parseFrom(com.google.protobuf.ByteString data)
static AuthorizationPolicy
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthorizationPolicy
parseFrom(com.google.protobuf.CodedInputStream input)
static AuthorizationPolicy
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthorizationPolicy
parseFrom(InputStream input)
static AuthorizationPolicy
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AuthorizationPolicy
parseFrom(ByteBuffer data)
static AuthorizationPolicy
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AuthorizationPolicy>
parser()
AuthorizationPolicy.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.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 classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.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 interfaceAuthorizationPolicyOrBuilder
- 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 interfaceAuthorizationPolicyOrBuilder
- 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 interfaceAuthorizationPolicyOrBuilder
- 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 interfaceAuthorizationPolicyOrBuilder
- 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 interfaceAuthorizationPolicyOrBuilder
- 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 interfaceAuthorizationPolicyOrBuilder
- 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 interfaceAuthorizationPolicyOrBuilder
-
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 interfaceAuthorizationPolicyOrBuilder
- 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 interfaceAuthorizationPolicyOrBuilder
- 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 interfaceAuthorizationPolicyOrBuilder
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:AuthorizationPolicyOrBuilder
Optional. Set of label tags associated with the AuthorizationPolicy resource.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getLabelsCount
in interfaceAuthorizationPolicyOrBuilder
-
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 interfaceAuthorizationPolicyOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()
instead.- Specified by:
getLabels
in interfaceAuthorizationPolicyOrBuilder
-
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 interfaceAuthorizationPolicyOrBuilder
-
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 interfaceAuthorizationPolicyOrBuilder
-
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 interfaceAuthorizationPolicyOrBuilder
-
getActionValue
public int getActionValue()
Required. The action to take when a rule match is found. Possible values are "ALLOW" or "DENY".
.google.cloud.networksecurity.v1.AuthorizationPolicy.Action action = 6 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getActionValue
in interfaceAuthorizationPolicyOrBuilder
- 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.v1.AuthorizationPolicy.Action action = 6 [(.google.api.field_behavior) = REQUIRED];
- Specified by:
getAction
in interfaceAuthorizationPolicyOrBuilder
- 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.v1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getRulesList
in interfaceAuthorizationPolicyOrBuilder
-
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.v1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getRulesOrBuilderList
in interfaceAuthorizationPolicyOrBuilder
-
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.v1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getRulesCount
in interfaceAuthorizationPolicyOrBuilder
-
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.v1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getRules
in interfaceAuthorizationPolicyOrBuilder
-
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.v1.AuthorizationPolicy.Rule rules = 7 [(.google.api.field_behavior) = OPTIONAL];
- Specified by:
getRulesOrBuilder
in interfaceAuthorizationPolicyOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.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(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static AuthorizationPolicy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static AuthorizationPolicy parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static AuthorizationPolicy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static AuthorizationPolicy parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
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 interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static AuthorizationPolicy.Builder newBuilder()
-
newBuilder
public static AuthorizationPolicy.Builder newBuilder(AuthorizationPolicy prototype)
-
toBuilder
public AuthorizationPolicy.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected AuthorizationPolicy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static AuthorizationPolicy getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<AuthorizationPolicy> parser()
-
getParserForType
public com.google.protobuf.Parser<AuthorizationPolicy> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public AuthorizationPolicy getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-