@google-cloud/translate

@google-cloud/translate

Version 6.3.1
Published 5 months ago
3.49 MB
7 dependencies
Apache-2.0 license

Install

npm i @google-cloud/translate

yarn add @google-cloud/translate

pnpm add @google-cloud/translate

Overview

Cloud Translation API Client Library for Node.js

Index

Variables

variable _default

const _default: {
    v2: typeof v2;
    v3beta1: typeof v3beta1;
    v3: typeof v3;
    TranslationServiceClient: typeof v3.TranslationServiceClient;
};

variable TranslationServiceClient

const TranslationServiceClient: typeof v3.TranslationServiceClient;

Type Aliases

type TranslationServiceClient

type TranslationServiceClient = v3.TranslationServiceClient;

Namespaces

namespace protos

module 'build/protos/protos.d.ts' {}

Namespace google.

namespace protos.google

namespace protos.google {}

Namespace google.

namespace protos.google.api

namespace protos.google.api {}

Namespace api.

class CustomHttpPattern

class CustomHttpPattern implements ICustomHttpPattern {}

Represents a CustomHttpPattern.

constructor

constructor(properties?: ICustomHttpPattern);

Constructs a new CustomHttpPattern.
Parameter properties
Properties to set

property kind

kind: string;

CustomHttpPattern kind.

property path

path: string;

CustomHttpPattern path.

method create

static create: (
    properties?: google.api.ICustomHttpPattern
) => google.api.CustomHttpPattern;

Creates a new CustomHttpPattern instance using the specified properties.
Parameter properties
Properties to set
Returns
CustomHttpPattern instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.api.CustomHttpPattern;

Decodes a CustomHttpPattern message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
CustomHttpPattern
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.api.CustomHttpPattern;

Decodes a CustomHttpPattern message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
CustomHttpPattern
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.api.ICustomHttpPattern,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified CustomHttpPattern message. Does not implicitly verify messages.
Parameter message
CustomHttpPattern message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.api.ICustomHttpPattern,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified CustomHttpPattern message, length delimited. Does not implicitly verify messages.
Parameter message
CustomHttpPattern message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.api.CustomHttpPattern;

Creates a CustomHttpPattern message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
CustomHttpPattern

method toJSON

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

Converts this CustomHttpPattern to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.api.CustomHttpPattern,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a CustomHttpPattern message. Also converts values to other types if specified.
Parameter message
CustomHttpPattern
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a CustomHttpPattern message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class Http

class Http implements IHttp {}

Represents a Http.

constructor

constructor(properties?: IHttp);

Constructs a new Http.
Parameter properties
Properties to set

property fullyDecodeReservedExpansion

fullyDecodeReservedExpansion: boolean;

Http fullyDecodeReservedExpansion.

property rules

rules: IHttpRule[];

Http rules.

method create

static create: (properties?: google.api.IHttp) => google.api.Http;

Creates a new Http instance using the specified properties.
Parameter properties
Properties to set
Returns
Http instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.api.Http;

Decodes a Http message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
Http
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.api.Http;

Decodes a Http message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
Http
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.api.IHttp,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified Http message. Does not implicitly verify messages.
Parameter message
Http message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.api.IHttp,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified Http message, length delimited. Does not implicitly verify messages.
Parameter message
Http message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => google.api.Http;

Creates a Http message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
Http

method toJSON

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

Converts this Http to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.api.Http,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a Http message. Also converts values to other types if specified.
Parameter message
Http
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a Http message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class HttpRule

class HttpRule implements IHttpRule {}

Represents a HttpRule.

constructor

constructor(properties?: IHttpRule);

Constructs a new HttpRule.
Parameter properties
Properties to set

property additionalBindings

additionalBindings: IHttpRule[];

HttpRule additionalBindings.

property body

body: string;

HttpRule body.

property custom

custom?: ICustomHttpPattern;

HttpRule custom.

property delete

delete?: string;

HttpRule delete.

property get

get?: string;

HttpRule get.

property patch

patch?: string;

HttpRule patch.

property pattern

pattern?: 'get' | 'put' | 'post' | 'delete' | 'patch' | 'custom';

HttpRule pattern.

property post

post?: string;

HttpRule post.

property put

put?: string;

HttpRule put.

property responseBody

responseBody: string;

HttpRule responseBody.

property selector

selector: string;

HttpRule selector.

method create

static create: (properties?: google.api.IHttpRule) => google.api.HttpRule;

Creates a new HttpRule instance using the specified properties.
Parameter properties
Properties to set
Returns
HttpRule instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.api.HttpRule;

Decodes a HttpRule message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
HttpRule
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.api.HttpRule;

Decodes a HttpRule message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
HttpRule
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.api.IHttpRule,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified HttpRule message. Does not implicitly verify messages.
Parameter message
HttpRule message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.api.IHttpRule,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified HttpRule message, length delimited. Does not implicitly verify messages.
Parameter message
HttpRule message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: { [k: string]: any }) => google.api.HttpRule;

Creates a HttpRule message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
HttpRule

method toJSON

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

Converts this HttpRule to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.api.HttpRule,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a HttpRule message. Also converts values to other types if specified.
Parameter message
HttpRule
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a HttpRule message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class ResourceDescriptor

class ResourceDescriptor implements IResourceDescriptor {}

Represents a ResourceDescriptor.

constructor

constructor(properties?: IResourceDescriptor);

Constructs a new ResourceDescriptor.
Parameter properties
Properties to set

property history

history:
    | ResourceDescriptor.History
    | 'HISTORY_UNSPECIFIED'
    | 'ORIGINALLY_SINGLE_PATTERN'
    | 'FUTURE_MULTI_PATTERN';

ResourceDescriptor history.

property nameField

nameField: string;

ResourceDescriptor nameField.

property pattern

pattern: string[];

ResourceDescriptor pattern.

property plural

plural: string;

ResourceDescriptor plural.

property singular

singular: string;

ResourceDescriptor singular.

property style

style: ResourceDescriptor.Style[];

ResourceDescriptor style.

property type

type: string;

ResourceDescriptor type.

method create

static create: (
    properties?: google.api.IResourceDescriptor
) => google.api.ResourceDescriptor;

Creates a new ResourceDescriptor instance using the specified properties.
Parameter properties
Properties to set
Returns
ResourceDescriptor instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.api.ResourceDescriptor;

Decodes a ResourceDescriptor message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
ResourceDescriptor
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.api.ResourceDescriptor;

Decodes a ResourceDescriptor message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
ResourceDescriptor
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.api.IResourceDescriptor,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified ResourceDescriptor message. Does not implicitly verify messages.
Parameter message
ResourceDescriptor message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.api.IResourceDescriptor,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified ResourceDescriptor message, length delimited. Does not implicitly verify messages.
Parameter message
ResourceDescriptor message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.api.ResourceDescriptor;

Creates a ResourceDescriptor message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
ResourceDescriptor

method toJSON

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

Converts this ResourceDescriptor to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.api.ResourceDescriptor,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a ResourceDescriptor message. Also converts values to other types if specified.
Parameter message
ResourceDescriptor
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a ResourceDescriptor message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class ResourceReference

class ResourceReference implements IResourceReference {}

Represents a ResourceReference.

constructor

constructor(properties?: IResourceReference);

Constructs a new ResourceReference.
Parameter properties
Properties to set

property childType

childType: string;

ResourceReference childType.

property type

type: string;

ResourceReference type.

method create

static create: (
    properties?: google.api.IResourceReference
) => google.api.ResourceReference;

Creates a new ResourceReference instance using the specified properties.
Parameter properties
Properties to set
Returns
ResourceReference instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.api.ResourceReference;

Decodes a ResourceReference message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
ResourceReference
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.api.ResourceReference;

Decodes a ResourceReference message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
ResourceReference
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.api.IResourceReference,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified ResourceReference message. Does not implicitly verify messages.
Parameter message
ResourceReference message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.api.IResourceReference,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified ResourceReference message, length delimited. Does not implicitly verify messages.
Parameter message
ResourceReference message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.api.ResourceReference;

Creates a ResourceReference message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
ResourceReference

method toJSON

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

Converts this ResourceReference to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.api.ResourceReference,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a ResourceReference message. Also converts values to other types if specified.
Parameter message
ResourceReference
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a ResourceReference message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

interface ICustomHttpPattern

interface ICustomHttpPattern {}

Properties of a CustomHttpPattern.

property kind

kind?: string | null;

CustomHttpPattern kind

property path

path?: string | null;

CustomHttpPattern path

interface IHttp

interface IHttp {}

Properties of a Http.

property fullyDecodeReservedExpansion

fullyDecodeReservedExpansion?: boolean | null;

Http fullyDecodeReservedExpansion

property rules

rules?: google.api.IHttpRule[] | null;

Http rules

interface IHttpRule

interface IHttpRule {}

Properties of a HttpRule.

property "delete"

delete?: string | null;

HttpRule delete

property additionalBindings

additionalBindings?: google.api.IHttpRule[] | null;

HttpRule additionalBindings

property body

body?: string | null;

HttpRule body

property custom

custom?: google.api.ICustomHttpPattern | null;

HttpRule custom

property get

get?: string | null;

HttpRule get

property patch

patch?: string | null;

HttpRule patch

property post

post?: string | null;

HttpRule post

property put

put?: string | null;

HttpRule put

property responseBody

responseBody?: string | null;

HttpRule responseBody

property selector

selector?: string | null;

HttpRule selector

interface IResourceDescriptor

interface IResourceDescriptor {}

Properties of a ResourceDescriptor.

property history

history?:
    | google.api.ResourceDescriptor.History
    | keyof typeof google.api.ResourceDescriptor.History
    | null;

ResourceDescriptor history

property nameField

nameField?: string | null;

ResourceDescriptor nameField

property pattern

pattern?: string[] | null;

ResourceDescriptor pattern

property plural

plural?: string | null;

ResourceDescriptor plural

property singular

singular?: string | null;

ResourceDescriptor singular

property style

style?: google.api.ResourceDescriptor.Style[] | null;

ResourceDescriptor style

property type

type?: string | null;

ResourceDescriptor type

interface IResourceReference

interface IResourceReference {}

Properties of a ResourceReference.

property childType

childType?: string | null;

ResourceReference childType

property type

type?: string | null;

ResourceReference type

enum FieldBehavior

enum FieldBehavior {
    FIELD_BEHAVIOR_UNSPECIFIED = 0,
    OPTIONAL = 1,
    REQUIRED = 2,
    OUTPUT_ONLY = 3,
    INPUT_ONLY = 4,
    IMMUTABLE = 5,
    UNORDERED_LIST = 6,
    NON_EMPTY_DEFAULT = 7,
}

FieldBehavior enum.

member FIELD_BEHAVIOR_UNSPECIFIED

FIELD_BEHAVIOR_UNSPECIFIED = 0

member IMMUTABLE

IMMUTABLE = 5

member INPUT_ONLY

INPUT_ONLY = 4

member NON_EMPTY_DEFAULT

NON_EMPTY_DEFAULT = 7

member OPTIONAL

OPTIONAL = 1

member OUTPUT_ONLY

OUTPUT_ONLY = 3

member REQUIRED

REQUIRED = 2

member UNORDERED_LIST

UNORDERED_LIST = 6

namespace protos.google.api.ResourceDescriptor

namespace protos.google.api.ResourceDescriptor {}

enum History

enum History {
    HISTORY_UNSPECIFIED = 0,
    ORIGINALLY_SINGLE_PATTERN = 1,
    FUTURE_MULTI_PATTERN = 2,
}

History enum.

member FUTURE_MULTI_PATTERN

FUTURE_MULTI_PATTERN = 2

member HISTORY_UNSPECIFIED

HISTORY_UNSPECIFIED = 0

member ORIGINALLY_SINGLE_PATTERN

ORIGINALLY_SINGLE_PATTERN = 1

enum Style

enum Style {
    STYLE_UNSPECIFIED = 0,
    DECLARATIVE_FRIENDLY = 1,
}

Style enum.

member DECLARATIVE_FRIENDLY

DECLARATIVE_FRIENDLY = 1

member STYLE_UNSPECIFIED

STYLE_UNSPECIFIED = 0

namespace protos.google.cloud

namespace protos.google.cloud {}

Namespace cloud.

namespace protos.google.cloud.translation

namespace protos.google.cloud.translation {}

Namespace translation.

namespace protos.google.cloud.translation.v3

namespace protos.google.cloud.translation.v3 {}

Namespace v3.

class BatchDocumentInputConfig

class BatchDocumentInputConfig implements IBatchDocumentInputConfig {}

Represents a BatchDocumentInputConfig.

constructor

constructor(properties?: IBatchDocumentInputConfig);

Constructs a new BatchDocumentInputConfig.
Parameter properties
Properties to set

property gcsSource

gcsSource?: IGcsSource;

BatchDocumentInputConfig gcsSource.

property source

source?: string;

BatchDocumentInputConfig source.

method create

static create: (
    properties?: google.cloud.translation.v3.IBatchDocumentInputConfig
) => google.cloud.translation.v3.BatchDocumentInputConfig;

Creates a new BatchDocumentInputConfig instance using the specified properties.
Parameter properties
Properties to set
Returns
BatchDocumentInputConfig instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.BatchDocumentInputConfig;

Decodes a BatchDocumentInputConfig message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
BatchDocumentInputConfig
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.BatchDocumentInputConfig;

Decodes a BatchDocumentInputConfig message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
BatchDocumentInputConfig
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IBatchDocumentInputConfig,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchDocumentInputConfig message. Does not implicitly verify messages.
Parameter message
BatchDocumentInputConfig message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IBatchDocumentInputConfig,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchDocumentInputConfig message, length delimited. Does not implicitly verify messages.
Parameter message
BatchDocumentInputConfig message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.BatchDocumentInputConfig;

Creates a BatchDocumentInputConfig message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
BatchDocumentInputConfig

method toJSON

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

Converts this BatchDocumentInputConfig to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.BatchDocumentInputConfig,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a BatchDocumentInputConfig message. Also converts values to other types if specified.
Parameter message
BatchDocumentInputConfig
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a BatchDocumentInputConfig message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class BatchDocumentOutputConfig

class BatchDocumentOutputConfig implements IBatchDocumentOutputConfig {}

Represents a BatchDocumentOutputConfig.

constructor

constructor(properties?: IBatchDocumentOutputConfig);

Constructs a new BatchDocumentOutputConfig.
Parameter properties
Properties to set

property destination

destination?: string;

BatchDocumentOutputConfig destination.

property gcsDestination

gcsDestination?: IGcsDestination;

BatchDocumentOutputConfig gcsDestination.

method create

static create: (
    properties?: google.cloud.translation.v3.IBatchDocumentOutputConfig
) => google.cloud.translation.v3.BatchDocumentOutputConfig;

Creates a new BatchDocumentOutputConfig instance using the specified properties.
Parameter properties
Properties to set
Returns
BatchDocumentOutputConfig instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.BatchDocumentOutputConfig;

Decodes a BatchDocumentOutputConfig message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
BatchDocumentOutputConfig
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.BatchDocumentOutputConfig;

Decodes a BatchDocumentOutputConfig message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
BatchDocumentOutputConfig
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IBatchDocumentOutputConfig,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchDocumentOutputConfig message. Does not implicitly verify messages.
Parameter message
BatchDocumentOutputConfig message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IBatchDocumentOutputConfig,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchDocumentOutputConfig message, length delimited. Does not implicitly verify messages.
Parameter message
BatchDocumentOutputConfig message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.BatchDocumentOutputConfig;

Creates a BatchDocumentOutputConfig message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
BatchDocumentOutputConfig

method toJSON

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

Converts this BatchDocumentOutputConfig to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.BatchDocumentOutputConfig,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a BatchDocumentOutputConfig message. Also converts values to other types if specified.
Parameter message
BatchDocumentOutputConfig
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a BatchDocumentOutputConfig message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class BatchTranslateDocumentMetadata

class BatchTranslateDocumentMetadata implements IBatchTranslateDocumentMetadata {}

Represents a BatchTranslateDocumentMetadata.

constructor

constructor(properties?: IBatchTranslateDocumentMetadata);

Constructs a new BatchTranslateDocumentMetadata.
Parameter properties
Properties to set

property failedCharacters

failedCharacters: any;

BatchTranslateDocumentMetadata failedCharacters.

property failedPages

failedPages: any;

BatchTranslateDocumentMetadata failedPages.

property state

state:
    | 'STATE_UNSPECIFIED'
    | 'RUNNING'
    | 'SUCCEEDED'
    | 'FAILED'
    | 'CANCELLING'
    | 'CANCELLED'
    | BatchTranslateDocumentMetadata.State;

BatchTranslateDocumentMetadata state.

property submitTime

submitTime?: protobuf.ITimestamp;

BatchTranslateDocumentMetadata submitTime.

property totalBillableCharacters

totalBillableCharacters: any;

BatchTranslateDocumentMetadata totalBillableCharacters.

property totalBillablePages

totalBillablePages: any;

BatchTranslateDocumentMetadata totalBillablePages.

property totalCharacters

totalCharacters: any;

BatchTranslateDocumentMetadata totalCharacters.

property totalPages

totalPages: any;

BatchTranslateDocumentMetadata totalPages.

property translatedCharacters

translatedCharacters: any;

BatchTranslateDocumentMetadata translatedCharacters.

property translatedPages

translatedPages: any;

BatchTranslateDocumentMetadata translatedPages.

method create

static create: (
    properties?: google.cloud.translation.v3.IBatchTranslateDocumentMetadata
) => google.cloud.translation.v3.BatchTranslateDocumentMetadata;

Creates a new BatchTranslateDocumentMetadata instance using the specified properties.
Parameter properties
Properties to set
Returns
BatchTranslateDocumentMetadata instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.BatchTranslateDocumentMetadata;

Decodes a BatchTranslateDocumentMetadata message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
BatchTranslateDocumentMetadata
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.BatchTranslateDocumentMetadata;

Decodes a BatchTranslateDocumentMetadata message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
BatchTranslateDocumentMetadata
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IBatchTranslateDocumentMetadata,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateDocumentMetadata message. Does not implicitly verify messages.
Parameter message
BatchTranslateDocumentMetadata message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IBatchTranslateDocumentMetadata,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateDocumentMetadata message, length delimited. Does not implicitly verify messages.
Parameter message
BatchTranslateDocumentMetadata message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.BatchTranslateDocumentMetadata;

Creates a BatchTranslateDocumentMetadata message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
BatchTranslateDocumentMetadata

method toJSON

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

Converts this BatchTranslateDocumentMetadata to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.BatchTranslateDocumentMetadata,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a BatchTranslateDocumentMetadata message. Also converts values to other types if specified.
Parameter message
BatchTranslateDocumentMetadata
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a BatchTranslateDocumentMetadata message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class BatchTranslateDocumentRequest

class BatchTranslateDocumentRequest implements IBatchTranslateDocumentRequest {}

Represents a BatchTranslateDocumentRequest.

constructor

constructor(properties?: IBatchTranslateDocumentRequest);

Constructs a new BatchTranslateDocumentRequest.
Parameter properties
Properties to set

property formatConversions

formatConversions: { [k: string]: string };

BatchTranslateDocumentRequest formatConversions.

property glossaries

glossaries: { [k: string]: ITranslateTextGlossaryConfig };

BatchTranslateDocumentRequest glossaries.

property inputConfigs

inputConfigs: IBatchDocumentInputConfig[];

BatchTranslateDocumentRequest inputConfigs.

property models

models: { [k: string]: string };

BatchTranslateDocumentRequest models.

property outputConfig

outputConfig?: IBatchDocumentOutputConfig;

BatchTranslateDocumentRequest outputConfig.

property parent

parent: string;

BatchTranslateDocumentRequest parent.

property sourceLanguageCode

sourceLanguageCode: string;

BatchTranslateDocumentRequest sourceLanguageCode.

property targetLanguageCodes

targetLanguageCodes: string[];

BatchTranslateDocumentRequest targetLanguageCodes.

method create

static create: (
    properties?: google.cloud.translation.v3.IBatchTranslateDocumentRequest
) => google.cloud.translation.v3.BatchTranslateDocumentRequest;

Creates a new BatchTranslateDocumentRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
BatchTranslateDocumentRequest instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.BatchTranslateDocumentRequest;

Decodes a BatchTranslateDocumentRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
BatchTranslateDocumentRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.BatchTranslateDocumentRequest;

Decodes a BatchTranslateDocumentRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
BatchTranslateDocumentRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IBatchTranslateDocumentRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateDocumentRequest message. Does not implicitly verify messages.
Parameter message
BatchTranslateDocumentRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IBatchTranslateDocumentRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateDocumentRequest message, length delimited. Does not implicitly verify messages.
Parameter message
BatchTranslateDocumentRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.BatchTranslateDocumentRequest;

Creates a BatchTranslateDocumentRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
BatchTranslateDocumentRequest

method toJSON

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

Converts this BatchTranslateDocumentRequest to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.BatchTranslateDocumentRequest,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a BatchTranslateDocumentRequest message. Also converts values to other types if specified.
Parameter message
BatchTranslateDocumentRequest
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a BatchTranslateDocumentRequest message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class BatchTranslateDocumentResponse

class BatchTranslateDocumentResponse implements IBatchTranslateDocumentResponse {}

Represents a BatchTranslateDocumentResponse.

constructor

constructor(properties?: IBatchTranslateDocumentResponse);

Constructs a new BatchTranslateDocumentResponse.
Parameter properties
Properties to set

property endTime

endTime?: protobuf.ITimestamp;

BatchTranslateDocumentResponse endTime.

property failedCharacters

failedCharacters: any;

BatchTranslateDocumentResponse failedCharacters.

property failedPages

failedPages: any;

BatchTranslateDocumentResponse failedPages.

property submitTime

submitTime?: protobuf.ITimestamp;

BatchTranslateDocumentResponse submitTime.

property totalBillableCharacters

totalBillableCharacters: any;

BatchTranslateDocumentResponse totalBillableCharacters.

property totalBillablePages

totalBillablePages: any;

BatchTranslateDocumentResponse totalBillablePages.

property totalCharacters

totalCharacters: any;

BatchTranslateDocumentResponse totalCharacters.

property totalPages

totalPages: any;

BatchTranslateDocumentResponse totalPages.

property translatedCharacters

translatedCharacters: any;

BatchTranslateDocumentResponse translatedCharacters.

property translatedPages

translatedPages: any;

BatchTranslateDocumentResponse translatedPages.

method create

static create: (
    properties?: google.cloud.translation.v3.IBatchTranslateDocumentResponse
) => google.cloud.translation.v3.BatchTranslateDocumentResponse;

Creates a new BatchTranslateDocumentResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
BatchTranslateDocumentResponse instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.BatchTranslateDocumentResponse;

Decodes a BatchTranslateDocumentResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
BatchTranslateDocumentResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.BatchTranslateDocumentResponse;

Decodes a BatchTranslateDocumentResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
BatchTranslateDocumentResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IBatchTranslateDocumentResponse,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateDocumentResponse message. Does not implicitly verify messages.
Parameter message
BatchTranslateDocumentResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IBatchTranslateDocumentResponse,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateDocumentResponse message, length delimited. Does not implicitly verify messages.
Parameter message
BatchTranslateDocumentResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.BatchTranslateDocumentResponse;

Creates a BatchTranslateDocumentResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
BatchTranslateDocumentResponse

method toJSON

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

Converts this BatchTranslateDocumentResponse to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.BatchTranslateDocumentResponse,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a BatchTranslateDocumentResponse message. Also converts values to other types if specified.
Parameter message
BatchTranslateDocumentResponse
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a BatchTranslateDocumentResponse message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class BatchTranslateMetadata

class BatchTranslateMetadata implements IBatchTranslateMetadata {}

Represents a BatchTranslateMetadata.

constructor

constructor(properties?: IBatchTranslateMetadata);

Constructs a new BatchTranslateMetadata.
Parameter properties
Properties to set

property failedCharacters

failedCharacters: any;

BatchTranslateMetadata failedCharacters.

property state

state:
    | BatchTranslateMetadata.State
    | 'STATE_UNSPECIFIED'
    | 'RUNNING'
    | 'SUCCEEDED'
    | 'FAILED'
    | 'CANCELLING'
    | 'CANCELLED';

BatchTranslateMetadata state.

property submitTime

submitTime?: protobuf.ITimestamp;

BatchTranslateMetadata submitTime.

property totalCharacters

totalCharacters: any;

BatchTranslateMetadata totalCharacters.

property translatedCharacters

translatedCharacters: any;

BatchTranslateMetadata translatedCharacters.

method create

static create: (
    properties?: google.cloud.translation.v3.IBatchTranslateMetadata
) => google.cloud.translation.v3.BatchTranslateMetadata;

Creates a new BatchTranslateMetadata instance using the specified properties.
Parameter properties
Properties to set
Returns
BatchTranslateMetadata instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.BatchTranslateMetadata;

Decodes a BatchTranslateMetadata message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
BatchTranslateMetadata
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.BatchTranslateMetadata;

Decodes a BatchTranslateMetadata message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
BatchTranslateMetadata
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IBatchTranslateMetadata,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateMetadata message. Does not implicitly verify messages.
Parameter message
BatchTranslateMetadata message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IBatchTranslateMetadata,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateMetadata message, length delimited. Does not implicitly verify messages.
Parameter message
BatchTranslateMetadata message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.BatchTranslateMetadata;

Creates a BatchTranslateMetadata message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
BatchTranslateMetadata

method toJSON

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

Converts this BatchTranslateMetadata to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.BatchTranslateMetadata,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a BatchTranslateMetadata message. Also converts values to other types if specified.
Parameter message
BatchTranslateMetadata
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a BatchTranslateMetadata message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class BatchTranslateResponse

class BatchTranslateResponse implements IBatchTranslateResponse {}

Represents a BatchTranslateResponse.

constructor

constructor(properties?: IBatchTranslateResponse);

Constructs a new BatchTranslateResponse.
Parameter properties
Properties to set

property endTime

endTime?: protobuf.ITimestamp;

BatchTranslateResponse endTime.

property failedCharacters

failedCharacters: any;

BatchTranslateResponse failedCharacters.

property submitTime

submitTime?: protobuf.ITimestamp;

BatchTranslateResponse submitTime.

property totalCharacters

totalCharacters: any;

BatchTranslateResponse totalCharacters.

property translatedCharacters

translatedCharacters: any;

BatchTranslateResponse translatedCharacters.

method create

static create: (
    properties?: google.cloud.translation.v3.IBatchTranslateResponse
) => google.cloud.translation.v3.BatchTranslateResponse;

Creates a new BatchTranslateResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
BatchTranslateResponse instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.BatchTranslateResponse;

Decodes a BatchTranslateResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
BatchTranslateResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.BatchTranslateResponse;

Decodes a BatchTranslateResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
BatchTranslateResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IBatchTranslateResponse,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateResponse message. Does not implicitly verify messages.
Parameter message
BatchTranslateResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IBatchTranslateResponse,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateResponse message, length delimited. Does not implicitly verify messages.
Parameter message
BatchTranslateResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.BatchTranslateResponse;

Creates a BatchTranslateResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
BatchTranslateResponse

method toJSON

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

Converts this BatchTranslateResponse to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.BatchTranslateResponse,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a BatchTranslateResponse message. Also converts values to other types if specified.
Parameter message
BatchTranslateResponse
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a BatchTranslateResponse message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class BatchTranslateTextRequest

class BatchTranslateTextRequest implements IBatchTranslateTextRequest {}

Represents a BatchTranslateTextRequest.

constructor

constructor(properties?: IBatchTranslateTextRequest);

Constructs a new BatchTranslateTextRequest.
Parameter properties
Properties to set

property glossaries

glossaries: { [k: string]: ITranslateTextGlossaryConfig };

BatchTranslateTextRequest glossaries.

property inputConfigs

inputConfigs: IInputConfig[];

BatchTranslateTextRequest inputConfigs.

property labels

labels: { [k: string]: string };

BatchTranslateTextRequest labels.

property models

models: { [k: string]: string };

BatchTranslateTextRequest models.

property outputConfig

outputConfig?: IOutputConfig;

BatchTranslateTextRequest outputConfig.

property parent

parent: string;

BatchTranslateTextRequest parent.

property sourceLanguageCode

sourceLanguageCode: string;

BatchTranslateTextRequest sourceLanguageCode.

property targetLanguageCodes

targetLanguageCodes: string[];

BatchTranslateTextRequest targetLanguageCodes.

method create

static create: (
    properties?: google.cloud.translation.v3.IBatchTranslateTextRequest
) => google.cloud.translation.v3.BatchTranslateTextRequest;

Creates a new BatchTranslateTextRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
BatchTranslateTextRequest instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.BatchTranslateTextRequest;

Decodes a BatchTranslateTextRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
BatchTranslateTextRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.BatchTranslateTextRequest;

Decodes a BatchTranslateTextRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
BatchTranslateTextRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IBatchTranslateTextRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateTextRequest message. Does not implicitly verify messages.
Parameter message
BatchTranslateTextRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IBatchTranslateTextRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified BatchTranslateTextRequest message, length delimited. Does not implicitly verify messages.
Parameter message
BatchTranslateTextRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.BatchTranslateTextRequest;

Creates a BatchTranslateTextRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
BatchTranslateTextRequest

method toJSON

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

Converts this BatchTranslateTextRequest to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.BatchTranslateTextRequest,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a BatchTranslateTextRequest message. Also converts values to other types if specified.
Parameter message
BatchTranslateTextRequest
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a BatchTranslateTextRequest message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class CreateGlossaryMetadata

class CreateGlossaryMetadata implements ICreateGlossaryMetadata {}

Represents a CreateGlossaryMetadata.

constructor

constructor(properties?: ICreateGlossaryMetadata);

Constructs a new CreateGlossaryMetadata.
Parameter properties
Properties to set

property name

name: string;

CreateGlossaryMetadata name.

property state

state:
    | 'STATE_UNSPECIFIED'
    | 'RUNNING'
    | 'SUCCEEDED'
    | 'FAILED'
    | 'CANCELLING'
    | 'CANCELLED'
    | CreateGlossaryMetadata.State;

CreateGlossaryMetadata state.

property submitTime

submitTime?: protobuf.ITimestamp;

CreateGlossaryMetadata submitTime.

method create

static create: (
    properties?: google.cloud.translation.v3.ICreateGlossaryMetadata
) => google.cloud.translation.v3.CreateGlossaryMetadata;

Creates a new CreateGlossaryMetadata instance using the specified properties.
Parameter properties
Properties to set
Returns
CreateGlossaryMetadata instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.CreateGlossaryMetadata;

Decodes a CreateGlossaryMetadata message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
CreateGlossaryMetadata
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.CreateGlossaryMetadata;

Decodes a CreateGlossaryMetadata message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
CreateGlossaryMetadata
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.ICreateGlossaryMetadata,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified CreateGlossaryMetadata message. Does not implicitly verify messages.
Parameter message
CreateGlossaryMetadata message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.ICreateGlossaryMetadata,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified CreateGlossaryMetadata message, length delimited. Does not implicitly verify messages.
Parameter message
CreateGlossaryMetadata message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.CreateGlossaryMetadata;

Creates a CreateGlossaryMetadata message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
CreateGlossaryMetadata

method toJSON

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

Converts this CreateGlossaryMetadata to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.CreateGlossaryMetadata,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a CreateGlossaryMetadata message. Also converts values to other types if specified.
Parameter message
CreateGlossaryMetadata
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a CreateGlossaryMetadata message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class CreateGlossaryRequest

class CreateGlossaryRequest implements ICreateGlossaryRequest {}

Represents a CreateGlossaryRequest.

constructor

constructor(properties?: ICreateGlossaryRequest);

Constructs a new CreateGlossaryRequest.
Parameter properties
Properties to set

property glossary

glossary?: IGlossary;

CreateGlossaryRequest glossary.

property parent

parent: string;

CreateGlossaryRequest parent.

method create

static create: (
    properties?: google.cloud.translation.v3.ICreateGlossaryRequest
) => google.cloud.translation.v3.CreateGlossaryRequest;

Creates a new CreateGlossaryRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
CreateGlossaryRequest instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.CreateGlossaryRequest;

Decodes a CreateGlossaryRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
CreateGlossaryRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.CreateGlossaryRequest;

Decodes a CreateGlossaryRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
CreateGlossaryRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.ICreateGlossaryRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified CreateGlossaryRequest message. Does not implicitly verify messages.
Parameter message
CreateGlossaryRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.ICreateGlossaryRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified CreateGlossaryRequest message, length delimited. Does not implicitly verify messages.
Parameter message
CreateGlossaryRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.CreateGlossaryRequest;

Creates a CreateGlossaryRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
CreateGlossaryRequest

method toJSON

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

Converts this CreateGlossaryRequest to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.CreateGlossaryRequest,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a CreateGlossaryRequest message. Also converts values to other types if specified.
Parameter message
CreateGlossaryRequest
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a CreateGlossaryRequest message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DeleteGlossaryMetadata

class DeleteGlossaryMetadata implements IDeleteGlossaryMetadata {}

Represents a DeleteGlossaryMetadata.

constructor

constructor(properties?: IDeleteGlossaryMetadata);

Constructs a new DeleteGlossaryMetadata.
Parameter properties
Properties to set

property name

name: string;

DeleteGlossaryMetadata name.

property state

state:
    | 'STATE_UNSPECIFIED'
    | 'RUNNING'
    | 'SUCCEEDED'
    | 'FAILED'
    | 'CANCELLING'
    | 'CANCELLED'
    | DeleteGlossaryMetadata.State;

DeleteGlossaryMetadata state.

property submitTime

submitTime?: protobuf.ITimestamp;

DeleteGlossaryMetadata submitTime.

method create

static create: (
    properties?: google.cloud.translation.v3.IDeleteGlossaryMetadata
) => google.cloud.translation.v3.DeleteGlossaryMetadata;

Creates a new DeleteGlossaryMetadata instance using the specified properties.
Parameter properties
Properties to set
Returns
DeleteGlossaryMetadata instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.DeleteGlossaryMetadata;

Decodes a DeleteGlossaryMetadata message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DeleteGlossaryMetadata
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DeleteGlossaryMetadata;

Decodes a DeleteGlossaryMetadata message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DeleteGlossaryMetadata
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDeleteGlossaryMetadata,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DeleteGlossaryMetadata message. Does not implicitly verify messages.
Parameter message
DeleteGlossaryMetadata message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDeleteGlossaryMetadata,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DeleteGlossaryMetadata message, length delimited. Does not implicitly verify messages.
Parameter message
DeleteGlossaryMetadata message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DeleteGlossaryMetadata;

Creates a DeleteGlossaryMetadata message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DeleteGlossaryMetadata

method toJSON

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

Converts this DeleteGlossaryMetadata to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.DeleteGlossaryMetadata,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a DeleteGlossaryMetadata message. Also converts values to other types if specified.
Parameter message
DeleteGlossaryMetadata
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a DeleteGlossaryMetadata message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DeleteGlossaryRequest

class DeleteGlossaryRequest implements IDeleteGlossaryRequest {}

Represents a DeleteGlossaryRequest.

constructor

constructor(properties?: IDeleteGlossaryRequest);

Constructs a new DeleteGlossaryRequest.
Parameter properties
Properties to set

property name

name: string;

DeleteGlossaryRequest name.

method create

static create: (
    properties?: google.cloud.translation.v3.IDeleteGlossaryRequest
) => google.cloud.translation.v3.DeleteGlossaryRequest;

Creates a new DeleteGlossaryRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
DeleteGlossaryRequest instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.DeleteGlossaryRequest;

Decodes a DeleteGlossaryRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DeleteGlossaryRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DeleteGlossaryRequest;

Decodes a DeleteGlossaryRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DeleteGlossaryRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDeleteGlossaryRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DeleteGlossaryRequest message. Does not implicitly verify messages.
Parameter message
DeleteGlossaryRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDeleteGlossaryRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DeleteGlossaryRequest message, length delimited. Does not implicitly verify messages.
Parameter message
DeleteGlossaryRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DeleteGlossaryRequest;

Creates a DeleteGlossaryRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DeleteGlossaryRequest

method toJSON

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

Converts this DeleteGlossaryRequest to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.DeleteGlossaryRequest,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a DeleteGlossaryRequest message. Also converts values to other types if specified.
Parameter message
DeleteGlossaryRequest
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a DeleteGlossaryRequest message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DeleteGlossaryResponse

class DeleteGlossaryResponse implements IDeleteGlossaryResponse {}

Represents a DeleteGlossaryResponse.

constructor

constructor(properties?: IDeleteGlossaryResponse);

Constructs a new DeleteGlossaryResponse.
Parameter properties
Properties to set

property endTime

endTime?: protobuf.ITimestamp;

DeleteGlossaryResponse endTime.

property name

name: string;

DeleteGlossaryResponse name.

property submitTime

submitTime?: protobuf.ITimestamp;

DeleteGlossaryResponse submitTime.

method create

static create: (
    properties?: google.cloud.translation.v3.IDeleteGlossaryResponse
) => google.cloud.translation.v3.DeleteGlossaryResponse;

Creates a new DeleteGlossaryResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
DeleteGlossaryResponse instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.DeleteGlossaryResponse;

Decodes a DeleteGlossaryResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DeleteGlossaryResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DeleteGlossaryResponse;

Decodes a DeleteGlossaryResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DeleteGlossaryResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDeleteGlossaryResponse,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DeleteGlossaryResponse message. Does not implicitly verify messages.
Parameter message
DeleteGlossaryResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDeleteGlossaryResponse,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DeleteGlossaryResponse message, length delimited. Does not implicitly verify messages.
Parameter message
DeleteGlossaryResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DeleteGlossaryResponse;

Creates a DeleteGlossaryResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DeleteGlossaryResponse

method toJSON

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

Converts this DeleteGlossaryResponse to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.DeleteGlossaryResponse,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a DeleteGlossaryResponse message. Also converts values to other types if specified.
Parameter message
DeleteGlossaryResponse
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a DeleteGlossaryResponse message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DetectedLanguage

class DetectedLanguage implements IDetectedLanguage {}

Represents a DetectedLanguage.

constructor

constructor(properties?: IDetectedLanguage);

Constructs a new DetectedLanguage.
Parameter properties
Properties to set

property confidence

confidence: number;

DetectedLanguage confidence.

property languageCode

languageCode: string;

DetectedLanguage languageCode.

method create

static create: (
    properties?: google.cloud.translation.v3.IDetectedLanguage
) => google.cloud.translation.v3.DetectedLanguage;

Creates a new DetectedLanguage instance using the specified properties.
Parameter properties
Properties to set
Returns
DetectedLanguage instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.DetectedLanguage;

Decodes a DetectedLanguage message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DetectedLanguage
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DetectedLanguage;

Decodes a DetectedLanguage message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DetectedLanguage
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDetectedLanguage,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DetectedLanguage message. Does not implicitly verify messages.
Parameter message
DetectedLanguage message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDetectedLanguage,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DetectedLanguage message, length delimited. Does not implicitly verify messages.
Parameter message
DetectedLanguage message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DetectedLanguage;

Creates a DetectedLanguage message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DetectedLanguage

method toJSON

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

Converts this DetectedLanguage to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.DetectedLanguage,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a DetectedLanguage message. Also converts values to other types if specified.
Parameter message
DetectedLanguage
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a DetectedLanguage message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DetectLanguageRequest

class DetectLanguageRequest implements IDetectLanguageRequest {}

Represents a DetectLanguageRequest.

constructor

constructor(properties?: IDetectLanguageRequest);

Constructs a new DetectLanguageRequest.
Parameter properties
Properties to set

property content

content?: string;

DetectLanguageRequest content.

property labels

labels: { [k: string]: string };

DetectLanguageRequest labels.

property mimeType

mimeType: string;

DetectLanguageRequest mimeType.

property model

model: string;

DetectLanguageRequest model.

property parent

parent: string;

DetectLanguageRequest parent.

property source

source?: string;

DetectLanguageRequest source.

method create

static create: (
    properties?: google.cloud.translation.v3.IDetectLanguageRequest
) => google.cloud.translation.v3.DetectLanguageRequest;

Creates a new DetectLanguageRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
DetectLanguageRequest instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.DetectLanguageRequest;

Decodes a DetectLanguageRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DetectLanguageRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DetectLanguageRequest;

Decodes a DetectLanguageRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DetectLanguageRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDetectLanguageRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DetectLanguageRequest message. Does not implicitly verify messages.
Parameter message
DetectLanguageRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDetectLanguageRequest,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DetectLanguageRequest message, length delimited. Does not implicitly verify messages.
Parameter message
DetectLanguageRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DetectLanguageRequest;

Creates a DetectLanguageRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DetectLanguageRequest

method toJSON

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

Converts this DetectLanguageRequest to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.DetectLanguageRequest,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a DetectLanguageRequest message. Also converts values to other types if specified.
Parameter message
DetectLanguageRequest
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a DetectLanguageRequest message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DetectLanguageResponse

class DetectLanguageResponse implements IDetectLanguageResponse {}

Represents a DetectLanguageResponse.

constructor

constructor(properties?: IDetectLanguageResponse);

Constructs a new DetectLanguageResponse.
Parameter properties
Properties to set

property languages

languages: IDetectedLanguage[];

DetectLanguageResponse languages.

method create

static create: (
    properties?: google.cloud.translation.v3.IDetectLanguageResponse
) => google.cloud.translation.v3.DetectLanguageResponse;

Creates a new DetectLanguageResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
DetectLanguageResponse instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.DetectLanguageResponse;

Decodes a DetectLanguageResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DetectLanguageResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DetectLanguageResponse;

Decodes a DetectLanguageResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DetectLanguageResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDetectLanguageResponse,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DetectLanguageResponse message. Does not implicitly verify messages.
Parameter message
DetectLanguageResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDetectLanguageResponse,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DetectLanguageResponse message, length delimited. Does not implicitly verify messages.
Parameter message
DetectLanguageResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DetectLanguageResponse;

Creates a DetectLanguageResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DetectLanguageResponse

method toJSON

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

Converts this DetectLanguageResponse to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.DetectLanguageResponse,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a DetectLanguageResponse message. Also converts values to other types if specified.
Parameter message
DetectLanguageResponse
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a DetectLanguageResponse message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DocumentInputConfig

class DocumentInputConfig implements IDocumentInputConfig {}

Represents a DocumentInputConfig.

constructor

constructor(properties?: IDocumentInputConfig);

Constructs a new DocumentInputConfig.
Parameter properties
Properties to set

property content

content?: string | Uint8Array;

DocumentInputConfig content.

property gcsSource

gcsSource?: IGcsSource;

DocumentInputConfig gcsSource.

property mimeType

mimeType: string;

DocumentInputConfig mimeType.

property source

source?: 'content' | 'gcsSource';

DocumentInputConfig source.

method create

static create: (
    properties?: google.cloud.translation.v3.IDocumentInputConfig
) => google.cloud.translation.v3.DocumentInputConfig;

Creates a new DocumentInputConfig instance using the specified properties.
Parameter properties
Properties to set
Returns
DocumentInputConfig instance

method decode

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

Decodes a DocumentInputConfig message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DocumentInputConfig
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DocumentInputConfig;

Decodes a DocumentInputConfig message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DocumentInputConfig
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDocumentInputConfig,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DocumentInputConfig message. Does not implicitly verify messages.
Parameter message
DocumentInputConfig message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDocumentInputConfig,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DocumentInputConfig message, length delimited. Does not implicitly verify messages.
Parameter message
DocumentInputConfig message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DocumentInputConfig;

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

method toJSON

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

Converts this DocumentInputConfig to JSON.
Returns
JSON object

method toObject

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

Creates a plain object from a DocumentInputConfig message. Also converts values to other types if specified.
Parameter message
DocumentInputConfig
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a DocumentInputConfig message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DocumentOutputConfig

class DocumentOutputConfig implements IDocumentOutputConfig {}

Represents a DocumentOutputConfig.

constructor

constructor(properties?: IDocumentOutputConfig);

Constructs a new DocumentOutputConfig.
Parameter properties
Properties to set

property destination

destination?: string;

DocumentOutputConfig destination.

property gcsDestination

gcsDestination?: IGcsDestination;

DocumentOutputConfig gcsDestination.

property mimeType

mimeType: string;

DocumentOutputConfig mimeType.

method create

static create: (
    properties?: google.cloud.translation.v3.IDocumentOutputConfig
) => google.cloud.translation.v3.DocumentOutputConfig;

Creates a new DocumentOutputConfig instance using the specified properties.
Parameter properties
Properties to set
Returns
DocumentOutputConfig instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.DocumentOutputConfig;

Decodes a DocumentOutputConfig message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DocumentOutputConfig
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DocumentOutputConfig;

Decodes a DocumentOutputConfig message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DocumentOutputConfig
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDocumentOutputConfig,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DocumentOutputConfig message. Does not implicitly verify messages.
Parameter message
DocumentOutputConfig message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDocumentOutputConfig,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DocumentOutputConfig message, length delimited. Does not implicitly verify messages.
Parameter message
DocumentOutputConfig message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DocumentOutputConfig;

Creates a DocumentOutputConfig message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DocumentOutputConfig

method toJSON

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

Converts this DocumentOutputConfig to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.DocumentOutputConfig,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a DocumentOutputConfig message. Also converts values to other types if specified.
Parameter message
DocumentOutputConfig
Parameter options
Conversion options
Returns
Plain object

method verify

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

Verifies a DocumentOutputConfig message.
Parameter message
Plain object to verify
Returns
null if valid, otherwise the reason why it is not

class DocumentTranslation

class DocumentTranslation implements IDocumentTranslation {}

Represents a DocumentTranslation.

constructor

constructor(properties?: IDocumentTranslation);

Constructs a new DocumentTranslation.
Parameter properties
Properties to set

property byteStreamOutputs

byteStreamOutputs: Uint8Array[];

DocumentTranslation byteStreamOutputs.

property detectedLanguageCode

detectedLanguageCode: string;

DocumentTranslation detectedLanguageCode.

property mimeType

mimeType: string;

DocumentTranslation mimeType.

method create

static create: (
    properties?: google.cloud.translation.v3.IDocumentTranslation
) => google.cloud.translation.v3.DocumentTranslation;

Creates a new DocumentTranslation instance using the specified properties.
Parameter properties
Properties to set
Returns
DocumentTranslation instance

method decode

static decode: (
    reader: $protobuf.Reader | Uint8Array,
    length?: number
) => google.cloud.translation.v3.DocumentTranslation;

Decodes a DocumentTranslation message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DocumentTranslation
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method decodeDelimited

static decodeDelimited: (
    reader: $protobuf.Reader | Uint8Array
) => google.cloud.translation.v3.DocumentTranslation;

Decodes a DocumentTranslation message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DocumentTranslation
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing

method encode

static encode: (
    message: google.cloud.translation.v3.IDocumentTranslation,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DocumentTranslation message. Does not implicitly verify messages.
Parameter message
DocumentTranslation message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method encodeDelimited

static encodeDelimited: (
    message: google.cloud.translation.v3.IDocumentTranslation,
    writer?: $protobuf.Writer
) => $protobuf.Writer;

Encodes the specified DocumentTranslation message, length delimited. Does not implicitly verify messages.
Parameter message
DocumentTranslation message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer

method fromObject

static fromObject: (object: {
    [k: string]: any;
}) => google.cloud.translation.v3.DocumentTranslation;

Creates a DocumentTranslation message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DocumentTranslation

method toJSON

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

Converts this DocumentTranslation to JSON.
Returns
JSON object

method toObject

static toObject: (
    message: google.cloud.translation.v3.DocumentTranslation,
    options?: $protobuf.IConversionOptions
) => { [k: string]: any };

Creates a plain object from a DocumentTranslation message. Also converts values to other types if specified.
Parameter message
DocumentTranslation
Parameter options
Conversion options
Returns
Plain object

method verify

static verify: (message: { [k: string]: any }) =>

@google-cloud/translate

Install

Overview

Index

Variables

Type Aliases

Namespaces

Variables

variable _default

variable TranslationServiceClient

Type Aliases

type TranslationServiceClient

Namespaces

namespace protos

namespace protos.google

namespace protos.google.api

class CustomHttpPattern

constructor

Parameter properties

property kind

property path

method create

Parameter properties

Returns

method decode

Parameter reader

Parameter length

Returns

Throws

Throws

method decodeDelimited

Parameter reader

Returns

Throws

Throws

method encode

Parameter message

Parameter writer

Returns

method encodeDelimited

Parameter message

Parameter writer

Returns

method fromObject

Parameter object

Returns

method toJSON

Returns

method toObject

Parameter message

Parameter options

Returns

method verify

Parameter message

Returns

class Http

constructor

Parameter properties

property fullyDecodeReservedExpansion

property rules

method create

Parameter properties

Returns

method decode

Parameter reader

Parameter length

Returns

Throws

Throws

method decodeDelimited

Parameter reader

Returns

Throws

Throws

method encode

Parameter message

Parameter writer

Returns

method encodeDelimited

Parameter message