Class protos.google.ai.generativelanguage.v1beta.CitationSource (2.6.0)

Represents a CitationSource.

Package

@google-ai/generativelanguage

Constructors

(constructor)(properties)

constructor(properties?: google.ai.generativelanguage.v1beta.ICitationSource);

Constructs a new CitationSource.

Parameter
Name Description
properties ICitationSource

Properties to set

Properties

_endIndex

public _endIndex?: "endIndex";

CitationSource _endIndex.

_license

public _license?: "license";

CitationSource _license.

_startIndex

public _startIndex?: "startIndex";

CitationSource _startIndex.

_uri

public _uri?: "uri";

CitationSource _uri.

endIndex

public endIndex?: (number|null);

CitationSource endIndex.

license

public license?: (string|null);

CitationSource license.

startIndex

public startIndex?: (number|null);

CitationSource startIndex.

uri

public uri?: (string|null);

CitationSource uri.

Methods

create(properties)

public static create(properties?: google.ai.generativelanguage.v1beta.ICitationSource): google.ai.generativelanguage.v1beta.CitationSource;

Creates a new CitationSource instance using the specified properties.

Parameter
Name Description
properties ICitationSource

Properties to set

Returns
Type Description
CitationSource

CitationSource instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ai.generativelanguage.v1beta.CitationSource;

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

CitationSource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ai.generativelanguage.v1beta.CitationSource;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
CitationSource

CitationSource

encode(message, writer)

public static encode(message: google.ai.generativelanguage.v1beta.ICitationSource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CitationSource message. Does not implicitly messages.

Parameters
Name Description
message ICitationSource

CitationSource 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.ai.generativelanguage.v1beta.ICitationSource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ICitationSource

CitationSource 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.ai.generativelanguage.v1beta.CitationSource;

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

CitationSource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CitationSource

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

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

JSON object

toObject(message, options)

public static toObject(message: google.ai.generativelanguage.v1beta.CitationSource, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message CitationSource

CitationSource

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