Represents a Field.
Package
@google-cloud/service-usageConstructors
(constructor)(properties)
constructor(properties?: google.protobuf.IField);Constructs a new Field.
| Parameter | |
|---|---|
| Name | Description |
properties |
IField
Properties to set |
Properties
cardinality
public cardinality: (google.protobuf.Field.Cardinality|keyof typeof google.protobuf.Field.Cardinality);Field cardinality.
defaultValue
public defaultValue: string;Field defaultValue.
jsonName
public jsonName: string;Field jsonName.
kind
public kind: (google.protobuf.Field.Kind|keyof typeof google.protobuf.Field.Kind);Field kind.
name
public name: string;Field name.
number
public number: number;Field number.
oneofIndex
public oneofIndex: number;Field oneofIndex.
options
public options: google.protobuf.IOption[];Field options.
packed
public packed: boolean;Field packed.
typeUrl
public typeUrl: string;Field typeUrl.
Methods
create(properties)
public static create(properties?: google.protobuf.IField): google.protobuf.Field;Creates a new Field instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IField
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Field | Field instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.Field;Decodes a Field message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Field | Field |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.Field;Decodes a Field message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Field | Field |
encode(message, writer)
public static encode(message: google.protobuf.IField, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Field message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IField
Field message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.protobuf.IField, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Field message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IField
Field message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.protobuf.Field;Creates a Field 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 |
Field | Field |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Field
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Field to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.protobuf.Field, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Field message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Field
Field |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Field message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|