Class protos.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSource (2.0.1)

Represents a GroundingSource.

Package

@google-cloud/discoveryengine

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.IGroundingSource);

Constructs a new GroundingSource.

Parameter
Name Description
properties IGroundingSource

Properties to set

Properties

googleSearchSource

public googleSearchSource?: (google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSource.IGoogleSearchSource|null);

GroundingSource googleSearchSource.

inlineSource

public inlineSource?: (google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSource.IInlineSource|null);

GroundingSource inlineSource.

searchSource

public searchSource?: (google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSource.ISearchSource|null);

GroundingSource searchSource.

source

public source?: ("inlineSource"|"searchSource"|"googleSearchSource");

GroundingSource source.

Methods

create(properties)

public static create(properties?: google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.IGroundingSource): google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSource;

Creates a new GroundingSource instance using the specified properties.

Parameter
Name Description
properties IGroundingSource

Properties to set
Returns
Type Description
GroundingSource

GroundingSource instance

decode(reader, length)

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

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

GroundingSource

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSource;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
GroundingSource

GroundingSource

encode(message, writer)

public static encode(message: google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.IGroundingSource, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GroundingSource message. Does not implicitly messages.

Parameters
Name Description
message IGroundingSource

GroundingSource 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.v1beta.GenerateGroundedContentRequest.IGroundingSource, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IGroundingSource

GroundingSource 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.v1beta.GenerateGroundedContentRequest.GroundingSource;

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

GroundingSource

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GroundingSource

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message GroundingSource

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