Class protos.google.cloud.aiplatform.v1.FeatureValue (3.6.0)

Represents a FeatureValue.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IFeatureValue);

Constructs a new FeatureValue.

Parameter
NameDescription
properties IFeatureValue

Properties to set

Properties

boolArrayValue

public boolArrayValue?: (google.cloud.aiplatform.v1.IBoolArray|null);

FeatureValue boolArrayValue.

boolValue

public boolValue?: (boolean|null);

FeatureValue boolValue.

bytesValue

public bytesValue?: (Uint8Array|string|null);

FeatureValue bytesValue.

doubleArrayValue

public doubleArrayValue?: (google.cloud.aiplatform.v1.IDoubleArray|null);

FeatureValue doubleArrayValue.

doubleValue

public doubleValue?: (number|null);

FeatureValue doubleValue.

int64ArrayValue

public int64ArrayValue?: (google.cloud.aiplatform.v1.IInt64Array|null);

FeatureValue int64ArrayValue.

int64Value

public int64Value?: (number|Long|string|null);

FeatureValue int64Value.

metadata

public metadata?: (google.cloud.aiplatform.v1.FeatureValue.IMetadata|null);

FeatureValue metadata.

stringArrayValue

public stringArrayValue?: (google.cloud.aiplatform.v1.IStringArray|null);

FeatureValue stringArrayValue.

stringValue

public stringValue?: (string|null);

FeatureValue stringValue.

value

public value?: ("boolValue"|"doubleValue"|"int64Value"|"stringValue"|"boolArrayValue"|"doubleArrayValue"|"int64ArrayValue"|"stringArrayValue"|"bytesValue");

FeatureValue value.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IFeatureValue): google.cloud.aiplatform.v1.FeatureValue;

Creates a new FeatureValue instance using the specified properties.

Parameter
NameDescription
properties IFeatureValue

Properties to set

Returns
TypeDescription
FeatureValue

FeatureValue instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.FeatureValue;

Decodes a FeatureValue message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
FeatureValue

FeatureValue

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.FeatureValue;

Decodes a FeatureValue message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
FeatureValue

FeatureValue

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1.IFeatureValue, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified FeatureValue message. Does not implicitly messages.

Parameters
NameDescription
message IFeatureValue

FeatureValue message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.aiplatform.v1.IFeatureValue, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified FeatureValue message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IFeatureValue

FeatureValue message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.aiplatform.v1.FeatureValue;

Creates a FeatureValue message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
FeatureValue

FeatureValue

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for FeatureValue

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this FeatureValue to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1.FeatureValue, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a FeatureValue message. Also converts values to other types if specified.

Parameters
NameDescription
message FeatureValue

FeatureValue

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a FeatureValue message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not