Interface SecurityPolicyUserDefinedFieldOrBuilder (1.49.0)

public interface SecurityPolicyUserDefinedFieldOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBase()

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

optional string base = 3016401;

Returns
TypeDescription
String

The base.

getBaseBytes()

public abstract ByteString getBaseBytes()

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.

optional string base = 3016401;

Returns
TypeDescription
ByteString

The bytes for base.

getMask()

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

optional string mask = 3344108;

Returns
TypeDescription
String

The mask.

getMaskBytes()

public abstract ByteString getMaskBytes()

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.

optional string mask = 3344108;

Returns
TypeDescription
ByteString

The bytes for mask.

getName()

public abstract String getName()

The name of this field. Must be unique within the policy.

optional string name = 3373707;

Returns
TypeDescription
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of this field. Must be unique within the policy.

optional string name = 3373707;

Returns
TypeDescription
ByteString

The bytes for name.

getOffset()

public abstract int getOffset()

Offset of the first byte of the field (in network byte order) relative to 'base'.

optional int32 offset = 53961875;

Returns
TypeDescription
int

The offset.

getSize()

public abstract int getSize()

Size of the field in bytes. Valid values: 1-4.

optional int32 size = 3530753;

Returns
TypeDescription
int

The size.

hasBase()

public abstract boolean hasBase()

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.

optional string base = 3016401;

Returns
TypeDescription
boolean

Whether the base field is set.

hasMask()

public abstract boolean hasMask()

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.

optional string mask = 3344108;

Returns
TypeDescription
boolean

Whether the mask field is set.

hasName()

public abstract boolean hasName()

The name of this field. Must be unique within the policy.

optional string name = 3373707;

Returns
TypeDescription
boolean

Whether the name field is set.

hasOffset()

public abstract boolean hasOffset()

Offset of the first byte of the field (in network byte order) relative to 'base'.

optional int32 offset = 53961875;

Returns
TypeDescription
boolean

Whether the offset field is set.

hasSize()

public abstract boolean hasSize()

Size of the field in bytes. Valid values: 1-4.

optional int32 size = 3530753;

Returns
TypeDescription
boolean

Whether the size field is set.