Class protos.google.api.FieldInfo (3.8.0)
Represents a FieldInfo.
Package
@google-cloud/tpuConstructors
(constructor)(properties)
constructor(properties?:google.api.IFieldInfo);Constructs a new FieldInfo.
| Parameter | |
|---|---|
| Name | Description |
properties | IFieldInfoProperties to set |
Properties
format
publicformat:(google.api.FieldInfo.Format|keyoftypeofgoogle.api.FieldInfo.Format);FieldInfo format.
Methods
create(properties)
publicstaticcreate(properties?:google.api.IFieldInfo):google.api.FieldInfo;Creates a new FieldInfo instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IFieldInfoProperties to set |
| Returns | |
|---|---|
| Type | Description |
FieldInfo | FieldInfo instance |
decode(reader, length)
publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.api.FieldInfo;Decodes a FieldInfo 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 |
FieldInfo | FieldInfo |
decodeDelimited(reader)
publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.api.FieldInfo;Decodes a FieldInfo message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
FieldInfo | FieldInfo |
encode(message, writer)
publicstaticencode(message:google.api.IFieldInfo,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified FieldInfo message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IFieldInfoFieldInfo message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
publicstaticencodeDelimited(message:google.api.IFieldInfo,writer?:$protobuf.Writer):$protobuf.Writer;Encodes the specified FieldInfo message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message | IFieldInfoFieldInfo 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.api.FieldInfo;Creates a FieldInfo 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 |
FieldInfo | FieldInfo |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for FieldInfo
| 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 FieldInfo to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
publicstatictoObject(message:google.api.FieldInfo,options?:$protobuf.IConversionOptions):{[k:string]:any};Creates a plain object from a FieldInfo message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message | FieldInfoFieldInfo |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a FieldInfo 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.