Class protos.google.cloud.sql.v1.IpMapping (0.14.0)

Represents an IpMapping.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

  constructor 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 IIpMapping 
 ); 
 

Constructs a new IpMapping.

Parameter
Name
Description
properties
IIpMapping

Properties to set

Properties

ipAddress

  public 
  
 ipAddress 
 : 
  
 string 
 ; 
 

IpMapping ipAddress.

timeToRetire

  public 
  
 timeToRetire 
 ?: 
  
 ( 
 google 
 . 
 protobuf 
 . 
 ITimestamp 
 | 
 null 
 ); 
 

IpMapping timeToRetire.

type

  public 
  
 type 
 : 
  
 ( 
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 SqlIpAddressType 
 | 
 keyof 
  
 typeof 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 SqlIpAddressType 
 ); 
 

IpMapping type.

Methods

create(properties)

  public 
  
 static 
  
 create 
 ( 
 properties 
 ?: 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 IIpMapping 
 ) 
 : 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 IpMapping 
 ; 
 

Creates a new IpMapping instance using the specified properties.

Parameter
Name
Description
properties
IIpMapping

Properties to set

Returns
Type
Description

IpMapping instance

decode(reader, length)

  public 
  
 static 
  
 decode 
 ( 
 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
number

Message length if known beforehand

Returns
Type
Description

IpMapping

decodeDelimited(reader)

  public 
  
 static 
  
 decodeDelimited 
 ( 
 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

encode(message, writer)

  public 
  
 static 
  
 encode 
 ( 
 message 
 : 
  
 google 
 . 
 cloud 
 . 
 sql 
 . 
 v1 
 . 
 IIpMapping 
 , 
  
 writer 
 ?: 
  
 $protobuf 
 . 
 Writer 
 ) 
 : 
  
 $protobuf 
 . 
 Writer 
 ; 
 

Encodes the specified IpMapping message. Does not implicitly messages.

Parameters
Name
Description
message
IIpMapping

IpMapping message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

  public 
  
 static 
  
 encodeDelimited 
 ( 
 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
IIpMapping

IpMapping message or plain object to encode

writer
$protobuf.Writer

Writer to encode to

Returns
Type
Description
$protobuf.Writer

Writer

fromObject(object)

  public 
  
 static 
  
 fromObject 
 ( 
 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

getTypeUrl(typeUrlPrefix)

  public 
  
 static 
  
 getTypeUrl 
 ( 
 typeUrlPrefix 
 ?: 
  
 string 
 ) 
 : 
  
 string 
 ; 
 

Gets the default type url for IpMapping

Parameter
Name
Description
typeUrlPrefix
string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type
Description
string

The default type url

toJSON()

  public 
  
 toJSON 
 () 
 : 
  
 { 
  
 [ 
 k 
 : 
  
 string 
 ] 
 : 
  
 any 
  
 }; 
 

Converts this IpMapping to JSON.

Returns
Type
Description
{ [k: string]: any }

JSON object

toObject(message, options)

  public 
  
 static 
  
 toObject 
 ( 
 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
IpMapping

IpMapping

options
$protobuf.IConversionOptions

Conversion options

Returns
Type
Description
{ [k: string]: any }

Plain object

verify(message)

  public 
  
 static 
  
 verify 
 ( 
 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)

null if valid, otherwise the reason why it is not

Create a Mobile Website
View Site in Mobile | Classic
Share by: