Represents a FieldOptions.
Package
@google-cloud/bigtable!Constructors
(constructor)(properties)
constructor(properties?: google.protobuf.IFieldOptions);
Constructs a new FieldOptions.
Name | Description |
properties |
IFieldOptions
Properties to set |
Properties
ctype
public ctype: (google.protobuf.FieldOptions.CType|keyof typeof google.protobuf.FieldOptions.CType);
FieldOptions ctype.
Type | Description |
(google.protobuf.FieldOptions.CType|keyof typeof google.protobuf.FieldOptions.CType) |
deprecated
public deprecated: boolean;
FieldOptions deprecated.
Type | Description |
boolean |
jstype
public jstype: (google.protobuf.FieldOptions.JSType|keyof typeof google.protobuf.FieldOptions.JSType);
FieldOptions jstype.
Type | Description |
(google.protobuf.FieldOptions.JSType|keyof typeof google.protobuf.FieldOptions.JSType) |
lazy
public lazy: boolean;
FieldOptions lazy.
Type | Description |
boolean |
packed
public packed: boolean;
FieldOptions packed.
Type | Description |
boolean |
uninterpretedOption
public uninterpretedOption: google.protobuf.IUninterpretedOption[];
FieldOptions uninterpretedOption.
Type | Description |
google.protobuf.IUninterpretedOption[] |
weak
public weak: boolean;
FieldOptions weak.
Type | Description |
boolean |
Methods
create(properties)
public static create(properties?: google.protobuf.IFieldOptions): google.protobuf.FieldOptions;
Creates a new FieldOptions instance using the specified properties.
Name | Description |
properties |
IFieldOptions
Properties to set |
Type | Description |
google.protobuf.FieldOptions | FieldOptions instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.protobuf.FieldOptions;
Decodes a FieldOptions message from the specified reader or buffer.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Type | Description |
google.protobuf.FieldOptions | FieldOptions |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.protobuf.FieldOptions;
Decodes a FieldOptions message from the specified reader or buffer, length delimited.
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Type | Description |
google.protobuf.FieldOptions | FieldOptions |
encode(message, writer)
public static encode(message: google.protobuf.IFieldOptions, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified FieldOptions message. Does not implicitly messages.
Name | Description |
message |
IFieldOptions
FieldOptions message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.protobuf.IFieldOptions, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified FieldOptions message, length delimited. Does not implicitly messages.
Name | Description |
message |
IFieldOptions
FieldOptions message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.protobuf.FieldOptions;
Creates a FieldOptions message from a plain object. Also converts values to their respective internal types.
Name | Description |
object |
{ [k: string]: any }
Plain object |
Type | Description |
google.protobuf.FieldOptions | FieldOptions |
toJSON()
public toJSON(): { [k: string]: any };
Converts this FieldOptions to JSON.
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.protobuf.FieldOptions, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a FieldOptions message. Also converts values to other types if specified.
Name | Description |
message |
google.protobuf.FieldOptions
FieldOptions |
options |
$protobuf.IConversionOptions
Conversion options |
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a FieldOptions message.
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Type | Description |
(string|null) |
|