Class protos.google.protobuf.StringValue

Represents a StringValue.

Package

@google-cloud/kms!

Constructors

(constructor)(properties)

constructor(properties?:google.protobuf.IStringValue);

Constructs a new StringValue.

Parameter
TypeNameDescription
IStringValueproperties

Properties to set

Properties

value

publicvalue:string;

StringValue value.

Property Value
TypeDescription
string

Methods

create(properties)

publicstaticcreate(properties?:google.protobuf.IStringValue):google.protobuf.StringValue;

Creates a new StringValue instance using the specified properties.

Parameter
TypeNameDescription
IStringValueproperties

Properties to set

Returns
TypeDescription
google.protobuf.StringValue

StringValue instance

decode(reader, length)

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

Decodes a StringValue message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.protobuf.StringValue

StringValue

decodeDelimited(reader)

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

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.protobuf.StringValue

StringValue

encode(message, writer)

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

Encodes the specified StringValue message. Does not implicitly messages.

Parameters
TypeNameDescription
IStringValuemessage

StringValue message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
TypeNameDescription
IStringValuemessage

StringValue message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

publicstaticfromObject(object:{[k:string]:any}):google.protobuf.StringValue;

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

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

Plain object

Returns
TypeDescription
google.protobuf.StringValue

StringValue

toJSON()

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

Converts this StringValue to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.protobuf.StringValuemessage

StringValue

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a StringValue message.

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

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.