Reference documentation and code samples for the Google Cloud Network Security V1 Client class GatewaySecurityPolicyRule.
The GatewaySecurityPolicyRule resource is in a nested collection within a GatewaySecurityPolicy and represents a traffic matching condition and associated action to perform.
Generated from protobuf message google.cloud.networksecurity.v1.GatewaySecurityPolicyRule
Namespace
Google \ Cloud \ NetworkSecurity \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ basic_profile |
int
Required. Profile which tells what the primitive action should be. |
↳ name |
string
Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^a-z?$). |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the rule was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when the rule was updated. |
↳ enabled |
bool
Required. Whether the rule is enforced. |
↳ priority |
int
Required. Priority of the rule. Lower number corresponds to higher precedence. |
↳ description |
string
Optional. Free-text description of the resource. |
↳ session_matcher |
string
Required. CEL expression for matching on session criteria. |
↳ application_matcher |
string
Optional. CEL expression for matching on L7/application level criteria. |
↳ tls_inspection_enabled |
bool
Optional. Flag to enable TLS inspection of traffic matching on <session_matcher>, can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig. |
getBasicProfile
Required. Profile which tells what the primitive action should be.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type BasicProfile. |
hasBasicProfile
setBasicProfile
Required. Profile which tells what the primitive action should be.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type BasicProfile. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^a-z?$).
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^a-z?$).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Time when the rule was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the rule was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Time when the rule was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the rule was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnabled
Required. Whether the rule is enforced.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setEnabled
Required. Whether the rule is enforced.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPriority
Required. Priority of the rule.
Lower number corresponds to higher precedence.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPriority
Required. Priority of the rule.
Lower number corresponds to higher precedence.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Free-text description of the resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Free-text description of the resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSessionMatcher
Required. CEL expression for matching on session criteria.
| Returns | |
|---|---|
| Type | Description |
string |
|
setSessionMatcher
Required. CEL expression for matching on session criteria.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApplicationMatcher
Optional. CEL expression for matching on L7/application level criteria.
| Returns | |
|---|---|
| Type | Description |
string |
|
setApplicationMatcher
Optional. CEL expression for matching on L7/application level criteria.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTlsInspectionEnabled
Optional. Flag to enable TLS inspection of traffic matching on <session_matcher>, can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setTlsInspectionEnabled
Optional. Flag to enable TLS inspection of traffic matching on <session_matcher>, can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProfile
| Returns | |
|---|---|
| Type | Description |
string |
|