Google Cloud Sql Admin V1 Client - Class PscAutoConnectionConfig (1.10.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class PscAutoConnectionConfig.

Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.

Generated from protobuf message google.cloud.sql.v1.PscAutoConnectionConfig

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ consumer_project`	`string` Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network.
`↳ consumer_network`	`string` Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project.
`↳ ip_address`	`string` The IP address of the consumer endpoint.
`↳ status`	`string` The connection status of the consumer endpoint.
`↳ consumer_network_status`	`string` The connection policy status of the consumer network.
`↳ service_connection_policy`	`string` Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`.
`↳ service_connection_policy_creation_result`	`string` Output only. The status of service connection policy creation.
`↳ instance_auto_dns_status`	`int` Output only. The status of automated DNS provisioning.
`↳ write_endpoint_auto_dns_status`	`int` Output only. The status of automated DNS provisioning for the write endpoint.

getConsumerProject

Optional. This is the project ID of consumer service project of this consumer endpoint.

This is only applicable if consumer_network is a shared VPC network.

Returns
Type	Description
`string`

setConsumerProject

Optional. This is the project ID of consumer service project of this consumer endpoint.

This is only applicable if consumer_network is a shared VPC network.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConsumerNetwork

Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name.

For example, projects/project1/global/networks/network1. The consumer host project of this network might be different from the consumer service project.

Returns
Type	Description
`string`

setConsumerNetwork

Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name.

For example, projects/project1/global/networks/network1. The consumer host project of this network might be different from the consumer service project.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIpAddress

The IP address of the consumer endpoint.

Returns
Type	Description
`string`

hasIpAddress

clearIpAddress

setIpAddress

The IP address of the consumer endpoint.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStatus

The connection status of the consumer endpoint.

Returns
Type	Description
`string`

hasStatus

clearStatus

setStatus

The connection status of the consumer endpoint.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConsumerNetworkStatus

The connection policy status of the consumer network.

Returns
Type	Description
`string`

hasConsumerNetworkStatus

clearConsumerNetworkStatus

setConsumerNetworkStatus

The connection policy status of the consumer network.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getServiceConnectionPolicy

Output only. The service connection policy created automatically for the consumer network when psc_auto_connection_policy_enabled is true. It is in the format of: projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id} The policy_id is in format of $NETWORK-$RANDOM.

Returns
Type	Description
`string`

hasServiceConnectionPolicy

clearServiceConnectionPolicy

setServiceConnectionPolicy

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getServiceConnectionPolicyCreationResult

Output only. The status of service connection policy creation.

Returns
Type	Description
`string`

hasServiceConnectionPolicyCreationResult

clearServiceConnectionPolicyCreationResult

setServiceConnectionPolicyCreationResult