Google Cloud Network Security V1 Client - Class MirroringDeployment (1.3.0)

Reference documentation and code samples for the Google Cloud Network Security V1 Client class MirroringDeployment.

A deployment represents a zonal mirroring backend ready to accept GENEVE-encapsulated replica traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global mirroring service.

Generated from protobuf message google.cloud.networksecurity.v1.MirroringDeployment

Namespace

Google \ Cloud \ NetworkSecurity \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Immutable. Identifier. The resource name of this deployment, for example: projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep . See https://google.aip.dev/122 for more details.

↳ 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.

↳ forwarding_rule
string

Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: projects/123456789/regions/us-central1/forwardingRules/my-rule . See https://google.aip.dev/124 .

↳ mirroring_deployment_group
string

Required. Immutable. The deployment group that this deployment is a part of, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg . See https://google.aip.dev/124 .

↳ state
int

Output only. The current state of the deployment. 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 part of the normal operation (e.g. linking a new association to the parent group). See https://google.aip.dev/128 .

↳ description
string

Optional. User-provided description of the deployment. Used as additional context for the deployment.

getName

Immutable. Identifier. The resource name of this deployment, for example: projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep .

See https://google.aip.dev/122 for more details.

Returns
Type
Description
string

setName

Immutable. Identifier. The resource name of this deployment, for example: projects/123456789/locations/us-central1-a/mirroringDeployments/my-dep .

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.

See https://google.aip.dev/148#timestamps .

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the resource was created.

See https://google.aip.dev/148#timestamps .

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The timestamp when the resource was most recently updated.

See https://google.aip.dev/148#timestamps .

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when the resource was most recently updated.

See https://google.aip.dev/148#timestamps .

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Optional. Labels are key/value pairs that help to organize and filter resources.

Returns
Type
Description

setLabels

Optional. Labels are key/value pairs that help to organize and filter resources.

Parameter
Name
Description
Returns
Type
Description
$this

getForwardingRule

Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: projects/123456789/regions/us-central1/forwardingRules/my-rule . See https://google.aip.dev/124 .

Returns
Type
Description
string

setForwardingRule

Required. Immutable. The regional forwarding rule that fronts the mirroring collectors, for example: projects/123456789/regions/us-central1/forwardingRules/my-rule . See https://google.aip.dev/124 .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getMirroringDeploymentGroup

Required. Immutable. The deployment group that this deployment is a part of, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg .

See https://google.aip.dev/124 .

Returns
Type
Description
string

setMirroringDeploymentGroup

Required. Immutable. The deployment group that this deployment is a part of, for example: projects/123456789/locations/global/mirroringDeploymentGroups/my-dg .

See https://google.aip.dev/124 .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. The current state of the deployment.

See https://google.aip.dev/216 .

Returns
Type
Description
int
Enum of type State .

setState

Output only. The current state of the deployment.

See https://google.aip.dev/216 .

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. linking a new association to the parent 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. linking a new association to the parent group).

See https://google.aip.dev/128 .

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getDescription

Optional. User-provided description of the deployment.

Used as additional context for the deployment.

Returns
Type
Description
string

setDescription

Optional. User-provided description of the deployment.

Used as additional context for the deployment.

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: