public final class AuthorizationPolicy extends 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.v1.AuthorizationPolicy
Static Fields
ACTION_FIELD_NUMBER
public static final int ACTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static AuthorizationPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AuthorizationPolicy.Builder newBuilder()
newBuilder(AuthorizationPolicy prototype)
public static AuthorizationPolicy.Builder newBuilder(AuthorizationPolicy prototype)
public static AuthorizationPolicy parseDelimitedFrom(InputStream input)
public static AuthorizationPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AuthorizationPolicy parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuthorizationPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AuthorizationPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthorizationPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthorizationPolicy parseFrom(CodedInputStream input)
public static AuthorizationPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthorizationPolicy parseFrom(InputStream input)
public static AuthorizationPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AuthorizationPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuthorizationPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AuthorizationPolicy> parser()
Methods
containsLabels(String key)
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];
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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];
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];
| 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 = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public AuthorizationPolicy getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. Free-text description of the resource.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. Free-text description of the resource.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. Set of label tags associated with the AuthorizationPolicy resource.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | |
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];
getLabelsOrDefault(String key, String defaultValue)
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];
getLabelsOrThrow(String key)
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];
| Parameter |
|---|
| Name | Description |
key | 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];
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<AuthorizationPolicy> getParserForType()
Overrides
getRules(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
int | |
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];
getRulesOrBuilder(int index)
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];
| Parameter |
|---|
| Name | Description |
index | int
|
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];
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.networksecurity.v1.AuthorizationPolicy.RuleOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
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];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AuthorizationPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuthorizationPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AuthorizationPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
