MetaData - Documentation

MetaData

new MetaData(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 41

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Extends

jspb.Message

Members

(static) displayName

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 50

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 100

List of repeated fields within this message type.

Methods

addExternalReferences(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.ExternalReference}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 487

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.ExternalReference	<optional>
`opt_index`	number	<optional>

Returns:

Type: proto.org.phenopackets.schema.v2.core.ExternalReference

addResources(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.Resource}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 393

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.Resource	<optional>
`opt_index`	number	<optional>

Returns:

Type: proto.org.phenopackets.schema.v2.core.Resource

addUpdates(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.Update}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 431

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.Update	<optional>
`opt_index`	number	<optional>

Returns:

Type: proto.org.phenopackets.schema.v2.core.Update

clearCreated() → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 319

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

clearExternalReferencesList() → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 496

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

clearResourcesList() → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 402

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

clearUpdatesList() → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 440

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

getCreated() → (nullable) {proto.google.protobuf.Timestamp}

Description:

optional google.protobuf.Timestamp created = 1;

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 300

Returns:

Type: proto.google.protobuf.Timestamp

getCreatedBy() → {string}

Description:

optional string created_by = 2;

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 337

Returns:

Type: string

getExternalReferencesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.ExternalReference>}

Description:

repeated ExternalReference external_references = 7;

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 467

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.ExternalReference>

getPhenopacketSchemaVersion() → {string}

Description:

optional string phenopacket_schema_version = 6;

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 449

Returns:

Type: string

getResourcesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.Resource>}

Description:

repeated Resource resources = 4;

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 373

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.Resource>

getSubmittedBy() → {string}

Description:

optional string submitted_by = 3;

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 355

Returns:

Type: string

getUpdatesList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.Update>}

Description:

repeated Update updates = 5;

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 411

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.Update>

hasCreated() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 328

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Description:

Serializes the message to binary data (in protobuf wire format).

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 224

Returns:

Type: Uint8Array

setCreated(value) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 310

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.Timestamp \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

setCreatedBy(value) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 346

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

setExternalReferencesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 477

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.ExternalReference>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

setPhenopacketSchemaVersion(value) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 458

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

setResourcesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 383

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.Resource>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

setSubmittedBy(value) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 364

Parameters:

Name	Type	Description
`value`	string

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

setUpdatesList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 421

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.Update>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.MetaData

toObject(opt_includeInstanceopt) → (non-null) {Object}

Description:

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 117

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 158

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Returns:

Type: proto.org.phenopackets.schema.v2.core.MetaData

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.MetaData}

Description:

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 172

Parameters:

Name	Type	Description
`msg`	proto.org.phenopackets.schema.v2.core.MetaData	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Returns:

Type: proto.org.phenopackets.schema.v2.core.MetaData

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Description:

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 238

Parameters:

Name	Type	Description
`message`	proto.org.phenopackets.schema.v2.core.MetaData
`writer`	jspb.BinaryWriter

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v2/core/meta_data_pb.js, line 131

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.org.phenopackets.schema.v2.core.MetaData	The msg instance to transform.

Returns:

Type: Object