Class protos.google.cloud.discoveryengine.v1alpha.Schema (1.9.0)

Represents a Schema.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1alpha.ISchema);

Constructs a new Schema.

Parameter
Name Description
properties ISchema

Properties to set

Properties

fieldConfigs

public fieldConfigs: google.cloud.discoveryengine.v1alpha.IFieldConfig[];

Schema fieldConfigs.

jsonSchema

public jsonSchema?: (string|null);

Schema jsonSchema.

name

public name: string;

Schema name.

schema

public schema?: ("structSchema"|"jsonSchema");

Schema schema.

structSchema

public structSchema?: (google.protobuf.IStruct|null);

Schema structSchema.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1alpha.ISchema): google.cloud.discoveryengine.v1alpha.Schema;

Creates a new Schema instance using the specified properties.

Parameter
Name Description
properties ISchema

Properties to set

Returns
Type Description
Schema

Schema instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.Schema;

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

Schema

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.Schema;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Schema

Schema

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1alpha.ISchema, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Schema message. Does not implicitly messages.

Parameters
Name Description
message ISchema

Schema 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.discoveryengine.v1alpha.ISchema, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISchema

Schema 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.discoveryengine.v1alpha.Schema;

Creates a Schema 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
Schema

Schema

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Schema

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Schema

Schema

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 Schema message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not