Google Cloud Sql Admin V1 Client - Class IpMapping (1.3.1)

Version latest

• 1.3.1 (latest)
• 1.3.0
• 1.2.6
• 1.1.0
• 1.0.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.1
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.12

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

Database instance IP mapping

Generated from protobuf message google.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. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.
↳ ip_address	string The IP address assigned.
↳ time_to_retire	Google\Protobuf\Timestamp The due time for this IP to be retired in RFC 3339 format, for example 2012-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. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.

Returns
Type	Description
int	Enum of type SqlIpAddressType.

setType

The type of this IP address. A PRIMARY address is a public address that can accept incoming connections. A PRIVATE address is a private address that can accept incoming connections. An OUTGOING address is the source address of connections originating from the instance, if supported.

Parameter
Name	Description
var	int Enum of type SqlIpAddressType.

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 in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasTimeToRetire

clearTimeToRetire

setTimeToRetire

The due time for this IP to be retired in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. This field is only available when the IP is scheduled to be retired.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this