Class Glossary (2.30.0)

public final class Glossary extends GeneratedMessageV3 implements GlossaryOrBuilder

Represents a glossary built from user-provided data.

Protobuf type google.cloud.translation.v3.Glossary

Implements

GlossaryOrBuilder

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ENTRY_COUNT_FIELD_NUMBER

public static final int ENTRY_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LANGUAGE_CODES_SET_FIELD_NUMBER

public static final int LANGUAGE_CODES_SET_FIELD_NUMBER
Field Value
TypeDescription
int

LANGUAGE_PAIR_FIELD_NUMBER

public static final int LANGUAGE_PAIR_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SUBMIT_TIME_FIELD_NUMBER

public static final int SUBMIT_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Glossary getDefaultInstance()
Returns
TypeDescription
Glossary

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Glossary.Builder newBuilder()
Returns
TypeDescription
Glossary.Builder

newBuilder(Glossary prototype)

public static Glossary.Builder newBuilder(Glossary prototype)
Parameter
NameDescription
prototypeGlossary
Returns
TypeDescription
Glossary.Builder

parseDelimitedFrom(InputStream input)

public static Glossary parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Glossary parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Glossary parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Glossary parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Glossary parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Glossary parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Glossary parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Glossary parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Glossary parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Glossary parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Glossary parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Glossary parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Glossary
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Glossary> parser()
Returns
TypeDescription
Parser<Glossary>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Glossary getDefaultInstanceForType()
Returns
TypeDescription
Glossary

getDisplayName()

public String getDisplayName()

Optional. The display name of the glossary.

string display_name = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The display name of the glossary.

string display_name = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for displayName.

getEndTime()

public Timestamp getEndTime()

Output only. When the glossary creation was finished.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. When the glossary creation was finished.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getEntryCount()

public int getEntryCount()

Output only. The number of entries defined in the glossary.

int32 entry_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The entryCount.

getInputConfig()

public GlossaryInputConfig getInputConfig()

Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.

.google.cloud.translation.v3.GlossaryInputConfig input_config = 5;

Returns
TypeDescription
GlossaryInputConfig

The inputConfig.

getInputConfigOrBuilder()

public GlossaryInputConfigOrBuilder getInputConfigOrBuilder()

Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.

.google.cloud.translation.v3.GlossaryInputConfig input_config = 5;

Returns
TypeDescription
GlossaryInputConfigOrBuilder

getLanguageCodesSet()

public Glossary.LanguageCodesSet getLanguageCodesSet()

Used with equivalent term set glossaries.

.google.cloud.translation.v3.Glossary.LanguageCodesSet language_codes_set = 4;

Returns
TypeDescription
Glossary.LanguageCodesSet

The languageCodesSet.

getLanguageCodesSetOrBuilder()

public Glossary.LanguageCodesSetOrBuilder getLanguageCodesSetOrBuilder()

Used with equivalent term set glossaries.

.google.cloud.translation.v3.Glossary.LanguageCodesSet language_codes_set = 4;

Returns
TypeDescription
Glossary.LanguageCodesSetOrBuilder

getLanguagePair()

public Glossary.LanguageCodePair getLanguagePair()

Used with unidirectional glossaries.

.google.cloud.translation.v3.Glossary.LanguageCodePair language_pair = 3;

Returns
TypeDescription
Glossary.LanguageCodePair

The languagePair.

getLanguagePairOrBuilder()

public Glossary.LanguageCodePairOrBuilder getLanguagePairOrBuilder()

Used with unidirectional glossaries.

.google.cloud.translation.v3.Glossary.LanguageCodePair language_pair = 3;

Returns
TypeDescription
Glossary.LanguageCodePairOrBuilder

getLanguagesCase()

public Glossary.LanguagesCase getLanguagesCase()
Returns
TypeDescription
Glossary.LanguagesCase

getName()

public String getName()

Required. The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Glossary> getParserForType()
Returns
TypeDescription
Parser<Glossary>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSubmitTime()

public Timestamp getSubmitTime()

Output only. When CreateGlossary was called.

.google.protobuf.Timestamp submit_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The submitTime.

getSubmitTimeOrBuilder()

public TimestampOrBuilder getSubmitTimeOrBuilder()

Output only. When CreateGlossary was called.

.google.protobuf.Timestamp submit_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

Output only. When the glossary creation was finished.

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasInputConfig()

public boolean hasInputConfig()

Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.

.google.cloud.translation.v3.GlossaryInputConfig input_config = 5;

Returns
TypeDescription
boolean

Whether the inputConfig field is set.

hasLanguageCodesSet()

public boolean hasLanguageCodesSet()

Used with equivalent term set glossaries.

.google.cloud.translation.v3.Glossary.LanguageCodesSet language_codes_set = 4;

Returns
TypeDescription
boolean

Whether the languageCodesSet field is set.

hasLanguagePair()

public boolean hasLanguagePair()

Used with unidirectional glossaries.

.google.cloud.translation.v3.Glossary.LanguageCodePair language_pair = 3;

Returns
TypeDescription
boolean

Whether the languagePair field is set.

hasSubmitTime()

public boolean hasSubmitTime()

Output only. When CreateGlossary was called.

.google.protobuf.Timestamp submit_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the submitTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Glossary.Builder newBuilderForType()
Returns
TypeDescription
Glossary.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Glossary.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Glossary.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Glossary.Builder toBuilder()
Returns
TypeDescription
Glossary.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException