Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class ConsumerPscConnection.
PSC connection details on consumer side.
Generated from protobuf message google.cloud.networkconnectivity.v1.ServiceConnectionMap.ConsumerPscConnection
Namespace
Google \ Cloud \ NetworkConnectivity \ V1 \ ServiceConnectionMapMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ service_attachment_uri |
string
The URI of a service attachment which is the target of the PSC connection. |
↳ state |
int
The state of the PSC connection. |
↳ project |
string
The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map. |
↳ network |
string
The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC). |
↳ psc_connection_id |
string
The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map. |
↳ ip |
string
The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map. |
↳ error_type |
int
The error type indicates whether the error is consumer facing, producer facing or system internal. |
↳ error |
Google\Rpc\Status
The most recent error during operating this connection. |
↳ gce_operation |
string
The last Compute Engine operation to setup PSC connection. |
↳ forwarding_rule |
string
The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}. |
↳ error_info |
Google\Rpc\ErrorInfo
Output only. The error info for the latest error during operating this connection. |
↳ selected_subnetwork |
string
Output only. The URI of the selected subnetwork selected to allocate IP address for this connection. |
↳ producer_instance_id |
string
Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. |
↳ producer_instance_metadata |
array|Google\Protobuf\Internal\MapField
Immutable. An immutable map for the producer instance metadata. |
↳ ip_version |
int
The requested IP version for the PSC connection. |
getServiceAttachmentUri
The URI of a service attachment which is the target of the PSC connection.
Returns | |
---|---|
Type | Description |
string |
setServiceAttachmentUri
The URI of a service attachment which is the target of the PSC connection.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getState
The state of the PSC connection.
Returns | |
---|---|
Type | Description |
int |
setState
The state of the PSC connection.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getProject
The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.
Returns | |
---|---|
Type | Description |
string |
setProject
The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getNetwork
The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map.
Note that the network could be on a different project (shared VPC).
Returns | |
---|---|
Type | Description |
string |
setNetwork
The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map.
Note that the network could be on a different project (shared VPC).
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPscConnectionId
The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.
Returns | |
---|---|
Type | Description |
string |
setPscConnectionId
The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getIp
The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.
Returns | |
---|---|
Type | Description |
string |
setIp
The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getErrorType
The error type indicates whether the error is consumer facing, producer facing or system internal.
Returns | |
---|---|
Type | Description |
int |
setErrorType
The error type indicates whether the error is consumer facing, producer facing or system internal.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getError
The most recent error during operating this connection.
Returns | |
---|---|
Type | Description |
Google\Rpc\Status|null |
hasError
clearError
setError
The most recent error during operating this connection.
Parameter | |
---|---|
Name | Description |
var |
Google\Rpc\Status
|
Returns | |
---|---|
Type | Description |
$this |
getGceOperation
The last Compute Engine operation to setup PSC connection.
Returns | |
---|---|
Type | Description |
string |
setGceOperation
The last Compute Engine operation to setup PSC connection.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getForwardingRule
The URI of the consumer forwarding rule created.
Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.
Returns | |
---|---|
Type | Description |
string |
setForwardingRule
The URI of the consumer forwarding rule created.
Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getErrorInfo
Output only. The error info for the latest error during operating this connection.
Returns | |
---|---|
Type | Description |
Google\Rpc\ErrorInfo|null |
hasErrorInfo
clearErrorInfo
setErrorInfo
Output only. The error info for the latest error during operating this connection.
Parameter | |
---|---|
Name | Description |
var |
Google\Rpc\ErrorInfo
|
Returns | |
---|---|
Type | Description |
$this |
getSelectedSubnetwork
Output only. The URI of the selected subnetwork selected to allocate IP address for this connection.
Returns | |
---|---|
Type | Description |
string |
setSelectedSubnetwork
Output only. The URI of the selected subnetwork selected to allocate IP address for this connection.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getProducerInstanceId
Immutable. Deprecated. Use producer_instance_metadata instead.
An immutable identifier for the producer instance.
Returns | |
---|---|
Type | Description |
string |
setProducerInstanceId
Immutable. Deprecated. Use producer_instance_metadata instead.
An immutable identifier for the producer instance.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getProducerInstanceMetadata
Immutable. An immutable map for the producer instance metadata.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setProducerInstanceMetadata
Immutable. An immutable map for the producer instance metadata.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getIpVersion
The requested IP version for the PSC connection.
Returns | |
---|---|
Type | Description |
int |
hasIpVersion
clearIpVersion
setIpVersion
The requested IP version for the PSC connection.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |