Class protos.google.cloud.aiplatform.v1.MetadataSchema (3.7.0)

Represents a MetadataSchema.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

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

Constructs a new MetadataSchema.

Parameter
NameDescription
properties IMetadataSchema

Properties to set

Properties

createTime

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

MetadataSchema createTime.

description

public description: string;

MetadataSchema description.

name

public name: string;

MetadataSchema name.

schema

public schema: string;

MetadataSchema schema.

schemaType

public schemaType: (google.cloud.aiplatform.v1.MetadataSchema.MetadataSchemaType|keyof typeof google.cloud.aiplatform.v1.MetadataSchema.MetadataSchemaType);

MetadataSchema schemaType.

schemaVersion

public schemaVersion: string;

MetadataSchema schemaVersion.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IMetadataSchema): google.cloud.aiplatform.v1.MetadataSchema;

Creates a new MetadataSchema instance using the specified properties.

Parameter
NameDescription
properties IMetadataSchema

Properties to set

Returns
TypeDescription
MetadataSchema

MetadataSchema instance

decode(reader, length)

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

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

MetadataSchema

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
MetadataSchema

MetadataSchema

encode(message, writer)

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

Encodes the specified MetadataSchema message. Does not implicitly messages.

Parameters
NameDescription
message IMetadataSchema

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

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

Parameters
NameDescription
message IMetadataSchema

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

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

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

Plain object

Returns
TypeDescription
MetadataSchema

MetadataSchema

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for MetadataSchema

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message MetadataSchema

MetadataSchema

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