Class protos.google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata (3.3.0)

Represents an InputMetadata.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1beta1.ExplanationMetadata.IInputMetadata);

Constructs a new InputMetadata.

Parameter
NameDescription
properties IInputMetadata

Properties to set

Properties

denseShapeTensorName

public denseShapeTensorName: string;

InputMetadata denseShapeTensorName.

encodedBaselines

public encodedBaselines: google.protobuf.IValue[];

InputMetadata encodedBaselines.

encodedTensorName

public encodedTensorName: string;

InputMetadata encodedTensorName.

encoding

public encoding: (google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Encoding|keyof typeof google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.Encoding);

InputMetadata encoding.

featureValueDomain

public featureValueDomain?: (google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.IFeatureValueDomain|null);

InputMetadata featureValueDomain.

groupName

public groupName: string;

InputMetadata groupName.

indexFeatureMapping

public indexFeatureMapping: string[];

InputMetadata indexFeatureMapping.

indicesTensorName

public indicesTensorName: string;

InputMetadata indicesTensorName.

inputBaselines

public inputBaselines: google.protobuf.IValue[];

InputMetadata inputBaselines.

inputTensorName

public inputTensorName: string;

InputMetadata inputTensorName.

modality

public modality: string;

InputMetadata modality.

visualization

public visualization?: (google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata.IVisualization|null);

InputMetadata visualization.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1beta1.ExplanationMetadata.IInputMetadata): google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata;

Creates a new InputMetadata instance using the specified properties.

Parameter
NameDescription
properties IInputMetadata

Properties to set

Returns
TypeDescription
InputMetadata

InputMetadata instance

decode(reader, length)

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

Decodes an InputMetadata 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
InputMetadata

InputMetadata

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1beta1.ExplanationMetadata.InputMetadata;

Decodes an InputMetadata message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
InputMetadata

InputMetadata

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1beta1.ExplanationMetadata.IInputMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified InputMetadata message. Does not implicitly messages.

Parameters
NameDescription
message IInputMetadata

InputMetadata 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.v1beta1.ExplanationMetadata.IInputMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IInputMetadata

InputMetadata 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.v1beta1.ExplanationMetadata.InputMetadata;

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

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

Plain object

Returns
TypeDescription
InputMetadata

InputMetadata

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for InputMetadata

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message InputMetadata

InputMetadata

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an InputMetadata 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