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 messagegoogle.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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud AlloyDB for PostgreSQL V1 Client - Class PscAutoConnectionConfig (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.Instance.PscAutoConnectionConfig)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.Instance.PscAutoConnectionConfig)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.Instance.PscAutoConnectionConfig)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.Instance.PscAutoConnectionConfig)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.Instance.PscAutoConnectionConfig)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.Instance.PscAutoConnectionConfig)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.Instance.PscAutoConnectionConfig)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.Instance.PscAutoConnectionConfig)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.Instance.PscAutoConnectionConfig)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.Instance.PscAutoConnectionConfig)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.Instance.PscAutoConnectionConfig)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.Instance.PscAutoConnectionConfig)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.Instance.PscAutoConnectionConfig)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.Instance.PscAutoConnectionConfig)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.Instance.PscAutoConnectionConfig)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.Instance.PscAutoConnectionConfig) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class PscAutoConnectionConfig.\n\nConfiguration for setting up PSC service automation. Consumer projects in\nthe configs will be allowlisted automatically for the instance.\n\nGenerated from protobuf message `google.cloud.alloydb.v1.Instance.PscAutoConnectionConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1 \\\\ Instance\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getConsumerProject\n\nThe consumer project to which the PSC service automation endpoint will\nbe created.\n\n### setConsumerProject\n\nThe consumer project to which the PSC service automation endpoint will\nbe created.\n\n### getConsumerNetwork\n\nThe consumer network for the PSC service automation, example:\n\"projects/vpc-host-project/global/networks/default\".\n\nThe consumer network might be hosted a different project than the\nconsumer project.\n\n### setConsumerNetwork\n\nThe consumer network for the PSC service automation, example:\n\"projects/vpc-host-project/global/networks/default\".\n\nThe consumer network might be hosted a different project than the\nconsumer project.\n\n### getIpAddress\n\nOutput only. The IP address of the PSC service automation endpoint.\n\n### setIpAddress\n\nOutput only. The IP address of the PSC service automation endpoint.\n\n### getStatus\n\nOutput only. The status of the PSC service automation connection.\n\nPossible values:\n\"STATE_UNSPECIFIED\" - An invalid state as the default case.\n\"ACTIVE\" - The connection has been created successfully.\n\"FAILED\" - The connection is not functional since some resources on the\nconnection fail to be created.\n\"CREATING\" - The connection is being created.\n\"DELETING\" - The connection is being deleted.\n\"CREATE_REPAIRING\" - The connection is being repaired to complete\ncreation.\n\"DELETE_REPAIRING\" - The connection is being repaired to complete\ndeletion.\n\n### setStatus\n\nOutput only. The status of the PSC service automation connection.\n\nPossible values:\n\"STATE_UNSPECIFIED\" - An invalid state as the default case.\n\"ACTIVE\" - The connection has been created successfully.\n\"FAILED\" - The connection is not functional since some resources on the\nconnection fail to be created.\n\"CREATING\" - The connection is being created.\n\"DELETING\" - The connection is being deleted.\n\"CREATE_REPAIRING\" - The connection is being repaired to complete\ncreation.\n\"DELETE_REPAIRING\" - The connection is being repaired to complete\ndeletion.\n\n### getConsumerNetworkStatus\n\nOutput only. The status of the service connection policy.\n\nPossible values:\n\"STATE_UNSPECIFIED\" - Default state, when Connection Map is created\ninitially.\n\"VALID\" - Set when policy and map configuration is valid, and their\nmatching can lead to allowing creation of PSC Connections subject to\nother constraints like connections limit.\n\"CONNECTION_POLICY_MISSING\" - No Service Connection Policy found for\nthis network and Service Class\n\"POLICY_LIMIT_REACHED\" - Service Connection Policy limit reached for\nthis network and Service Class\n\"CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED\" - The consumer instance\nproject is not in AllowedGoogleProducersResourceHierarchyLevels of the\nmatching ServiceConnectionPolicy.\n\n### setConsumerNetworkStatus\n\nOutput only. The status of the service connection policy.\n\nPossible values:\n\"STATE_UNSPECIFIED\" - Default state, when Connection Map is created\ninitially.\n\"VALID\" - Set when policy and map configuration is valid, and their\nmatching can lead to allowing creation of PSC Connections subject to\nother constraints like connections limit.\n\"CONNECTION_POLICY_MISSING\" - No Service Connection Policy found for\nthis network and Service Class\n\"POLICY_LIMIT_REACHED\" - Service Connection Policy limit reached for\nthis network and Service Class\n\"CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED\" - The consumer instance\nproject is not in AllowedGoogleProducersResourceHierarchyLevels of the\nmatching ServiceConnectionPolicy."]]
