Google Cloud Network Connectivity V1 Client - Class ConsumerPscConfig (2.2.0)
Stay organized with collections Save and categorize content based on your preferences.

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class ConsumerPscConfig.

Allow the producer to specify which consumers can connect to it.

Generated from protobuf message google.cloud.networkconnectivity.v1.ServiceConnectionMap.ConsumerPscConfig

Namespace

Google \ Cloud \ NetworkConnectivity \ V1 \ ServiceConnectionMap

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ project`	`string` The consumer project where PSC connections are allowed to be created in.
`↳ network`	`string` The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.
`↳ disable_global_access`	`bool` This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
`↳ state`	`int` Output only. Overall state of PSC Connections management for this consumer psc config.
`↳ producer_instance_id`	`string` Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.
`↳ service_attachment_ip_address_map`	`array\|Google\Protobuf\Internal\MapField` Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.
`↳ consumer_instance_project`	`string` Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/<project_id_or_number>' Eg. 'projects/consumer-project' or 'projects/1234'
`↳ 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.

getProject

The consumer project where PSC connections are allowed to be created in.

Returns
Type	Description
`string`

setProject

The consumer project where PSC connections are allowed to be created in.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getNetwork

The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC.

Example: projects/{projectNumOrId}/global/networks/{networkId}.

Returns
Type	Description
`string`

setNetwork

The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC.

Example: projects/{projectNumOrId}/global/networks/{networkId}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisableGlobalAccess

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

Returns
Type	Description
`bool`

setDisableGlobalAccess

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getState

Output only. Overall state of PSC Connections management for this consumer psc config.

Returns
Type	Description
`int`

setState

Output only. Overall state of PSC Connections management for this consumer psc config.

Parameter
Name	Description
`var`	`int`

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`

getServiceAttachmentIpAddressMap

Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setServiceAttachmentIpAddressMap

Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getConsumerInstanceProject

Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/<project_id_or_number>' Eg. 'projects/consumer-project' or 'projects/1234'

Returns
Type	Description
`string`

setConsumerInstanceProject

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