Class protos.google.cloud.contentwarehouse.v1.DocumentLink (0.5.1)

Represents a DocumentLink.

Package

@google-cloud/contentwarehouse

Constructors

constructor(properties?: google.cloud.contentwarehouse.v1.IDocumentLink);

Constructs a new DocumentLink.

Parameter
NameDescription
properties IDocumentLink

Properties to set

Properties

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

DocumentLink createTime.

public description: string;

DocumentLink description.

public name: string;

DocumentLink name.

public sourceDocumentReference?: (google.cloud.contentwarehouse.v1.IDocumentReference|null);

DocumentLink sourceDocumentReference.

public state: (google.cloud.contentwarehouse.v1.DocumentLink.State|keyof typeof google.cloud.contentwarehouse.v1.DocumentLink.State);

DocumentLink state.

public targetDocumentReference?: (google.cloud.contentwarehouse.v1.IDocumentReference|null);

DocumentLink targetDocumentReference.

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

DocumentLink updateTime.

Methods

public static create(properties?: google.cloud.contentwarehouse.v1.IDocumentLink): google.cloud.contentwarehouse.v1.DocumentLink;

Creates a new DocumentLink instance using the specified properties.

Parameter
NameDescription
properties IDocumentLink

Properties to set

Returns
TypeDescription
google.cloud.contentwarehouse.v1.DocumentLink

DocumentLink instance

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

Decodes a DocumentLink message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.contentwarehouse.v1.DocumentLink

DocumentLink

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.contentwarehouse.v1.DocumentLink

DocumentLink

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

Encodes the specified DocumentLink message. Does not implicitly messages.

Parameters
NameDescription
message IDocumentLink

DocumentLink message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

public static encodeDelimited(message: google.cloud.contentwarehouse.v1.IDocumentLink, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDocumentLink

DocumentLink message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

public static fromObject(object: { [k: string]: any }): google.cloud.contentwarehouse.v1.DocumentLink;

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

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

Plain object

Returns
TypeDescription
google.cloud.contentwarehouse.v1.DocumentLink

DocumentLink

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

Gets the default type url for DocumentLink

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

public toJSON(): { [k: string]: any };

Converts this DocumentLink to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

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

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

Parameters
NameDescription
message google.cloud.contentwarehouse.v1.DocumentLink

DocumentLink

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

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

Verifies a DocumentLink 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