Class protos.google.cloud.sql.v1.PscConfig (0.13.0)

Represents a PscConfig.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

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

Constructs a new PscConfig.

Parameter
NameDescription
propertiesIPscConfig

Properties to set

Properties

_pscEnabled

public_pscEnabled?:"pscEnabled";

PscConfig _pscEnabled.

allowedConsumerProjects

publicallowedConsumerProjects:string[];

PscConfig allowedConsumerProjects.

pscEnabled

publicpscEnabled?:(boolean|null);

PscConfig pscEnabled.

Methods

create(properties)

publicstaticcreate(properties?:google.cloud.sql.v1.IPscConfig):google.cloud.sql.v1.PscConfig;

Creates a new PscConfig instance using the specified properties.

Parameter
NameDescription
propertiesIPscConfig

Properties to set

Returns
TypeDescription
PscConfig

PscConfig instance

decode(reader, length)

publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.cloud.sql.v1.PscConfig;

Decodes a PscConfig message from the specified reader or buffer.

Parameters
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

lengthnumber

Message length if known beforehand

Returns
TypeDescription
PscConfig

PscConfig

decodeDelimited(reader)

publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.cloud.sql.v1.PscConfig;

Decodes a PscConfig message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
PscConfig

PscConfig

encode(message, writer)

publicstaticencode(message:google.cloud.sql.v1.IPscConfig,writer?:$protobuf.Writer):$protobuf.Writer;

Encodes the specified PscConfig message. Does not implicitly messages.

Parameters
NameDescription
messageIPscConfig

PscConfig message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

publicstaticencodeDelimited(message:google.cloud.sql.v1.IPscConfig,writer?:$protobuf.Writer):$protobuf.Writer;

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

Parameters
NameDescription
messageIPscConfig

PscConfig message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

publicstaticfromObject(object:{[k:string]:any}):google.cloud.sql.v1.PscConfig;

Creates a PscConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object{ [k: string]: any }

Plain object

Returns
TypeDescription
PscConfig

PscConfig

getTypeUrl(typeUrlPrefix)

publicstaticgetTypeUrl(typeUrlPrefix?:string):string;

Gets the default type url for PscConfig

Parameter
NameDescription
typeUrlPrefixstring

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

Returns
TypeDescription
string

The default type url

toJSON()

publictoJSON():{[k:string]:any};

Converts this PscConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

publicstatictoObject(message:google.cloud.sql.v1.PscConfig,options?:$protobuf.IConversionOptions):{[k:string]:any};

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

Parameters
NameDescription
messagePscConfig

PscConfig

options$protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

publicstaticverify(message:{[k:string]:any}):(string|null);

Verifies a PscConfig message.

Parameter
NameDescription
message{ [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not

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.