Google Cloud AlloyDB for PostgreSQL V1 Client - Class PscAutoConnectionConfig (1.4.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class PscAutoConnectionConfig.

Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.

Generated from protobuf message google.cloud.alloydb.v1.Instance.PscAutoConnectionConfig

Namespace

Google \ Cloud \ AlloyDb \ V1 \ Instance

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ consumer_project string

The consumer project to which the PSC service automation endpoint will be created.
↳ consumer_network string

The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project.
↳ ip_address string

Output only. The IP address of the PSC service automation endpoint.
↳ status string

Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.
↳ consumer_network_status string

Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.

getConsumerProject

The consumer project to which the PSC service automation endpoint will be created.

Returns
Type Description
string

setConsumerProject

The consumer project to which the PSC service automation endpoint will be created.

Parameter
Name Description
var string
Returns
Type Description
$this

getConsumerNetwork

The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default".

The consumer network might be hosted a different project than the consumer project.

Returns
Type Description
string

setConsumerNetwork

The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default".

The consumer network might be hosted a different project than the consumer project.

Parameter
Name Description
var string
Returns
Type Description
$this

getIpAddress

Output only. The IP address of the PSC service automation endpoint.

Returns
Type Description
string

setIpAddress

Output only. The IP address of the PSC service automation endpoint.

Parameter
Name Description
var string
Returns
Type Description
$this

getStatus

Output only. The status of the PSC service automation connection.

Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.

Returns
Type Description
string

setStatus

Output only. The status of the PSC service automation connection.

Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.

Parameter
Name Description
var string
Returns
Type Description
$this

getConsumerNetworkStatus

Output only. The status of the service connection policy.

Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.

Returns
Type Description
string

setConsumerNetworkStatus

Output only. The status of the service connection policy.

Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.

Parameter
Name Description
var string
Returns
Type Description
$this