Reference documentation and code samples for the Google Cloud Network Security V1 Client class InterceptDeploymentGroup.
A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.
Generated from protobuf message google.cloud.networksecurity.v1.InterceptDeploymentGroup
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 deployment 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. |
↳ network |
string
Required. Immutable. The network that will be used for all child deployments, for example: |
↳ connected_endpoint_groups |
array<InterceptDeploymentGroup\ConnectedEndpointGroup>
Output only. The list of endpoint groups that are connected to this resource. |
↳ nested_deployments |
array<InterceptDeploymentGroup\Deployment>
Output only. The list of Intercept Deployments that belong to this group. |
↳ state |
int
Output only. The current state of the deployment 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 deployment to the group) See https://google.aip.dev/128. |
↳ description |
string
Optional. User-provided description of the deployment group. Used as additional context for the deployment group. |
↳ locations |
array<InterceptLocation>
Output only. The list of locations where the deployment group is present. |
getName
Immutable. Identifier. The resource name of this deployment group, for
example:
projects/123456789/locations/global/interceptDeploymentGroups/my-dg.
See https://google.aip.dev/122 for more details.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. Identifier. The resource name of this deployment group, for
example:
projects/123456789/locations/global/interceptDeploymentGroups/my-dg.
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 |
|
getNetwork
Required. Immutable. The network that will be used for all child
deployments, for example: projects/{project}/global/networks/{network}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNetwork
Required. Immutable. The network that will be used for all child
deployments, for example: projects/{project}/global/networks/{network}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConnectedEndpointGroups
Output only. The list of endpoint groups that are connected to this resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<InterceptDeploymentGroup\ConnectedEndpointGroup> |
|
setConnectedEndpointGroups
Output only. The list of endpoint groups that are connected to this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterceptDeploymentGroup\ConnectedEndpointGroup>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNestedDeployments
Output only. The list of Intercept Deployments that belong to this group.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<InterceptDeploymentGroup\Deployment> |
|
setNestedDeployments
Output only. The list of Intercept Deployments that belong to this group.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterceptDeploymentGroup\Deployment>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. The current state of the deployment group.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. The current state of the deployment 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 deployment 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 deployment to the group) See https://google.aip.dev/128.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. User-provided description of the deployment group.
Used as additional context for the deployment group.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. User-provided description of the deployment group.
Used as additional context for the deployment group.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocations
Output only. The list of locations where the deployment group is present.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<InterceptLocation> |
|
setLocations
Output only. The list of locations where the deployment group is present.
| Parameter | |
|---|---|
| Name | Description |
var |
array<InterceptLocation>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|