Reference documentation and code samples for the Compute V1 Client class SecurityPolicyUserDefinedField.
Generated from protobuf message google.cloud.compute.v1.SecurityPolicyUserDefinedField
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ base
string
The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required Check the Base enum for the list of possible values.
↳ mask
string
If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.
↳ name
string
The name of this field. Must be unique within the policy.
↳ offset
int
Offset of the first byte of the field (in network byte order) relative to 'base'.
↳ size
int
Size of the field in bytes. Valid values: 1-4.
getBase
The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required
Check the Base enum for the list of possible values.
Returns
Type
Description
string
hasBase
clearBase
setBase
The base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required
Check the Base enum for the list of possible values.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMask
If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.
Returns
Type
Description
string
hasMask
clearMask
setMask
If specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with "0x"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getName
The name of this field. Must be unique within the policy.
Returns
Type
Description
string
hasName
clearName
setName
The name of this field. Must be unique within the policy.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOffset
Offset of the first byte of the field (in network byte order) relative to 'base'.
Returns
Type
Description
int
hasOffset
clearOffset
setOffset
Offset of the first byte of the field (in network byte order) relative to 'base'.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class SecurityPolicyUserDefinedField (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.SecurityPolicyUserDefinedField)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.SecurityPolicyUserDefinedField)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.SecurityPolicyUserDefinedField)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.SecurityPolicyUserDefinedField)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.SecurityPolicyUserDefinedField)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.SecurityPolicyUserDefinedField)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.SecurityPolicyUserDefinedField)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.SecurityPolicyUserDefinedField)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.SecurityPolicyUserDefinedField)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.SecurityPolicyUserDefinedField)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.SecurityPolicyUserDefinedField)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.SecurityPolicyUserDefinedField)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.SecurityPolicyUserDefinedField)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.SecurityPolicyUserDefinedField)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.SecurityPolicyUserDefinedField)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.SecurityPolicyUserDefinedField)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.SecurityPolicyUserDefinedField)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.SecurityPolicyUserDefinedField)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.SecurityPolicyUserDefinedField)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.SecurityPolicyUserDefinedField)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.SecurityPolicyUserDefinedField)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.SecurityPolicyUserDefinedField)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.SecurityPolicyUserDefinedField)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.SecurityPolicyUserDefinedField)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.SecurityPolicyUserDefinedField)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.SecurityPolicyUserDefinedField)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.SecurityPolicyUserDefinedField)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.SecurityPolicyUserDefinedField)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.SecurityPolicyUserDefinedField)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.SecurityPolicyUserDefinedField) \nReference documentation and code samples for the Compute V1 Client class SecurityPolicyUserDefinedField.\n\nGenerated from protobuf message `google.cloud.compute.v1.SecurityPolicyUserDefinedField`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getBase\n\nThe base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required\nCheck the Base enum for the list of possible values.\n\n### hasBase\n\n### clearBase\n\n### setBase\n\nThe base relative to which 'offset' is measured. Possible values are: - IPV4: Points to the beginning of the IPv4 header. - IPV6: Points to the beginning of the IPv6 header. - TCP: Points to the beginning of the TCP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. - UDP: Points to the beginning of the UDP header, skipping over any IPv4 options or IPv6 extension headers. Not present for non-first fragments. required\nCheck the Base enum for the list of possible values.\n\n### getMask\n\nIf specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with \"0x\"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.\n\n### hasMask\n\n### clearMask\n\n### setMask\n\nIf specified, apply this mask (bitwise AND) to the field to ignore bits before matching. Encoded as a hexadecimal number (starting with \"0x\"). The last byte of the field (in network byte order) corresponds to the least significant byte of the mask.\n\n### getName\n\nThe name of this field. Must be unique within the policy.\n\n### hasName\n\n### clearName\n\n### setName\n\nThe name of this field. Must be unique within the policy.\n\n### getOffset\n\nOffset of the first byte of the field (in network byte order) relative to 'base'.\n\n### hasOffset\n\n### clearOffset\n\n### setOffset\n\nOffset of the first byte of the field (in network byte order) relative to 'base'.\n\n### getSize\n\nSize of the field in bytes. Valid values: 1-4.\n\n### hasSize\n\n### clearSize\n\n### setSize\n\nSize of the field in bytes. Valid values: 1-4."]]
