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 \ V1Methods
__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'.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSize
Size of the field in bytes. Valid values: 1-4.
| Returns | |
|---|---|
| Type | Description |
int | |
hasSize
clearSize
setSize
Size of the field in bytes. Valid values: 1-4.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |