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