Google Cloud AlloyDB for PostgreSQL V1 Client - Class NetworkConfig (1.1.0)

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

Metadata related to network configuration.

Generated from protobuf message google.cloud.alloydb.v1.Cluster.NetworkConfig

Namespace

Google \ Cloud \ AlloyDb \ V1 \ Cluster

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: projects/{project_number}/global/networks/{network_id}. This is required to create a cluster.
↳ allocated_ip_range string

Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Field name is intended to be consistent with Cloud SQL.

getNetwork

Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP.

The network must belong to the same project as the cluster. It is specified in the form: projects/{project_number}/global/networks/{network_id}. This is required to create a cluster.

Returns
Type Description
string

setNetwork

Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP.

The network must belong to the same project as the cluster. It is specified in the form: projects/{project_number}/global/networks/{network_id}. This is required to create a cluster.

Parameter
Name Description
var string
Returns
Type Description
$this

getAllocatedIpRange

Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.

Field name is intended to be consistent with Cloud SQL.

Returns
Type Description
string

setAllocatedIpRange

Optional. Name of the allocated IP range for the private IP AlloyDB cluster, for example: "google-managed-services-default". If set, the instance IPs for this cluster will be created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.

Field name is intended to be consistent with Cloud SQL.

Parameter
Name Description
var string
Returns
Type Description
$this