Interface SecurityPolicyOrBuilder (1.56.0) 

public interface SecurityPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

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.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAdaptiveProtectionConfig()

public abstract SecurityPolicyAdaptiveProtectionConfig getAdaptiveProtectionConfig()

optional .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfig adaptive_protection_config = 150240735;

Returns
Type Description
SecurityPolicyAdaptiveProtectionConfig

The adaptiveProtectionConfig.

getAdaptiveProtectionConfigOrBuilder()

public abstract SecurityPolicyAdaptiveProtectionConfigOrBuilder getAdaptiveProtectionConfigOrBuilder()

optional .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfig adaptive_protection_config = 150240735;

Returns
Type Description
SecurityPolicyAdaptiveProtectionConfigOrBuilder

getAdvancedOptionsConfig()

public abstract SecurityPolicyAdvancedOptionsConfig getAdvancedOptionsConfig()

optional .google.cloud.compute.v1.SecurityPolicyAdvancedOptionsConfig advanced_options_config = 449276352;

Returns
Type Description
SecurityPolicyAdvancedOptionsConfig

The advancedOptionsConfig.

getAdvancedOptionsConfigOrBuilder()

public abstract SecurityPolicyAdvancedOptionsConfigOrBuilder getAdvancedOptionsConfigOrBuilder()

optional .google.cloud.compute.v1.SecurityPolicyAdvancedOptionsConfig advanced_options_config = 449276352;

Returns
Type Description
SecurityPolicyAdvancedOptionsConfigOrBuilder

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract 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 abstract SecurityPolicyDdosProtectionConfig getDdosProtectionConfig()

optional .google.cloud.compute.v1.SecurityPolicyDdosProtectionConfig ddos_protection_config = 50315853;

Returns
Type Description
SecurityPolicyDdosProtectionConfig

The ddosProtectionConfig.

getDdosProtectionConfigOrBuilder()

public abstract SecurityPolicyDdosProtectionConfigOrBuilder getDdosProtectionConfigOrBuilder()

optional .google.cloud.compute.v1.SecurityPolicyDdosProtectionConfig ddos_protection_config = 50315853;

Returns
Type Description
SecurityPolicyDdosProtectionConfigOrBuilder

getDescription()

public abstract 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 abstract 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 abstract 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 abstract 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()

public abstract long 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()

public abstract String getKind()

[Output only] Type of the resource. Always compute#securityPolicyfor security policies

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public abstract 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.

getLabelFingerprint()

public abstract 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.

optional string label_fingerprint = 178124825;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public abstract ByteString getLabelFingerprintBytes()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

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.

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

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.

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

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.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

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.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract 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? 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 abstract 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.

getRecaptchaOptionsConfig()

public abstract SecurityPolicyRecaptchaOptionsConfig getRecaptchaOptionsConfig()

optional .google.cloud.compute.v1.SecurityPolicyRecaptchaOptionsConfig recaptcha_options_config = 519006811;

Returns
Type Description
SecurityPolicyRecaptchaOptionsConfig

The recaptchaOptionsConfig.

getRecaptchaOptionsConfigOrBuilder()

public abstract SecurityPolicyRecaptchaOptionsConfigOrBuilder getRecaptchaOptionsConfigOrBuilder()

optional .google.cloud.compute.v1.SecurityPolicyRecaptchaOptionsConfig recaptcha_options_config = 519006811;

Returns
Type Description
SecurityPolicyRecaptchaOptionsConfigOrBuilder

getRegion()

public abstract 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 abstract 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 abstract 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
Returns
Type Description
SecurityPolicyRule

getRulesCount()

public abstract 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 abstract 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;

Returns
Type Description
List<SecurityPolicyRule>

getRulesOrBuilder(int index)

public abstract 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
Returns
Type Description
SecurityPolicyRuleOrBuilder

getRulesOrBuilderList()

public abstract 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 abstract String getSelfLink()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

[Output Only] Server-defined URL for the resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getType()

public abstract 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: 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 abstract 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.

getUserDefinedFields(int index)

public abstract SecurityPolicyUserDefinedField getUserDefinedFields(int index)

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"

repeated .google.cloud.compute.v1.SecurityPolicyUserDefinedField user_defined_fields = 28312739;

Parameter
Name Description
index int
Returns
Type Description
SecurityPolicyUserDefinedField

getUserDefinedFieldsCount()

public abstract int getUserDefinedFieldsCount()

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"

repeated .google.cloud.compute.v1.SecurityPolicyUserDefinedField user_defined_fields = 28312739;

Returns
Type Description
int

getUserDefinedFieldsList()

public abstract List<SecurityPolicyUserDefinedField> getUserDefinedFieldsList()

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"

repeated .google.cloud.compute.v1.SecurityPolicyUserDefinedField user_defined_fields = 28312739;

Returns
Type Description
List<SecurityPolicyUserDefinedField>

getUserDefinedFieldsOrBuilder(int index)

public abstract SecurityPolicyUserDefinedFieldOrBuilder getUserDefinedFieldsOrBuilder(int index)

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"

repeated .google.cloud.compute.v1.SecurityPolicyUserDefinedField user_defined_fields = 28312739;

Parameter
Name Description
index int
Returns
Type Description
SecurityPolicyUserDefinedFieldOrBuilder

getUserDefinedFieldsOrBuilderList()

public abstract List<? extends SecurityPolicyUserDefinedFieldOrBuilder> getUserDefinedFieldsOrBuilderList()

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"

repeated .google.cloud.compute.v1.SecurityPolicyUserDefinedField user_defined_fields = 28312739;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.SecurityPolicyUserDefinedFieldOrBuilder>

hasAdaptiveProtectionConfig()

public abstract boolean hasAdaptiveProtectionConfig()

optional .google.cloud.compute.v1.SecurityPolicyAdaptiveProtectionConfig adaptive_protection_config = 150240735;

Returns
Type Description
boolean

Whether the adaptiveProtectionConfig field is set.

hasAdvancedOptionsConfig()

public abstract boolean hasAdvancedOptionsConfig()

optional .google.cloud.compute.v1.SecurityPolicyAdvancedOptionsConfig advanced_options_config = 449276352;

Returns
Type Description
boolean

Whether the advancedOptionsConfig field is set.

hasCreationTimestamp()

public abstract 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 abstract boolean hasDdosProtectionConfig()

optional .google.cloud.compute.v1.SecurityPolicyDdosProtectionConfig ddos_protection_config = 50315853;

Returns
Type Description
boolean

Whether the ddosProtectionConfig field is set.

hasDescription()

public abstract 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 abstract 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()

public abstract boolean 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()

public abstract boolean 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.

hasLabelFingerprint()

public abstract boolean hasLabelFingerprint()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasName()

public abstract boolean 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 abstract boolean hasRecaptchaOptionsConfig()

optional .google.cloud.compute.v1.SecurityPolicyRecaptchaOptionsConfig recaptcha_options_config = 519006811;

Returns
Type Description
boolean

Whether the recaptchaOptionsConfig field is set.

hasRegion()

public abstract 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 abstract 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()

public abstract boolean 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.