Represents a Glossary.
Package
@google-cloud/translateConstructors
(constructor)(properties)
constructor(properties?: google.cloud.translation.v3.IGlossary);Constructs a new Glossary.
| Parameter | |
|---|---|
| Name | Description |
properties |
IGlossary
Properties to set |
Properties
displayName
public displayName: string;Glossary displayName.
endTime
public endTime?: (google.protobuf.ITimestamp|null);Glossary endTime.
entryCount
public entryCount: number;Glossary entryCount.
inputConfig
public inputConfig?: (google.cloud.translation.v3.IGlossaryInputConfig|null);Glossary inputConfig.
languageCodesSet
public languageCodesSet?: (google.cloud.translation.v3.Glossary.ILanguageCodesSet|null);Glossary languageCodesSet.
languagePair
public languagePair?: (google.cloud.translation.v3.Glossary.ILanguageCodePair|null);Glossary languagePair.
languages
public languages?: ("languagePair"|"languageCodesSet");Glossary languages.
name
public name: string;Glossary name.
submitTime
public submitTime?: (google.protobuf.ITimestamp|null);Glossary submitTime.
Methods
create(properties)
public static create(properties?: google.cloud.translation.v3.IGlossary): google.cloud.translation.v3.Glossary;Creates a new Glossary instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IGlossary
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Glossary | Glossary instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.translation.v3.Glossary;Decodes a Glossary message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Glossary | Glossary |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.translation.v3.Glossary;Decodes a Glossary message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Glossary | Glossary |
encode(message, writer)
public static encode(message: google.cloud.translation.v3.IGlossary, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Glossary message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IGlossary
Glossary message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.translation.v3.IGlossary, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Glossary message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IGlossary
Glossary message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.translation.v3.Glossary;Creates a Glossary message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Glossary | Glossary |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Glossary
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Glossary to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.translation.v3.Glossary, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Glossary message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Glossary
Glossary |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Glossary message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|