Class SecurityPolicy.Builder (1.57.0) 

public static final class SecurityPolicy.Builder extends GeneratedMessageV3.Builder<SecurityPolicy.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SecurityPolicy.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllRules(Iterable<? extends SecurityPolicyRule> values)

public SecurityPolicy.Builder addAllRules(Iterable<? extends SecurityPolicyRule> values)

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
values Iterable<? extends com.google.cloud.compute.v1.SecurityPolicyRule>
Returns
Type Description
SecurityPolicy.Builder

addAllUserDefinedFields(Iterable<? extends SecurityPolicyUserDefinedField> values)

public SecurityPolicy.Builder addAllUserDefinedFields(Iterable<? extends SecurityPolicyUserDefinedField> values)

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
values Iterable<? extends com.google.cloud.compute.v1.SecurityPolicyUserDefinedField>
Returns
Type Description
SecurityPolicy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SecurityPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecurityPolicy.Builder
Overrides

addRules(SecurityPolicyRule value)

public SecurityPolicy.Builder addRules(SecurityPolicyRule value)

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
value SecurityPolicyRule
Returns
Type Description
SecurityPolicy.Builder

addRules(SecurityPolicyRule.Builder builderForValue)

public SecurityPolicy.Builder addRules(SecurityPolicyRule.Builder builderForValue)

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
builderForValue SecurityPolicyRule.Builder
Returns
Type Description
SecurityPolicy.Builder

addRules(int index, SecurityPolicyRule value)

public SecurityPolicy.Builder addRules(int index, SecurityPolicyRule value)

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;

Parameters
Name Description
index int
value SecurityPolicyRule
Returns
Type Description
SecurityPolicy.Builder

addRules(int index, SecurityPolicyRule.Builder builderForValue)

public SecurityPolicy.Builder addRules(int index, SecurityPolicyRule.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SecurityPolicyRule.Builder
Returns
Type Description
SecurityPolicy.Builder

addRulesBuilder()

public SecurityPolicyRule.Builder addRulesBuilder()

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
SecurityPolicyRule.Builder

addRulesBuilder(int index)

public SecurityPolicyRule.Builder addRulesBuilder(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.Builder

addUserDefinedFields(SecurityPolicyUserDefinedField value)

public SecurityPolicy.Builder addUserDefinedFields(SecurityPolicyUserDefinedField value)

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
value SecurityPolicyUserDefinedField
Returns
Type Description
SecurityPolicy.Builder

addUserDefinedFields(SecurityPolicyUserDefinedField.Builder builderForValue)

public SecurityPolicy.Builder addUserDefinedFields(SecurityPolicyUserDefinedField.Builder builderForValue)

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
builderForValue SecurityPolicyUserDefinedField.Builder
Returns
Type Description
SecurityPolicy.Builder

addUserDefinedFields(int index, SecurityPolicyUserDefinedField value)

public SecurityPolicy.Builder addUserDefinedFields(int index, SecurityPolicyUserDefinedField value)

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;

Parameters
Name Description
index int
value SecurityPolicyUserDefinedField
Returns
Type Description
SecurityPolicy.Builder

addUserDefinedFields(int index, SecurityPolicyUserDefinedField.Builder builderForValue)

public SecurityPolicy.Builder addUserDefinedFields(int index, SecurityPolicyUserDefinedField.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SecurityPolicyUserDefinedField.Builder
Returns
Type Description
SecurityPolicy.Builder

addUserDefinedFieldsBuilder()

public SecurityPolicyUserDefinedField.Builder addUserDefinedFieldsBuilder()

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
SecurityPolicyUserDefinedField.Builder

addUserDefinedFieldsBuilder(int index)

public SecurityPolicyUserDefinedField.Builder addUserDefinedFieldsBuilder(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.Builder

build()

public SecurityPolicy build()
Returns
Type Description
SecurityPolicy

buildPartial()

public SecurityPolicy buildPartial()
Returns
Type Description
SecurityPolicy

clear()

public SecurityPolicy.Builder clear()
Returns
Type Description
SecurityPolicy.Builder
Overrides

clearAdaptiveProtectionConfig()

public SecurityPolicy.Builder clearAdaptiveProtectionConfig()

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

Returns
Type Description
SecurityPolicy.Builder

clearAdvancedOptionsConfig()

public SecurityPolicy.Builder clearAdvancedOptionsConfig()

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

Returns
Type Description
SecurityPolicy.Builder

clearCreationTimestamp()

public SecurityPolicy.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

clearDdosProtectionConfig()

public SecurityPolicy.Builder clearDdosProtectionConfig()

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

Returns
Type Description
SecurityPolicy.Builder

clearDescription()

public SecurityPolicy.Builder clearDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SecurityPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SecurityPolicy.Builder
Overrides

clearFingerprint()

public SecurityPolicy.Builder clearFingerprint()

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
SecurityPolicy.Builder

This builder for chaining.

clearId()

public SecurityPolicy.Builder clearId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

clearKind()

public SecurityPolicy.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

clearLabelFingerprint()

public SecurityPolicy.Builder clearLabelFingerprint()

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
SecurityPolicy.Builder

This builder for chaining.

clearLabels()

public SecurityPolicy.Builder clearLabels()
Returns
Type Description
SecurityPolicy.Builder

clearName()

public SecurityPolicy.Builder clearName()

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
SecurityPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SecurityPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SecurityPolicy.Builder
Overrides

clearRecaptchaOptionsConfig()

public SecurityPolicy.Builder clearRecaptchaOptionsConfig()

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

Returns
Type Description
SecurityPolicy.Builder

clearRegion()

public SecurityPolicy.Builder clearRegion()

[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
SecurityPolicy.Builder

This builder for chaining.

clearRules()

public SecurityPolicy.Builder clearRules()

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
SecurityPolicy.Builder

clearSelfLink()

public SecurityPolicy.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

clearType()

public SecurityPolicy.Builder clearType()

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
SecurityPolicy.Builder

This builder for chaining.

clearUserDefinedFields()

public SecurityPolicy.Builder clearUserDefinedFields()

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
SecurityPolicy.Builder

clone()

public SecurityPolicy.Builder clone()
Returns
Type Description
SecurityPolicy.Builder
Overrides

containsLabels(String key)

public 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 SecurityPolicyAdaptiveProtectionConfig getAdaptiveProtectionConfig()

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

Returns
Type Description
SecurityPolicyAdaptiveProtectionConfig

The adaptiveProtectionConfig.

getAdaptiveProtectionConfigBuilder()

public SecurityPolicyAdaptiveProtectionConfig.Builder getAdaptiveProtectionConfigBuilder()

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

Returns
Type Description
SecurityPolicyAdaptiveProtectionConfig.Builder

getAdaptiveProtectionConfigOrBuilder()

public SecurityPolicyAdaptiveProtectionConfigOrBuilder getAdaptiveProtectionConfigOrBuilder()

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

Returns
Type Description
SecurityPolicyAdaptiveProtectionConfigOrBuilder

getAdvancedOptionsConfig()

public SecurityPolicyAdvancedOptionsConfig getAdvancedOptionsConfig()

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

Returns
Type Description
SecurityPolicyAdvancedOptionsConfig

The advancedOptionsConfig.

getAdvancedOptionsConfigBuilder()

public SecurityPolicyAdvancedOptionsConfig.Builder getAdvancedOptionsConfigBuilder()

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

Returns
Type Description
SecurityPolicyAdvancedOptionsConfig.Builder

getAdvancedOptionsConfigOrBuilder()

public SecurityPolicyAdvancedOptionsConfigOrBuilder getAdvancedOptionsConfigOrBuilder()

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

Returns
Type Description
SecurityPolicyAdvancedOptionsConfigOrBuilder

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;

Returns
Type Description
SecurityPolicyDdosProtectionConfig

The ddosProtectionConfig.

getDdosProtectionConfigBuilder()

public SecurityPolicyDdosProtectionConfig.Builder getDdosProtectionConfigBuilder()

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

Returns
Type Description
SecurityPolicyDdosProtectionConfig.Builder

getDdosProtectionConfigOrBuilder()

public SecurityPolicyDdosProtectionConfigOrBuilder getDdosProtectionConfigOrBuilder()

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

Returns
Type Description
SecurityPolicyDdosProtectionConfigOrBuilder

getDefaultInstanceForType()

public SecurityPolicy getDefaultInstanceForType()
Returns
Type Description
SecurityPolicy

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

public 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 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 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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

getRecaptchaOptionsConfig()

public SecurityPolicyRecaptchaOptionsConfig getRecaptchaOptionsConfig()

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

Returns
Type Description
SecurityPolicyRecaptchaOptionsConfig

The recaptchaOptionsConfig.

getRecaptchaOptionsConfigBuilder()

public SecurityPolicyRecaptchaOptionsConfig.Builder getRecaptchaOptionsConfigBuilder()

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

Returns
Type Description
SecurityPolicyRecaptchaOptionsConfig.Builder

getRecaptchaOptionsConfigOrBuilder()

public SecurityPolicyRecaptchaOptionsConfigOrBuilder getRecaptchaOptionsConfigOrBuilder()

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

Returns
Type Description
SecurityPolicyRecaptchaOptionsConfigOrBuilder

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

getRulesBuilder(int index)

public SecurityPolicyRule.Builder getRulesBuilder(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.Builder

getRulesBuilderList()

public List<SecurityPolicyRule.Builder> getRulesBuilderList()

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<Builder>

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;

Returns
Type Description
List<SecurityPolicyRule>

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

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.

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

getUserDefinedFields(int index)

public 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

getUserDefinedFieldsBuilder(int index)

public SecurityPolicyUserDefinedField.Builder getUserDefinedFieldsBuilder(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.Builder

getUserDefinedFieldsBuilderList()

public List<SecurityPolicyUserDefinedField.Builder> getUserDefinedFieldsBuilderList()

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<Builder>

getUserDefinedFieldsCount()

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdaptiveProtectionConfig(SecurityPolicyAdaptiveProtectionConfig value)

public SecurityPolicy.Builder mergeAdaptiveProtectionConfig(SecurityPolicyAdaptiveProtectionConfig value)

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

Parameter
Name Description
value SecurityPolicyAdaptiveProtectionConfig
Returns
Type Description
SecurityPolicy.Builder

mergeAdvancedOptionsConfig(SecurityPolicyAdvancedOptionsConfig value)

public SecurityPolicy.Builder mergeAdvancedOptionsConfig(SecurityPolicyAdvancedOptionsConfig value)

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

Parameter
Name Description
value SecurityPolicyAdvancedOptionsConfig
Returns
Type Description
SecurityPolicy.Builder

mergeDdosProtectionConfig(SecurityPolicyDdosProtectionConfig value)

public SecurityPolicy.Builder mergeDdosProtectionConfig(SecurityPolicyDdosProtectionConfig value)

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

Parameter
Name Description
value SecurityPolicyDdosProtectionConfig
Returns
Type Description
SecurityPolicy.Builder

mergeFrom(SecurityPolicy other)

public SecurityPolicy.Builder mergeFrom(SecurityPolicy other)
Parameter
Name Description
other SecurityPolicy
Returns
Type Description
SecurityPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SecurityPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SecurityPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SecurityPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SecurityPolicy.Builder
Overrides

mergeRecaptchaOptionsConfig(SecurityPolicyRecaptchaOptionsConfig value)

public SecurityPolicy.Builder mergeRecaptchaOptionsConfig(SecurityPolicyRecaptchaOptionsConfig value)

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

Parameter
Name Description
value SecurityPolicyRecaptchaOptionsConfig
Returns
Type Description
SecurityPolicy.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SecurityPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecurityPolicy.Builder
Overrides

putAllLabels(Map<String,String> values)

public SecurityPolicy.Builder putAllLabels(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
SecurityPolicy.Builder

putLabels(String key, String value)

public SecurityPolicy.Builder putLabels(String key, String value)

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
value String
Returns
Type Description
SecurityPolicy.Builder

removeLabels(String key)

public SecurityPolicy.Builder removeLabels(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
SecurityPolicy.Builder

removeRules(int index)

public SecurityPolicy.Builder removeRules(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
SecurityPolicy.Builder

removeUserDefinedFields(int index)

public SecurityPolicy.Builder removeUserDefinedFields(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
SecurityPolicy.Builder

setAdaptiveProtectionConfig(SecurityPolicyAdaptiveProtectionConfig value)

public SecurityPolicy.Builder setAdaptiveProtectionConfig(SecurityPolicyAdaptiveProtectionConfig value)

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

Parameter
Name Description
value SecurityPolicyAdaptiveProtectionConfig
Returns
Type Description
SecurityPolicy.Builder

setAdaptiveProtectionConfig(SecurityPolicyAdaptiveProtectionConfig.Builder builderForValue)

public SecurityPolicy.Builder setAdaptiveProtectionConfig(SecurityPolicyAdaptiveProtectionConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue SecurityPolicyAdaptiveProtectionConfig.Builder
Returns
Type Description
SecurityPolicy.Builder

setAdvancedOptionsConfig(SecurityPolicyAdvancedOptionsConfig value)

public SecurityPolicy.Builder setAdvancedOptionsConfig(SecurityPolicyAdvancedOptionsConfig value)

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

Parameter
Name Description
value SecurityPolicyAdvancedOptionsConfig
Returns
Type Description
SecurityPolicy.Builder

setAdvancedOptionsConfig(SecurityPolicyAdvancedOptionsConfig.Builder builderForValue)

public SecurityPolicy.Builder setAdvancedOptionsConfig(SecurityPolicyAdvancedOptionsConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue SecurityPolicyAdvancedOptionsConfig.Builder
Returns
Type Description
SecurityPolicy.Builder

setCreationTimestamp(String value)

public SecurityPolicy.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public SecurityPolicy.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setDdosProtectionConfig(SecurityPolicyDdosProtectionConfig value)

public SecurityPolicy.Builder setDdosProtectionConfig(SecurityPolicyDdosProtectionConfig value)

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

Parameter
Name Description
value SecurityPolicyDdosProtectionConfig
Returns
Type Description
SecurityPolicy.Builder

setDdosProtectionConfig(SecurityPolicyDdosProtectionConfig.Builder builderForValue)

public SecurityPolicy.Builder setDdosProtectionConfig(SecurityPolicyDdosProtectionConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue SecurityPolicyDdosProtectionConfig.Builder
Returns
Type Description
SecurityPolicy.Builder

setDescription(String value)

public SecurityPolicy.Builder setDescription(String value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public SecurityPolicy.Builder setDescriptionBytes(ByteString value)

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SecurityPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SecurityPolicy.Builder
Overrides

setFingerprint(String value)

public SecurityPolicy.Builder setFingerprint(String value)

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;

Parameter
Name Description
value String

The fingerprint to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setFingerprintBytes(ByteString value)

public SecurityPolicy.Builder setFingerprintBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for fingerprint to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setId(long value)

public SecurityPolicy.Builder setId(long value)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setKind(String value)

public SecurityPolicy.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setKindBytes(ByteString value)

public SecurityPolicy.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setLabelFingerprint(String value)

public SecurityPolicy.Builder setLabelFingerprint(String value)

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;

Parameter
Name Description
value String

The labelFingerprint to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setLabelFingerprintBytes(ByteString value)

public SecurityPolicy.Builder setLabelFingerprintBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for labelFingerprint to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setName(String value)

public SecurityPolicy.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SecurityPolicy.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setRecaptchaOptionsConfig(SecurityPolicyRecaptchaOptionsConfig value)

public SecurityPolicy.Builder setRecaptchaOptionsConfig(SecurityPolicyRecaptchaOptionsConfig value)

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

Parameter
Name Description
value SecurityPolicyRecaptchaOptionsConfig
Returns
Type Description
SecurityPolicy.Builder

setRecaptchaOptionsConfig(SecurityPolicyRecaptchaOptionsConfig.Builder builderForValue)

public SecurityPolicy.Builder setRecaptchaOptionsConfig(SecurityPolicyRecaptchaOptionsConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue SecurityPolicyRecaptchaOptionsConfig.Builder
Returns
Type Description
SecurityPolicy.Builder

setRegion(String value)

public SecurityPolicy.Builder setRegion(String value)

[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;

Parameter
Name Description
value String

The region to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setRegionBytes(ByteString value)

public SecurityPolicy.Builder setRegionBytes(ByteString value)

[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;

Parameter
Name Description
value ByteString

The bytes for region to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SecurityPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SecurityPolicy.Builder
Overrides

setRules(int index, SecurityPolicyRule value)

public SecurityPolicy.Builder setRules(int index, SecurityPolicyRule value)

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;

Parameters
Name Description
index int
value SecurityPolicyRule
Returns
Type Description
SecurityPolicy.Builder

setRules(int index, SecurityPolicyRule.Builder builderForValue)

public SecurityPolicy.Builder setRules(int index, SecurityPolicyRule.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SecurityPolicyRule.Builder
Returns
Type Description
SecurityPolicy.Builder

setSelfLink(String value)

public SecurityPolicy.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public SecurityPolicy.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setType(String value)

public SecurityPolicy.Builder setType(String value)

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;

Parameter
Name Description
value String

The type to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public SecurityPolicy.Builder setTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for type to set.
Returns
Type Description
SecurityPolicy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SecurityPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SecurityPolicy.Builder
Overrides

setUserDefinedFields(int index, SecurityPolicyUserDefinedField value)

public SecurityPolicy.Builder setUserDefinedFields(int index, SecurityPolicyUserDefinedField value)

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;

Parameters
Name Description
index int
value SecurityPolicyUserDefinedField
Returns
Type Description
SecurityPolicy.Builder

setUserDefinedFields(int index, SecurityPolicyUserDefinedField.Builder builderForValue)

public SecurityPolicy.Builder setUserDefinedFields(int index, SecurityPolicyUserDefinedField.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue SecurityPolicyUserDefinedField.Builder
Returns
Type Description
SecurityPolicy.Builder