Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class NetworkConfig.
Metadata related to network configuration.
Generated from protobuf messagegoogle.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.
[[["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 NetworkConfig (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.Cluster.NetworkConfig)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.Cluster.NetworkConfig)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.Cluster.NetworkConfig)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.Cluster.NetworkConfig)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.Cluster.NetworkConfig)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.Cluster.NetworkConfig)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.Cluster.NetworkConfig)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.Cluster.NetworkConfig)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.Cluster.NetworkConfig)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.Cluster.NetworkConfig)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.Cluster.NetworkConfig)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.Cluster.NetworkConfig)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.Cluster.NetworkConfig)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.Cluster.NetworkConfig)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.Cluster.NetworkConfig)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.Cluster.NetworkConfig) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class NetworkConfig.\n\nMetadata related to network configuration.\n\nGenerated from protobuf message `google.cloud.alloydb.v1.Cluster.NetworkConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1 \\\\ Cluster\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getNetwork\n\nOptional. The resource link for the VPC network in which cluster\nresources are created and from which they are accessible via Private IP.\n\nThe network must belong to the same project as the cluster. It is\nspecified in the form:\n`projects/{project_number}/global/networks/{network_id}`. This is\nrequired to create a cluster.\n\n### setNetwork\n\nOptional. The resource link for the VPC network in which cluster\nresources are created and from which they are accessible via Private IP.\n\nThe network must belong to the same project as the cluster. It is\nspecified in the form:\n`projects/{project_number}/global/networks/{network_id}`. This is\nrequired to create a cluster.\n\n### getAllocatedIpRange\n\nOptional. Name of the allocated IP range for the private IP AlloyDB\ncluster, for example: \"google-managed-services-default\". If set, the\ninstance IPs for this cluster will be created in the allocated range. The\nrange name must comply with RFC 1035. Specifically, the name must be 1-63\ncharacters long and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?`.\n\nField name is intended to be consistent with Cloud SQL.\n\n### setAllocatedIpRange\n\nOptional. Name of the allocated IP range for the private IP AlloyDB\ncluster, for example: \"google-managed-services-default\". If set, the\ninstance IPs for this cluster will be created in the allocated range. The\nrange name must comply with RFC 1035. Specifically, the name must be 1-63\ncharacters long and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?`.\n\nField name is intended to be consistent with Cloud SQL."]]
