Represents a Summary.
Package
@google-cloud/discoveryengineConstructors
(constructor)(properties)
constructor(properties?: google.cloud.discoveryengine.v1.SearchResponse.ISummary);Constructs a new Summary.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISummary
Properties to set |
Properties
safetyAttributes
public safetyAttributes?: (google.cloud.discoveryengine.v1.SearchResponse.Summary.ISafetyAttributes|null);Summary safetyAttributes.
summarySkippedReasons
public summarySkippedReasons: google.cloud.discoveryengine.v1.SearchResponse.Summary.SummarySkippedReason[];Summary summarySkippedReasons.
summaryText
public summaryText: string;Summary summaryText.
summaryWithMetadata
public summaryWithMetadata?: (google.cloud.discoveryengine.v1.SearchResponse.Summary.ISummaryWithMetadata|null);Summary summaryWithMetadata.
Methods
create(properties)
public static create(properties?: google.cloud.discoveryengine.v1.SearchResponse.ISummary): google.cloud.discoveryengine.v1.SearchResponse.Summary;Creates a new Summary instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISummary
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Summary | Summary instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchResponse.Summary;Decodes a Summary 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 |
Summary | Summary |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchResponse.Summary;Decodes a Summary message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Summary | Summary |
encode(message, writer)
public static encode(message: google.cloud.discoveryengine.v1.SearchResponse.ISummary, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Summary message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISummary
Summary 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.v1.SearchResponse.ISummary, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Summary message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISummary
Summary 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.v1.SearchResponse.Summary;Creates a Summary 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 |
Summary | Summary |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Summary
| 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 Summary to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.discoveryengine.v1.SearchResponse.Summary, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Summary message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Summary
Summary |
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 Summary message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|