public final class SecurityPolicy extends GeneratedMessageV3 implements SecurityPolicyOrBuilder
Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview.
Protobuf type google.cloud.compute.v1.SecurityPolicy
Static Fields
ADAPTIVE_PROTECTION_CONFIG_FIELD_NUMBER
public static final int ADAPTIVE_PROTECTION_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ADVANCED_OPTIONS_CONFIG_FIELD_NUMBER
public static final int ADVANCED_OPTIONS_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DDOS_PROTECTION_CONFIG_FIELD_NUMBER
public static final int DDOS_PROTECTION_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECAPTCHA_OPTIONS_CONFIG_FIELD_NUMBER
public static final int RECAPTCHA_OPTIONS_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static SecurityPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SecurityPolicy.Builder newBuilder()
newBuilder(SecurityPolicy prototype)
public static SecurityPolicy.Builder newBuilder(SecurityPolicy prototype)
public static SecurityPolicy parseDelimitedFrom(InputStream input)
public static SecurityPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SecurityPolicy parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SecurityPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicy parseFrom(CodedInputStream input)
public static SecurityPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicy parseFrom(InputStream input)
public static SecurityPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SecurityPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SecurityPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SecurityPolicy> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAdaptiveProtectionConfig()
public SecurityPolicyAdaptiveProtectionConfig getAdaptiveProtectionConfig()
optional .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfig adaptive_protection_config = 150240735;
getAdaptiveProtectionConfigOrBuilder()
public SecurityPolicyAdaptiveProtectionConfigOrBuilder getAdaptiveProtectionConfigOrBuilder()
optional .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfig adaptive_protection_config = 150240735;
getAdvancedOptionsConfig()
public SecurityPolicyAdvancedOptionsConfig getAdvancedOptionsConfig()
optional .google.cloud.compute.v1.SecurityPolicyAdvancedOptionsConfig advanced_options_config = 449276352;
getAdvancedOptionsConfigOrBuilder()
public SecurityPolicyAdvancedOptionsConfigOrBuilder getAdvancedOptionsConfigOrBuilder()
optional .google.cloud.compute.v1.SecurityPolicyAdvancedOptionsConfig advanced_options_config = 449276352;
getCreationTimestamp()
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns |
|---|
| Type | Description |
String | The creationTimestamp.
|
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for creationTimestamp.
|
getDdosProtectionConfig()
public SecurityPolicyDdosProtectionConfig getDdosProtectionConfig()
optional .google.cloud.compute.v1.SecurityPolicyDdosProtectionConfig ddos_protection_config = 50315853;
getDdosProtectionConfigOrBuilder()
public SecurityPolicyDdosProtectionConfigOrBuilder getDdosProtectionConfigOrBuilder()
optional .google.cloud.compute.v1.SecurityPolicyDdosProtectionConfig ddos_protection_config = 50315853;
getDefaultInstanceForType()
public SecurityPolicy getDefaultInstanceForType()
getDescription()
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getFingerprint()
public String getFingerprint()
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
optional string fingerprint = 234678500;
| Returns |
|---|
| Type | Description |
String | The fingerprint.
|
getFingerprintBytes()
public ByteString getFingerprintBytes()
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
optional string fingerprint = 234678500;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for fingerprint.
|
getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns |
|---|
| Type | Description |
long | The id.
|
getKind()
[Output only] Type of the resource. Always compute#securityPolicyfor security policies
optional string kind = 3292052;
| Returns |
|---|
| Type | Description |
String | The kind.
|
getKindBytes()
public ByteString getKindBytes()
[Output only] Type of the resource. Always compute#securityPolicyfor security policies
optional string kind = 3292052;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for kind.
|
getName()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<SecurityPolicy> getParserForType()
Overrides
getRecaptchaOptionsConfig()
public SecurityPolicyRecaptchaOptionsConfig getRecaptchaOptionsConfig()
optional .google.cloud.compute.v1.SecurityPolicyRecaptchaOptionsConfig recaptcha_options_config = 519006811;
getRecaptchaOptionsConfigOrBuilder()
public SecurityPolicyRecaptchaOptionsConfigOrBuilder getRecaptchaOptionsConfigOrBuilder()
optional .google.cloud.compute.v1.SecurityPolicyRecaptchaOptionsConfig recaptcha_options_config = 519006811;
getRegion()
public String getRegion()
[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
optional string region = 138946292;
| Returns |
|---|
| Type | Description |
String | The region.
|
getRegionBytes()
public ByteString getRegionBytes()
[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
optional string region = 138946292;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for region.
|
getRules(int index)
public SecurityPolicyRule getRules(int index)
A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "" for srcIpRanges and for the networkMatch condition every field must be either match "" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
repeated .google.cloud.compute.v1.SecurityPolicyRule rules = 108873975;
| Parameter |
|---|
| Name | Description |
index | int
|
getRulesCount()
public int getRulesCount()
A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "" for srcIpRanges and for the networkMatch condition every field must be either match "" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
repeated .google.cloud.compute.v1.SecurityPolicyRule rules = 108873975;
| Returns |
|---|
| Type | Description |
int | |
getRulesList()
public List<SecurityPolicyRule> getRulesList()
A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "" for srcIpRanges and for the networkMatch condition every field must be either match "" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
repeated .google.cloud.compute.v1.SecurityPolicyRule rules = 108873975;
getRulesOrBuilder(int index)
public SecurityPolicyRuleOrBuilder getRulesOrBuilder(int index)
A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "" for srcIpRanges and for the networkMatch condition every field must be either match "" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
repeated .google.cloud.compute.v1.SecurityPolicyRule rules = 108873975;
| Parameter |
|---|
| Name | Description |
index | int
|
getRulesOrBuilderList()
public List<? extends SecurityPolicyRuleOrBuilder> getRulesOrBuilderList()
A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "" for srcIpRanges and for the networkMatch condition every field must be either match "" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added.
repeated .google.cloud.compute.v1.SecurityPolicyRule rules = 108873975;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.compute.v1.SecurityPolicyRuleOrBuilder> | |
getSelfLink()
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns |
|---|
| Type | Description |
String | The selfLink.
|
getSelfLinkBytes()
public ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for selfLink.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getType()
The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.
Check the Type enum for the list of possible values.
optional string type = 3575610;
| Returns |
|---|
| Type | Description |
String | The type.
|
getTypeBytes()
public ByteString getTypeBytes()
The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.
Check the Type enum for the list of possible values.
optional string type = 3575610;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hasAdaptiveProtectionConfig()
public boolean hasAdaptiveProtectionConfig()
optional .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfig adaptive_protection_config = 150240735;
| Returns |
|---|
| Type | Description |
boolean | Whether the adaptiveProtectionConfig field is set.
|
hasAdvancedOptionsConfig()
public boolean hasAdvancedOptionsConfig()
optional .google.cloud.compute.v1.SecurityPolicyAdvancedOptionsConfig advanced_options_config = 449276352;
| Returns |
|---|
| Type | Description |
boolean | Whether the advancedOptionsConfig field is set.
|
hasCreationTimestamp()
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns |
|---|
| Type | Description |
boolean | Whether the creationTimestamp field is set.
|
hasDdosProtectionConfig()
public boolean hasDdosProtectionConfig()
optional .google.cloud.compute.v1.SecurityPolicyDdosProtectionConfig ddos_protection_config = 50315853;
| Returns |
|---|
| Type | Description |
boolean | Whether the ddosProtectionConfig field is set.
|
hasDescription()
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns |
|---|
| Type | Description |
boolean | Whether the description field is set.
|
hasFingerprint()
public boolean hasFingerprint()
Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy.
optional string fingerprint = 234678500;
| Returns |
|---|
| Type | Description |
boolean | Whether the fingerprint field is set.
|
hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns |
|---|
| Type | Description |
boolean | Whether the id field is set.
|
hasKind()
[Output only] Type of the resource. Always compute#securityPolicyfor security policies
optional string kind = 3292052;
| Returns |
|---|
| Type | Description |
boolean | Whether the kind field is set.
|
hasName()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;
| Returns |
|---|
| Type | Description |
boolean | Whether the name field is set.
|
hasRecaptchaOptionsConfig()
public boolean hasRecaptchaOptionsConfig()
optional .google.cloud.compute.v1.SecurityPolicyRecaptchaOptionsConfig recaptcha_options_config = 519006811;
| Returns |
|---|
| Type | Description |
boolean | Whether the recaptchaOptionsConfig field is set.
|
hasRegion()
public boolean hasRegion()
[Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
optional string region = 138946292;
| Returns |
|---|
| Type | Description |
boolean | Whether the region field is set.
|
hasSelfLink()
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns |
|---|
| Type | Description |
boolean | Whether the selfLink field is set.
|
hasType()
The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time.
Check the Type enum for the list of possible values.
optional string type = 3575610;
| Returns |
|---|
| Type | Description |
boolean | Whether the type field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SecurityPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SecurityPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public SecurityPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
