Reference documentation and code samples for the Google Cloud Network Security V1 Client class FirewallEndpoint.
Message describing Endpoint object.
Generated from protobuf message google.cloud.networksecurity.v1.FirewallEndpoint
Namespace
Google \ Cloud \ NetworkSecurity \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. Identifier. Name of resource. |
↳ description |
string
Optional. Description of the firewall endpoint. Max length 2048 characters. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Create time stamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update time stamp |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels as key value pairs |
↳ state |
int
Output only. Current state of the endpoint. |
↳ reconciling |
bool
Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. |
↳ associated_networks |
string[]
Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}. |
↳ associations |
array<FirewallEndpoint\AssociationReference>
Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured. |
↳ satisfies_pzs |
bool
Output only. [Output Only] Reserved for future use. |
↳ satisfies_pzi |
bool
Output only. [Output Only] Reserved for future use. |
↳ billing_project_id |
string
Optional. Project to charge for the deployed firewall endpoint. This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise. |
↳ endpoint_settings |
FirewallEndpoint\EndpointSettings
Optional. Settings for the endpoint. |
getName
Immutable. Identifier. Name of resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. Identifier. Name of resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the firewall endpoint. Max length 2048 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the firewall endpoint. Max length 2048 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Create time stamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time stamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Update time stamp
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update time stamp
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels as key value pairs
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels as key value pairs
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. Current state of the endpoint.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. Current state of the endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReconciling
Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReconciling
Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAssociatedNetworks
Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setAssociatedNetworks
Output only. List of networks that are associated with this endpoint in the local zone. This is a projection of the FirewallEndpointAssociations pointing at this endpoint. A network will only appear in this list after traffic routing is fully configured. Format: projects/{project}/global/networks/{name}.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAssociations
Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<FirewallEndpoint\AssociationReference> |
|
setAssociations
Output only. List of FirewallEndpointAssociations that are associated to this endpoint. An association will only appear in this list after traffic routing is fully configured.
| Parameter | |
|---|---|
| Name | Description |
var |
array<FirewallEndpoint\AssociationReference>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzs
Output only. [Output Only] Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
Output only. [Output Only] Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzi
Output only. [Output Only] Reserved for future use.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasSatisfiesPzi
clearSatisfiesPzi
setSatisfiesPzi
Output only. [Output Only] Reserved for future use.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBillingProjectId
Optional. Project to charge for the deployed firewall endpoint.
This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
| Returns | |
|---|---|
| Type | Description |
string |
|
setBillingProjectId
Optional. Project to charge for the deployed firewall endpoint.
This field must be specified when creating the endpoint in the organization scope, and should be omitted otherwise.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEndpointSettings
Optional. Settings for the endpoint.
| Returns | |
|---|---|
| Type | Description |
FirewallEndpoint\EndpointSettings|null |
|
hasEndpointSettings
clearEndpointSettings
setEndpointSettings
Optional. Settings for the endpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
FirewallEndpoint\EndpointSettings
|
| Returns | |
|---|---|
| Type | Description |
$this |
|