Class protos.google.cloud.sql.v1.IpConfiguration (0.19.0)

Represents an IpConfiguration.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

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

Constructs a new IpConfiguration.

Parameter
Name Description
properties IIpConfiguration

Properties to set

Properties

_pscConfig

public _pscConfig?: "pscConfig";

IpConfiguration _pscConfig.

_serverCaMode

public _serverCaMode?: "serverCaMode";

IpConfiguration _serverCaMode.

allocatedIpRange

public allocatedIpRange: string;

IpConfiguration allocatedIpRange.

authorizedNetworks

public authorizedNetworks: google.cloud.sql.v1.IAclEntry[];

IpConfiguration authorizedNetworks.

enablePrivatePathForGoogleCloudServices

public enablePrivatePathForGoogleCloudServices?: (google.protobuf.IBoolValue|null);

IpConfiguration enablePrivatePathForGoogleCloudServices.

ipv4Enabled

public ipv4Enabled?: (google.protobuf.IBoolValue|null);

IpConfiguration ipv4Enabled.

privateNetwork

public privateNetwork: string;

IpConfiguration privateNetwork.

pscConfig

public pscConfig?: (google.cloud.sql.v1.IPscConfig|null);

IpConfiguration pscConfig.

requireSsl

public requireSsl?: (google.protobuf.IBoolValue|null);

IpConfiguration requireSsl.

serverCaMode

public serverCaMode?: (google.cloud.sql.v1.IpConfiguration.CaMode|keyof typeof google.cloud.sql.v1.IpConfiguration.CaMode|null);

IpConfiguration serverCaMode.

sslMode

public sslMode: (google.cloud.sql.v1.IpConfiguration.SslMode|keyof typeof google.cloud.sql.v1.IpConfiguration.SslMode);

IpConfiguration sslMode.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.IIpConfiguration): google.cloud.sql.v1.IpConfiguration;

Creates a new IpConfiguration instance using the specified properties.

Parameter
Name Description
properties IIpConfiguration

Properties to set

Returns
Type Description
IpConfiguration

IpConfiguration instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.sql.v1.IpConfiguration;

Decodes an IpConfiguration 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
IpConfiguration

IpConfiguration

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1.IpConfiguration;

Decodes an IpConfiguration message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
IpConfiguration

IpConfiguration

encode(message, writer)

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

Encodes the specified IpConfiguration message. Does not implicitly messages.

Parameters
Name Description
message IIpConfiguration

IpConfiguration 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.IIpConfiguration, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified IpConfiguration message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IIpConfiguration

IpConfiguration 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.IpConfiguration;

Creates an IpConfiguration 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
IpConfiguration

IpConfiguration

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for IpConfiguration

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 IpConfiguration to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.sql.v1.IpConfiguration, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an IpConfiguration message. Also converts values to other types if specified.

Parameters
Name Description
message IpConfiguration

IpConfiguration

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 IpConfiguration 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