TranslateDocumentRequest

google.cloud.translation.v3beta1. TranslateDocumentRequest

Represents a TranslateDocumentRequest.

Constructor

new TranslateDocumentRequest(propertiesopt)

Constructs a new TranslateDocumentRequest.

Parameters:
Name Type Attributes Description
properties google.cloud.translation.v3beta1.ITranslateDocumentRequest <optional>

Properties to set

Implements:
  • ITranslateDocumentRequest

Members

customizedAttribution

TranslateDocumentRequest customizedAttribution.

documentInputConfig

TranslateDocumentRequest documentInputConfig.

documentOutputConfig

TranslateDocumentRequest documentOutputConfig.

enableRotationCorrection

TranslateDocumentRequest enableRotationCorrection.

enableShadowRemovalNativePdf

TranslateDocumentRequest enableShadowRemovalNativePdf.

glossaryConfig

TranslateDocumentRequest glossaryConfig.

isTranslateNativePdfOnly

TranslateDocumentRequest isTranslateNativePdfOnly.

labels

TranslateDocumentRequest labels.

model

TranslateDocumentRequest model.

parent

TranslateDocumentRequest parent.

sourceLanguageCode

TranslateDocumentRequest sourceLanguageCode.

targetLanguageCode

TranslateDocumentRequest targetLanguageCode.

Methods

toJSON() → {Object.<string, *>}

Converts this TranslateDocumentRequest to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.translation.v3beta1.TranslateDocumentRequest}

Creates a new TranslateDocumentRequest instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.translation.v3beta1.ITranslateDocumentRequest <optional>

Properties to set

Returns:
Type Description
google.cloud.translation.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest instance

(static) decode(reader, lengthopt) → {google.cloud.translation.v3beta1.TranslateDocumentRequest}

Decodes a TranslateDocumentRequest message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.translation.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.translation.v3beta1.TranslateDocumentRequest}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.translation.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified TranslateDocumentRequest message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3beta1.ITranslateDocumentRequest

TranslateDocumentRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3beta1.ITranslateDocumentRequest

TranslateDocumentRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.translation.v3beta1.TranslateDocumentRequest}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.translation.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for TranslateDocumentRequest

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a TranslateDocumentRequest message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not