Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class ServiceConnectionMap.
The ServiceConnectionMap resource.
Generated from protobuf message google.cloud.networkconnectivity.v1.ServiceConnectionMap
Namespace
Google \ Cloud \ NetworkConnectivity \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Time when the ServiceConnectionMap was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Time when the ServiceConnectionMap was updated. |
↳ labels |
array|Google\Protobuf\Internal\MapField
User-defined labels. |
↳ description |
string
A description of this resource. |
↳ service_class |
string
The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class. |
↳ service_class_uri |
string
Output only. The service class uri this ServiceConnectionMap is for. |
↳ infrastructure |
int
Output only. The infrastructure used for connections between consumers/producers. |
↳ producer_psc_configs |
array<ServiceConnectionMap\ProducerPscConfig>
The PSC configurations on producer side. |
↳ consumer_psc_configs |
array<ServiceConnectionMap\ConsumerPscConfig>
The PSC configurations on consumer side. |
↳ consumer_psc_connections |
array<ServiceConnectionMap\ConsumerPscConnection>
Output only. PSC connection details on consumer side. |
↳ token |
string
The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network. |
↳ etag |
string
Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
getName
Immutable. The name of a ServiceConnectionMap.
Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Immutable. The name of a ServiceConnectionMap.
Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Time when the ServiceConnectionMap was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Time when the ServiceConnectionMap was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Time when the ServiceConnectionMap was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Time when the ServiceConnectionMap was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
User-defined labels.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
User-defined labels.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
A description of this resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
A description of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceClass
The service class identifier this ServiceConnectionMap is for.
The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceClass
The service class identifier this ServiceConnectionMap is for.
The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceClassUri
Output only. The service class uri this ServiceConnectionMap is for.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceClassUri
Output only. The service class uri this ServiceConnectionMap is for.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInfrastructure
Output only. The infrastructure used for connections between consumers/producers.
| Returns | |
|---|---|
| Type | Description |
int |
|
setInfrastructure
Output only. The infrastructure used for connections between consumers/producers.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProducerPscConfigs
The PSC configurations on producer side.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProducerPscConfigs
The PSC configurations on producer side.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ServiceConnectionMap\ProducerPscConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConsumerPscConfigs
The PSC configurations on consumer side.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setConsumerPscConfigs
The PSC configurations on consumer side.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ServiceConnectionMap\ConsumerPscConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConsumerPscConnections
Output only. PSC connection details on consumer side.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setConsumerPscConnections
Output only. PSC connection details on consumer side.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ServiceConnectionMap\ConsumerPscConnection>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getToken
The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
| Returns | |
|---|---|
| Type | Description |
string |
|
setToken
The token provided by the consumer. This token authenticates that the consumer can create a connection within the specified project and network.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEtag
Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasEtag
clearEtag
setEtag
Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|