Class protos.google.cloud.sql.v1.IpMapping (0.5.0)
Represents an IpMapping.
Package
@google-cloud/sqlConstructors
(constructor)(properties)
constructor(properties?:google.cloud.sql.v1.IIpMapping);Constructs a new IpMapping.
| Parameter | |
|---|---|
| Name | Description |
properties | IIpMappingProperties to set |
Properties
ipAddress
publicipAddress:string;IpMapping ipAddress.
timeToRetire
publictimeToRetire?:(google.protobuf.ITimestamp|null);IpMapping timeToRetire.
type
publictype:(google.cloud.sql.v1.SqlIpAddressType|keyoftypeofgoogle.cloud.sql.v1.SqlIpAddressType);IpMapping type.
Methods
create(properties)
publicstaticcreate(properties?:google.cloud.sql.v1.IIpMapping):google.cloud.sql.v1.IpMapping;Creates a new IpMapping instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IIpMappingProperties to set |
| Returns | |
|---|---|
| Type | Description |
IpMapping | IpMapping instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.sql.v1.IpMapping;Decodes an IpMapping message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
IpMapping | IpMapping |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.sql.v1.IpMapping;Decodes an IpMapping message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
IpMapping | IpMapping |
encode(message, writer)
publicstaticencode(message:google.cloud.sql.v1.IIpMapping,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified IpMapping message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IIpMappingIpMapping message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.cloud.sql.v1.IIpMapping,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified IpMapping message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IIpMappingIpMapping message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.cloud.sql.v1.IpMapping;Creates an IpMapping message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object | { [k: string]: any }Plain object |
| Returns | |
|---|---|
| Type | Description |
IpMapping | IpMapping |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for IpMapping
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this IpMapping to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.cloud.sql.v1.IpMapping,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from an IpMapping message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | IpMappingIpMapping |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies an IpMapping message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-03 UTC.