Reference documentation and code samples for the Google Cloud Ids V1 Client class Endpoint.
Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.
Generated from protobuf message google.cloud.ids.v1.Endpoint
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. The name of the endpoint. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The create time timestamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The update time timestamp. |
↳ labels |
array|Google\Protobuf\Internal\MapField
The labels of the endpoint. |
↳ network |
string
Required. The fully qualified URL of the network to which the IDS Endpoint is attached. |
↳ endpoint_forwarding_rule |
string
Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule. |
↳ endpoint_ip |
string
Output only. The IP address of the IDS Endpoint's ILB. |
↳ description |
string
User-provided description of the endpoint |
↳ severity |
int
Required. Lowest threat severity that this endpoint will alert on. |
↳ state |
int
Output only. Current state of the endpoint. |
↳ traffic_logs |
bool
Whether the endpoint should report traffic logs in addition to threat logs. |
getName
Output only. The name of the endpoint.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Output only. The name of the endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
Output only. The create time timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
Output only. The create time timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUpdateTime
Output only. The update time timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The update time timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLabels
The labels of the endpoint.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setLabels
The labels of the endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNetwork
Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
| Returns | |
|---|---|
| Type | Description |
string | |
setNetwork
Required. The fully qualified URL of the network to which the IDS Endpoint is attached.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndpointForwardingRule
Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule.
| Returns | |
|---|---|
| Type | Description |
string | |
setEndpointForwardingRule
Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndpointIp
Output only. The IP address of the IDS Endpoint's ILB.
| Returns | |
|---|---|
| Type | Description |
string | |
setEndpointIp
Output only. The IP address of the IDS Endpoint's ILB.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
User-provided description of the endpoint
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
User-provided description of the endpoint
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSeverity
Required. Lowest threat severity that this endpoint will alert on.
| Returns | |
|---|---|
| Type | Description |
int | |
setSeverity
Required. Lowest threat severity that this endpoint will alert on.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. Current state of the endpoint.
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. Current state of the endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTrafficLogs
Whether the endpoint should report traffic logs in addition to threat logs.
| Returns | |
|---|---|
| Type | Description |
bool | |
setTrafficLogs
Whether the endpoint should report traffic logs in addition to threat logs.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |