SecurityPolicy (Compute Engine API v1-rev20250810-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.SecurityPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class SecurityPolicy
extends com.google.api.client.json.GenericJson
```
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

SecurityPolicy()

Constructors
Constructor and Description
`SecurityPolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SecurityPolicy`	`clone()`
`byte[]`	`decodeFingerprint()` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
`byte[]`	`decodeLabelFingerprint()` A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking.
`SecurityPolicy`	`encodeFingerprint(byte[] fingerprint)` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
`SecurityPolicy`	`encodeLabelFingerprint(byte[] labelFingerprint)` A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking.
`SecurityPolicyAdaptiveProtectionConfig`	`getAdaptiveProtectionConfig()`
`SecurityPolicyAdvancedOptionsConfig`	`getAdvancedOptionsConfig()`
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`SecurityPolicyDdosProtectionConfig`	`getDdosProtectionConfig()`
`String`	`getDescription()` An optional description of this resource.
`String`	`getFingerprint()` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output only] Type of the resource.
`String`	`getLabelFingerprint()` A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking.
`Map<String,String>`	`getLabels()` Labels for this resource.
`String`	`getName()` Name of the resource.
`SecurityPolicyRecaptchaOptionsConfig`	`getRecaptchaOptionsConfig()`
`String`	`getRegion()` [Output Only] URL of the region where the regional security policy resides.
`List<SecurityPolicyRule>`	`getRules()` A list of rules that belong to this policy.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getType()` The type indicates the intended use of the security policy.
`List<SecurityPolicyUserDefinedField>`	`getUserDefinedFields()` Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies.
`SecurityPolicy`	`set(String fieldName, Object value)`
`SecurityPolicy`	`setAdaptiveProtectionConfig(SecurityPolicyAdaptiveProtectionConfig adaptiveProtectionConfig)`
`SecurityPolicy`	`setAdvancedOptionsConfig(SecurityPolicyAdvancedOptionsConfig advancedOptionsConfig)`
`SecurityPolicy`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`SecurityPolicy`	`setDdosProtectionConfig(SecurityPolicyDdosProtectionConfig ddosProtectionConfig)`
`SecurityPolicy`	`setDescription(String description)` An optional description of this resource.
`SecurityPolicy`	`setFingerprint(String fingerprint)` Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking.
`SecurityPolicy`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`SecurityPolicy`	`setKind(String kind)` [Output only] Type of the resource.
`SecurityPolicy`	`setLabelFingerprint(String labelFingerprint)` A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking.
`SecurityPolicy`	`setLabels(Map<String,String> labels)` Labels for this resource.
`SecurityPolicy`	`setName(String name)` Name of the resource.
`SecurityPolicy`	`setRecaptchaOptionsConfig(SecurityPolicyRecaptchaOptionsConfig recaptchaOptionsConfig)`
`SecurityPolicy`	`setRegion(String region)` [Output Only] URL of the region where the regional security policy resides.
`SecurityPolicy`	`setRules(List<SecurityPolicyRule> rules)` A list of rules that belong to this policy.
`SecurityPolicy`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`SecurityPolicy`	`setType(String type)` The type indicates the intended use of the security policy.
`SecurityPolicy`	`setUserDefinedFields(List<SecurityPolicyUserDefinedField> userDefinedFields)` Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - SecurityPolicy
```
public SecurityPolicy()
```
- Method Detail
  - getAdaptiveProtectionConfig
```
public SecurityPolicyAdaptiveProtectionConfig getAdaptiveProtectionConfig()
```
    Returns:
    
    value or null for none
  - setAdaptiveProtectionConfig
```
public SecurityPolicy setAdaptiveProtectionConfig(SecurityPolicyAdaptiveProtectionConfig adaptiveProtectionConfig)
```
    Parameters:
    
    adaptiveProtectionConfig - adaptiveProtectionConfig or null for none
  - getAdvancedOptionsConfig
```
public SecurityPolicyAdvancedOptionsConfig getAdvancedOptionsConfig()
```
    Returns:
    
    value or null for none
  - setAdvancedOptionsConfig
```
public SecurityPolicy setAdvancedOptionsConfig(SecurityPolicyAdvancedOptionsConfig advancedOptionsConfig)
```
    Parameters:
    
    advancedOptionsConfig - advancedOptionsConfig or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public SecurityPolicy setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDdosProtectionConfig
```
public SecurityPolicyDdosProtectionConfig getDdosProtectionConfig()
```
    Returns:
    
    value or null for none
  - setDdosProtectionConfig
```
public SecurityPolicy setDdosProtectionConfig(SecurityPolicyDdosProtectionConfig ddosProtectionConfig)
```
    Parameters:
    
    ddosProtectionConfig - ddosProtectionConfig or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public SecurityPolicy setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - 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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeFingerprint()
  - decodeFingerprint
```
public byte[] decodeFingerprint()
```
    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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getFingerprint()
  - setFingerprint
```
public SecurityPolicy setFingerprint(String fingerprint)
```
    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.
    
    Parameters:
    
    fingerprint - fingerprint or null for none
    
    See Also:
    
    #encodeFingerprint()
  - encodeFingerprint
```
public SecurityPolicy encodeFingerprint(byte[] fingerprint)
```
    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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getId
```
public BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public SecurityPolicy setId(BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    [Output only] Type of the resource. Always compute#securityPolicyfor security policies
    
    Returns:
    
    value or null for none
  - setKind
```
public SecurityPolicy setKind(String kind)
```
    [Output only] Type of the resource. Always compute#securityPolicyfor security policies
    
    Parameters:
    
    kind - kind or null for none
  - getLabelFingerprint
```
public String getLabelFingerprint()
```
    A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeLabelFingerprint()
  - decodeLabelFingerprint
```
public byte[] decodeLabelFingerprint()
```
    A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getLabelFingerprint()
  - setLabelFingerprint
```
public SecurityPolicy setLabelFingerprint(String labelFingerprint)
```
    A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
    
    Parameters:
    
    labelFingerprint - labelFingerprint or null for none
    
    See Also:
    
    #encodeLabelFingerprint()
  - encodeLabelFingerprint
```
public SecurityPolicy encodeLabelFingerprint(byte[] labelFingerprint)
```
    A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getLabels
```
public Map<String,String> getLabels()
```
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    
    Returns:
    
    value or null for none
  - setLabels
```
public SecurityPolicy setLabels(Map<String,String> labels)
```
    Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
    
    Parameters:
    
    labels - labels or null for none
  - getName
```
public String 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]([-a-z0-9]*[a-z0-9])?` 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.
    
    Returns:
    
    value or null for none
  - setName
```
public SecurityPolicy setName(String name)
```
    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]([-a-z0-9]*[a-z0-9])?` 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.
    
    Parameters:
    
    name - name or null for none
  - getRecaptchaOptionsConfig
```
public SecurityPolicyRecaptchaOptionsConfig getRecaptchaOptionsConfig()
```
    Returns:
    
    value or null for none
  - setRecaptchaOptionsConfig
```
public SecurityPolicy setRecaptchaOptionsConfig(SecurityPolicyRecaptchaOptionsConfig recaptchaOptionsConfig)
```
    Parameters:
    
    recaptchaOptionsConfig - recaptchaOptionsConfig or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setRegion
```
public SecurityPolicy setRegion(String region)
```
    [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies.
    
    Parameters:
    
    region - region or null for none
  - getRules
```
public List<SecurityPolicyRule> getRules()
```
    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.
    
    Returns:
    
    value or null for none
  - setRules
```
public SecurityPolicy setRules(List<SecurityPolicyRule> rules)
```
    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.
    
    Parameters:
    
    rules - rules or null for none
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public SecurityPolicy setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getType
```
public String 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 (preview only): 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.
    
    Returns:
    
    value or null for none
  - setType
```
public SecurityPolicy setType(String type)
```
    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 (preview only): 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.
    
    Parameters:
    
    type - type or null for none
  - getUserDefinedFields
```
public List<SecurityPolicyUserDefinedField> getUserDefinedFields()
```
    Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"
    
    Returns:
    
    value or null for none
  - setUserDefinedFields
```
public SecurityPolicy setUserDefinedFields(List<SecurityPolicyUserDefinedField> userDefinedFields)
```
    Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A user-defined field consists of up to 4 bytes extracted from a fixed offset in the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an optional mask to select certain bits. Rules may then specify matching values for these fields. Example: userDefinedFields: - name: "ipv4_fragment_offset" base: IPV4 offset: 6 size: 2 mask: "0x1fff"
    
    Parameters:
    
    userDefinedFields - userDefinedFields or null for none
  - set
```
public SecurityPolicy set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public SecurityPolicy clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class SecurityPolicy

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

SecurityPolicy

Method Detail

getAdaptiveProtectionConfig

setAdaptiveProtectionConfig

getAdvancedOptionsConfig

setAdvancedOptionsConfig

getCreationTimestamp

setCreationTimestamp

getDdosProtectionConfig

setDdosProtectionConfig

getDescription

setDescription

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getId

setId

getKind

setKind

getLabelFingerprint

decodeLabelFingerprint

setLabelFingerprint

encodeLabelFingerprint

getLabels

setLabels

getName

setName

getRecaptchaOptionsConfig

setRecaptchaOptionsConfig

getRegion

setRegion

getRules

setRules

getSelfLink

setSelfLink

getType

setType

getUserDefinedFields

setUserDefinedFields

set

clone