Class protos.google.cloud.translation.v3beta1.DocumentInputConfig

Represents a DocumentInputConfig.

Package

@google-cloud/translate

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.translation.v3beta1.IDocumentInputConfig);

Constructs a new DocumentInputConfig.

Parameter
NameDescription
properties IDocumentInputConfig

Properties to set

Properties

content

public content?: (Uint8Array|string|null);

DocumentInputConfig content.

gcsSource

public gcsSource?: (google.cloud.translation.v3beta1.IGcsSource|null);

DocumentInputConfig gcsSource.

mimeType

public mimeType: string;

DocumentInputConfig mimeType.

source

public source?: ("content"|"gcsSource");

DocumentInputConfig source.

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3beta1.IDocumentInputConfig): google.cloud.translation.v3beta1.DocumentInputConfig;

Creates a new DocumentInputConfig instance using the specified properties.

Parameter
NameDescription
properties IDocumentInputConfig

Properties to set

Returns
TypeDescription
google.cloud.translation.v3beta1.DocumentInputConfig

DocumentInputConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.translation.v3beta1.DocumentInputConfig;

Decodes a DocumentInputConfig message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.translation.v3beta1.DocumentInputConfig

DocumentInputConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.translation.v3beta1.DocumentInputConfig;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.translation.v3beta1.DocumentInputConfig

DocumentInputConfig

encode(message, writer)

public static encode(message: google.cloud.translation.v3beta1.IDocumentInputConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DocumentInputConfig message. Does not implicitly messages.

Parameters
NameDescription
message IDocumentInputConfig

DocumentInputConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.translation.v3beta1.IDocumentInputConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDocumentInputConfig

DocumentInputConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.translation.v3beta1.DocumentInputConfig;

Creates a DocumentInputConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.translation.v3beta1.DocumentInputConfig

DocumentInputConfig

toJSON()

public toJSON(): { [k: string]: any };

Converts this DocumentInputConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.translation.v3beta1.DocumentInputConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.cloud.translation.v3beta1.DocumentInputConfig

DocumentInputConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a DocumentInputConfig message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not