Represents a TagField.
Package
@google-cloud/datacatalogConstructors
(constructor)(properties)
constructor(properties?: google.cloud.datacatalog.v1beta1.ITagField);
Constructs a new TagField.
Parameter | |
---|---|
Name | Description |
properties |
ITagField
Properties to set |
Properties
boolValue
public boolValue?: (boolean|null);
TagField boolValue.
displayName
public displayName: string;
TagField displayName.
doubleValue
public doubleValue?: (number|null);
TagField doubleValue.
enumValue
public enumValue?: (google.cloud.datacatalog.v1beta1.TagField.IEnumValue|null);
TagField enumValue.
kind
public kind?: ("doubleValue"|"stringValue"|"boolValue"|"timestampValue"|"enumValue");
TagField kind.
order
public order: number;
TagField order.
stringValue
public stringValue?: (string|null);
TagField stringValue.
timestampValue
public timestampValue?: (google.protobuf.ITimestamp|null);
TagField timestampValue.
Methods
create(properties)
public static create(properties?: google.cloud.datacatalog.v1beta1.ITagField): google.cloud.datacatalog.v1beta1.TagField;
Creates a new TagField instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
ITagField
Properties to set |
Returns | |
---|---|
Type | Description |
TagField |
TagField instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datacatalog.v1beta1.TagField;
Decodes a TagField 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 |
TagField |
TagField |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datacatalog.v1beta1.TagField;
Decodes a TagField message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
TagField |
TagField |
encode(message, writer)
public static encode(message: google.cloud.datacatalog.v1beta1.ITagField, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified TagField message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITagField
TagField 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.cloud.datacatalog.v1beta1.ITagField, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified TagField message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
ITagField
TagField 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.cloud.datacatalog.v1beta1.TagField;
Creates a TagField 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 |
TagField |
TagField |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for TagField
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 TagField to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.datacatalog.v1beta1.TagField, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a TagField message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
TagField
TagField |
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 TagField message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|