Class protos.google.protobuf.Struct (11.2.0)
Represents a Struct.
Package
@google-cloud/loggingConstructors
(constructor)(properties)
constructor(properties?:google.protobuf.IStruct);Constructs a new Struct.
| Parameter | |
|---|---|
| Name | Description |
properties | IStructProperties to set |
Properties
fields
publicfields:{[k:string]:google.protobuf.IValue};Struct fields.
Methods
create(properties)
publicstaticcreate(properties?:google.protobuf.IStruct):google.protobuf.Struct;Creates a new Struct instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IStructProperties to set |
| Returns | |
|---|---|
| Type | Description |
Struct | Struct instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.protobuf.Struct;Decodes a Struct message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Struct | Struct |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.protobuf.Struct;Decodes a Struct message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Struct | Struct |
encode(message, writer)
publicstaticencode(message:google.protobuf.IStruct,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Struct message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IStructStruct message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.protobuf.IStruct,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified Struct message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IStructStruct message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
publicstaticfromObject(object:{[k:string]:any}):google.protobuf.Struct;Creates a Struct 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 |
Struct | Struct |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Struct
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this Struct to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.protobuf.Struct,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a Struct message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | StructStruct |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a Struct message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
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.