Class protos.google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig (6.1.0)

Version latest

• 8.5.0 (latest)
• 8.4.0
• 8.2.0
• 8.1.2
• 8.0.0
• 7.3.1
• 7.1.0
• 7.0.1
• 6.3.0
• 6.1.0
• 6.0.0
• 3.3.0
• 3.2.1
• 3.1.0
• 3.0.2
• 2.10.0

Represents a GcsOutputConfig.

Package

@google-cloud/documentai

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.documentai.v1beta3.DocumentOutputConfig.IGcsOutputConfig);

Constructs a new GcsOutputConfig.

Parameter

Name	Description
properties	IGcsOutputConfig Properties to set

Properties

gcsUri

public gcsUri: string;

GcsOutputConfig gcsUri.

Methods

create(properties)

public static create(properties?: google.cloud.documentai.v1beta3.DocumentOutputConfig.IGcsOutputConfig): google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig;

Creates a new GcsOutputConfig instance using the specified properties.

Parameter

Name	Description
properties	IGcsOutputConfig Properties to set

Returns

Type	Description
google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig	GcsOutputConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig;

Decodes a GcsOutputConfig message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig	GcsOutputConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig;

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

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig	GcsOutputConfig

encode(message, writer)

public static encode(message: google.cloud.documentai.v1beta3.DocumentOutputConfig.IGcsOutputConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GcsOutputConfig message. Does not implicitly messages.

Parameters

Name	Description
message	IGcsOutputConfig GcsOutputConfig 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.DocumentOutputConfig.IGcsOutputConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IGcsOutputConfig GcsOutputConfig 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.DocumentOutputConfig.GcsOutputConfig;

Creates a GcsOutputConfig 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
google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig	GcsOutputConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GcsOutputConfig

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	google.cloud.documentai.v1beta3.DocumentOutputConfig.GcsOutputConfig GcsOutputConfig
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 GcsOutputConfig 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