Class protos.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest (3.13.0)

Represents a BatchReadFeatureValuesRequest.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new BatchReadFeatureValuesRequest.

Parameter
NameDescription
properties IBatchReadFeatureValuesRequest

Properties to set

Properties

bigqueryReadInstances

public bigqueryReadInstances?: (google.cloud.aiplatform.v1.IBigQuerySource|null);

BatchReadFeatureValuesRequest bigqueryReadInstances.

csvReadInstances

public csvReadInstances?: (google.cloud.aiplatform.v1.ICsvSource|null);

BatchReadFeatureValuesRequest csvReadInstances.

destination

public destination?: (google.cloud.aiplatform.v1.IFeatureValueDestination|null);

BatchReadFeatureValuesRequest destination.

entityTypeSpecs

public entityTypeSpecs: google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.IEntityTypeSpec[];

BatchReadFeatureValuesRequest entityTypeSpecs.

featurestore

public featurestore: string;

BatchReadFeatureValuesRequest featurestore.

passThroughFields

public passThroughFields: google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.IPassThroughField[];

BatchReadFeatureValuesRequest passThroughFields.

readOption

public readOption?: ("csvReadInstances"|"bigqueryReadInstances");

BatchReadFeatureValuesRequest readOption.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

BatchReadFeatureValuesRequest startTime.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IBatchReadFeatureValuesRequest): google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest;

Creates a new BatchReadFeatureValuesRequest instance using the specified properties.

Parameter
NameDescription
properties IBatchReadFeatureValuesRequest

Properties to set

Returns
TypeDescription
BatchReadFeatureValuesRequest

BatchReadFeatureValuesRequest instance

decode(reader, length)

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

Decodes a BatchReadFeatureValuesRequest 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
BatchReadFeatureValuesRequest

BatchReadFeatureValuesRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BatchReadFeatureValuesRequest

BatchReadFeatureValuesRequest

encode(message, writer)

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

Encodes the specified BatchReadFeatureValuesRequest message. Does not implicitly messages.

Parameters
NameDescription
message IBatchReadFeatureValuesRequest

BatchReadFeatureValuesRequest 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.IBatchReadFeatureValuesRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBatchReadFeatureValuesRequest

BatchReadFeatureValuesRequest 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.BatchReadFeatureValuesRequest;

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

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

Plain object

Returns
TypeDescription
BatchReadFeatureValuesRequest

BatchReadFeatureValuesRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BatchReadFeatureValuesRequest

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 BatchReadFeatureValuesRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message BatchReadFeatureValuesRequest

BatchReadFeatureValuesRequest

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 BatchReadFeatureValuesRequest 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