Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class IpMapping.
Database instance IP mapping
Generated from protobuf messagegoogle.cloud.sql.v1.IpMapping
Namespace
Google \ Cloud \ Sql \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ type
int
The type of this IP address. APRIMARYaddress is a public address that can accept incoming connections. APRIVATEaddress is a private address that can accept incoming connections. AnOUTGOINGaddress is the source address of connections originating from the instance, if supported.
The due time for this IP to be retired inRFC 3339format, for example2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.
getType
The type of this IP address. APRIMARYaddress is a public address that
can accept incoming connections. APRIVATEaddress is a private address
that can accept incoming connections. AnOUTGOINGaddress is the source
address of connections originating from the instance, if supported.
Returns
Type
Description
int
setType
The type of this IP address. APRIMARYaddress is a public address that
can accept incoming connections. APRIVATEaddress is a private address
that can accept incoming connections. AnOUTGOINGaddress is the source
address of connections originating from the instance, if supported.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getIpAddress
The IP address assigned.
Returns
Type
Description
string
setIpAddress
The IP address assigned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getTimeToRetire
The due time for this IP to be retired inRFC 3339format, for example2012-11-15T16:19:00.094Z. This field is only available when
the IP is scheduled to be retired.
The due time for this IP to be retired inRFC 3339format, for example2012-11-15T16:19:00.094Z. This field is only available when
the IP is scheduled to be retired.
[[["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 Sql Admin V1 Client - Class IpMapping (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-sql-admin/latest/V1.IpMapping)\n- [1.2.5](/php/docs/reference/cloud-sql-admin/1.2.5/V1.IpMapping)\n- [1.1.0](/php/docs/reference/cloud-sql-admin/1.1.0/V1.IpMapping)\n- [1.0.0](/php/docs/reference/cloud-sql-admin/1.0.0/V1.IpMapping)\n- [0.19.0](/php/docs/reference/cloud-sql-admin/0.19.0/V1.IpMapping)\n- [0.18.0](/php/docs/reference/cloud-sql-admin/0.18.0/V1.IpMapping)\n- [0.17.1](/php/docs/reference/cloud-sql-admin/0.17.1/V1.IpMapping)\n- [0.16.1](/php/docs/reference/cloud-sql-admin/0.16.1/V1.IpMapping)\n- [0.12.0](/php/docs/reference/cloud-sql-admin/0.12.0/V1.IpMapping)\n- [0.11.0](/php/docs/reference/cloud-sql-admin/0.11.0/V1.IpMapping)\n- [0.10.0](/php/docs/reference/cloud-sql-admin/0.10.0/V1.IpMapping)\n- [0.9.0](/php/docs/reference/cloud-sql-admin/0.9.0/V1.IpMapping)\n- [0.8.0](/php/docs/reference/cloud-sql-admin/0.8.0/V1.IpMapping)\n- [0.7.0](/php/docs/reference/cloud-sql-admin/0.7.0/V1.IpMapping)\n- [0.6.0](/php/docs/reference/cloud-sql-admin/0.6.0/V1.IpMapping)\n- [0.5.0](/php/docs/reference/cloud-sql-admin/0.5.0/V1.IpMapping)\n- [0.4.1](/php/docs/reference/cloud-sql-admin/0.4.1/V1.IpMapping)\n- [0.3.1](/php/docs/reference/cloud-sql-admin/0.3.1/V1.IpMapping)\n- [0.2.12](/php/docs/reference/cloud-sql-admin/0.2.12/V1.IpMapping) \nReference documentation and code samples for the Google Cloud Sql Admin V1 Client class IpMapping.\n\nDatabase instance IP mapping\n\nGenerated from protobuf message `google.cloud.sql.v1.IpMapping`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Sql \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getType\n\nThe type of this IP address. A `PRIMARY` address is a public address that\ncan accept incoming connections. A `PRIVATE` address is a private address\nthat can accept incoming connections. An `OUTGOING` address is the source\naddress of connections originating from the instance, if supported.\n\n### setType\n\nThe type of this IP address. A `PRIMARY` address is a public address that\ncan accept incoming connections. A `PRIVATE` address is a private address\nthat can accept incoming connections. An `OUTGOING` address is the source\naddress of connections originating from the instance, if supported.\n\n### getIpAddress\n\nThe IP address assigned.\n\n### setIpAddress\n\nThe IP address assigned.\n\n### getTimeToRetire\n\nThe due time for this IP to be retired in\n[RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example\n`2012-11-15T16:19:00.094Z`. This field is only available when\nthe IP is scheduled to be retired.\n\n### hasTimeToRetire\n\n### clearTimeToRetire\n\n### setTimeToRetire\n\nThe due time for this IP to be retired in\n[RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example\n`2012-11-15T16:19:00.094Z`. This field is only available when\nthe IP is scheduled to be retired."]]
