Represents a DynamicField.
Implements
Package
@google-cloud/geminidataanalyticsConstructors
(constructor)(properties)
constructor(properties?: google.cloud.geminidataanalytics.v1beta.IDynamicField);Constructs a new DynamicField.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDynamicField
Properties to set |
Properties
args
public args: string[];DynamicField args.
basedOn
public basedOn?: (string|null);DynamicField basedOn.
calculationType
public calculationType?: (string|null);DynamicField calculationType.
category
public category?: (string|null);DynamicField category.
description
public description?: (string|null);DynamicField description.
expression
public expression?: (string|null);DynamicField expression.
filterExpression
public filterExpression?: (string|null);DynamicField filterExpression.
isDisabled
public isDisabled?: (boolean|null);DynamicField isDisabled.
kindHint
public kindHint?: (string|null);DynamicField kindHint.
label
public label?: (string|null);DynamicField label.
name
public name?: (string|null);DynamicField name.
type
public type?: (string|null);DynamicField type.
typeHint
public typeHint?: (string|null);DynamicField typeHint.
valueFormat
public valueFormat?: (string|null);DynamicField valueFormat.
valueFormatName
public valueFormatName?: (string|null);DynamicField valueFormatName.
Methods
create(properties)
public static create(properties?: google.cloud.geminidataanalytics.v1beta.IDynamicField): google.cloud.geminidataanalytics.v1beta.DynamicField;Creates a new DynamicField instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDynamicField
Properties to set |
| Returns | |
|---|---|
| Type | Description |
DynamicField |
DynamicField instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.geminidataanalytics.v1beta.DynamicField;Decodes a DynamicField 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 |
DynamicField |
DynamicField |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.geminidataanalytics.v1beta.DynamicField;Decodes a DynamicField message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
DynamicField |
DynamicField |
encode(message, writer)
public static encode(message: google.cloud.geminidataanalytics.v1beta.IDynamicField, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DynamicField message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDynamicField
DynamicField 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.geminidataanalytics.v1beta.IDynamicField, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DynamicField message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDynamicField
DynamicField 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.geminidataanalytics.v1beta.DynamicField;Creates a DynamicField 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 |
DynamicField |
DynamicField |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DynamicField
| 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 DynamicField to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.geminidataanalytics.v1beta.DynamicField, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DynamicField message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
DynamicField
DynamicField |
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 DynamicField message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|