Reference documentation and code samples for the Google Cloud Network Security V1 Client class InterceptEndpointGroupAssociation.
An endpoint group association represents a link between a network and an endpoint group in the organization.
Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable intercept by itself. To enable intercept, the user must also create a network firewall policy containing intercept rules and associate it with the network.
Generated from protobuf message google.cloud.networksecurity.v1.InterceptEndpointGroupAssociation
Namespace
Google \ Cloud \ NetworkSecurity \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. Identifier. The resource name of this endpoint group association, for example: |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was created. See https://google.aip.dev/148#timestamps. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was most recently updated. See https://google.aip.dev/148#timestamps. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Labels are key/value pairs that help to organize and filter resources. |
↳ intercept_endpoint_group |
string
Required. Immutable. The endpoint group that this association is connected to, for example: |
↳ network |
string
Required. Immutable. The VPC network that is associated. for example: |
↳ locations_details |
array<InterceptEndpointGroupAssociation\LocationDetails>
Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself. |
↳ state |
int
Output only. Current state of the endpoint group association. |
↳ reconciling |
bool
Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128. |
↳ locations |
array<InterceptLocation>
Output only. The list of locations where the association is configured. This information is retrieved from the linked endpoint group. |
↳ network_cookie |
int
Output only. Identifier used by the data-path. See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id |
getName
Immutable. Identifier. The resource name of this endpoint group
association, for example:
projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association.
See https://google.aip.dev/122 for more details.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. Identifier. The resource name of this endpoint group
association, for example:
projects/123456789/locations/global/interceptEndpointGroupAssociations/my-eg-association.
See https://google.aip.dev/122 for more details.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The timestamp when the resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp when the resource was most recently updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was most recently updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Labels are key/value pairs that help to organize and filter resources.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Labels are key/value pairs that help to organize and filter resources.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInterceptEndpointGroup
Required. Immutable. The endpoint group that this association is connected
to, for example:
projects/123456789/locations/global/interceptEndpointGroups/my-eg.
| Returns | |
|---|---|
| Type | Description |
string |
|
setInterceptEndpointGroup
Required. Immutable. The endpoint group that this association is connected
to, for example:
projects/123456789/locations/global/interceptEndpointGroups/my-eg.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetwork
Required. Immutable. The VPC network that is associated. for example:
projects/123456789/global/networks/my-network.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNetwork
Required. Immutable. The VPC network that is associated. for example:
projects/123456789/global/networks/my-network.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocationsDetails
Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<InterceptEndpointGroupAssociation\LocationDetails> |
|
setLocationsDetails
Output only. The list of locations where the association is present. This information is retrieved from the linked endpoint group, and not configured as part of the association itself.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterceptEndpointGroupAssociation\LocationDetails>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. Current state of the endpoint group association.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. Current state of the endpoint group association.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReconciling
Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setReconciling
Output only. The current state of the resource does not match the user's intended state, and the system is working to reconcile them. This part of the normal operation (e.g. adding a new location to the target deployment group). See https://google.aip.dev/128.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocations
Output only. The list of locations where the association is configured.
This information is retrieved from the linked endpoint group.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<InterceptLocation> |
|
setLocations
Output only. The list of locations where the association is configured.
This information is retrieved from the linked endpoint group.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterceptLocation>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetworkCookie
Output only. Identifier used by the data-path.
See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id
| Returns | |
|---|---|
| Type | Description |
int |
|
setNetworkCookie
Output only. Identifier used by the data-path.
See the NSI GENEVE format for more details: https://docs.cloud.google.com/network-security-integration/docs/understand-geneve#network_id
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|