Reference documentation and code samples for the Google Cloud Network Security V1 Client class MirroringEndpointGroup.
An endpoint group is a consumer frontend for a deployment group (backend).
In order to configure mirroring for a network, consumers must create:
- An association between their network and the endpoint group.
- A security profile that points to the endpoint group.
- A mirroring rule that references the security profile (group).
Generated from protobuf message google.cloud.networksecurity.v1.MirroringEndpointGroup
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, 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. |
↳ mirroring_deployment_group |
string
Immutable. The deployment group that this DIRECT endpoint group is connected to, for example: |
↳ connected_deployment_groups |
array<MirroringEndpointGroup\ConnectedDeploymentGroup>
Output only. List of details about the connected deployment groups to this endpoint group. |
↳ state |
int
Output only. The current state of the endpoint group. See https://google.aip.dev/216. |
↳ 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 is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128. |
↳ type |
int
Immutable. The type of the endpoint group. If left unspecified, defaults to DIRECT. |
↳ associations |
array<MirroringEndpointGroup\AssociationDetails>
Output only. List of associations to this endpoint group. |
↳ description |
string
Optional. User-provided description of the endpoint group. Used as additional context for the endpoint group. |
getName
Immutable. Identifier. The resource name of this endpoint group, for
example:
projects/123456789/locations/global/mirroringEndpointGroups/my-eg.
See https://google.aip.dev/122 for more details.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. Identifier. The resource name of this endpoint group, for
example:
projects/123456789/locations/global/mirroringEndpointGroups/my-eg.
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 |
|
getMirroringDeploymentGroup
Immutable. The deployment group that this DIRECT endpoint group is
connected to, for example:
projects/123456789/locations/global/mirroringDeploymentGroups/my-dg.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMirroringDeploymentGroup
Immutable. The deployment group that this DIRECT endpoint group is
connected to, for example:
projects/123456789/locations/global/mirroringDeploymentGroups/my-dg.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectedDeploymentGroups
Output only. List of details about the connected deployment groups to this endpoint group.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<MirroringEndpointGroup\ConnectedDeploymentGroup> |
|
setConnectedDeploymentGroups
Output only. List of details about the connected deployment groups to this endpoint group.
| Parameter | |
|---|---|
| Name | Description |
var |
array<MirroringEndpointGroup\ConnectedDeploymentGroup>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of the endpoint group.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The current state of the endpoint group.
| 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 is part of the normal operation (e.g. adding a new association to the 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 is part of the normal operation (e.g. adding a new association to the group). See https://google.aip.dev/128.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
Immutable. The type of the endpoint group.
If left unspecified, defaults to DIRECT.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Type. |
setType
Immutable. The type of the endpoint group.
If left unspecified, defaults to DIRECT.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Type. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAssociations
Output only. List of associations to this endpoint group.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<MirroringEndpointGroup\AssociationDetails> |
|
setAssociations
Output only. List of associations to this endpoint group.
| Parameter | |
|---|---|
| Name | Description |
var |
array<MirroringEndpointGroup\AssociationDetails>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. User-provided description of the endpoint group.
Used as additional context for the endpoint group.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. User-provided description of the endpoint group.
Used as additional context for the endpoint group.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|