Class protos.google.api.PhpSettings (5.1.0)

Represents a PhpSettings.

Package

@google-cloud/redis

Constructors

(constructor)(properties)

constructor(properties?:google.api.IPhpSettings);

Constructs a new PhpSettings.

Parameter
NameDescription
propertiesIPhpSettings

Properties to set

Properties

common

publiccommon?:(google.api.ICommonLanguageSettings|null);

PhpSettings common.

Methods

create(properties)

publicstaticcreate(properties?:google.api.IPhpSettings):google.api.PhpSettings;

Creates a new PhpSettings instance using the specified properties.

Parameter
NameDescription
propertiesIPhpSettings

Properties to set

Returns
TypeDescription
PhpSettings

PhpSettings instance

decode(reader, length)

publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.api.PhpSettings;

Decodes a PhpSettings 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
PhpSettings

PhpSettings

decodeDelimited(reader)

publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.api.PhpSettings;

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

Parameter
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
PhpSettings

PhpSettings

encode(message, writer)

publicstaticencode(message:google.api.IPhpSettings,writer?:$protobuf.Writer):$protobuf.Writer;

Encodes the specified PhpSettings message. Does not implicitly messages.

Parameters
NameDescription
messageIPhpSettings

PhpSettings message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

publicstaticencodeDelimited(message:google.api.IPhpSettings,writer?:$protobuf.Writer):$protobuf.Writer;

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

Parameters
NameDescription
messageIPhpSettings

PhpSettings 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.api.PhpSettings;

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

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

Plain object

Returns
TypeDescription
PhpSettings

PhpSettings

getTypeUrl(typeUrlPrefix)

publicstaticgetTypeUrl(typeUrlPrefix?:string):string;

Gets the default type url for PhpSettings

Parameter
NameDescription
typeUrlPrefixstring

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this PhpSettings to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

publicstatictoObject(message:google.api.PhpSettings,options?:$protobuf.IConversionOptions):{[k:string]:any};

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

Parameters
NameDescription
messagePhpSettings

PhpSettings

options$protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a PhpSettings 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-10-30 UTC.