Class: Google::Cloud::Translate::V3::Glossary

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/translate/v3/translation_service.rb

Overview

Represents a glossary built from user-provided data.

Defined Under Namespace

Classes: LanguageCodePair, LanguageCodesSet

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ ::String

Returns Optional. The display name of the glossary.

Returns:

  • (::String) —

    Optional. The display name of the glossary.



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 991

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Used with unidirectional glossaries.
  # @!attribute [rw] source_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code of the input text, for example,
  #     "en-US". Expected to be an exact match for GlossaryTerm.language_code.
  # @!attribute [rw] target_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code for translation output, for example,
  #     "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodePair
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used with equivalent term set glossaries.
  # @!attribute [rw] language_codes
  #   @return [::Array<::String>]
  #     The ISO-639 language code(s) for terms defined in the glossary.
  #     All entries are unique. The list contains at least two entries.
  #     Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodesSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. When the glossary creation was finished.

Returns:



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 991

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Used with unidirectional glossaries.
  # @!attribute [rw] source_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code of the input text, for example,
  #     "en-US". Expected to be an exact match for GlossaryTerm.language_code.
  # @!attribute [rw] target_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code for translation output, for example,
  #     "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodePair
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used with equivalent term set glossaries.
  # @!attribute [rw] language_codes
  #   @return [::Array<::String>]
  #     The ISO-639 language code(s) for terms defined in the glossary.
  #     All entries are unique. The list contains at least two entries.
  #     Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodesSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#entry_count ⇒ ::Integer (readonly)

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

Returns:

  • (::Integer) —

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



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 991

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Used with unidirectional glossaries.
  # @!attribute [rw] source_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code of the input text, for example,
  #     "en-US". Expected to be an exact match for GlossaryTerm.language_code.
  # @!attribute [rw] target_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code for translation output, for example,
  #     "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodePair
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used with equivalent term set glossaries.
  # @!attribute [rw] language_codes
  #   @return [::Array<::String>]
  #     The ISO-639 language code(s) for terms defined in the glossary.
  #     All entries are unique. The list contains at least two entries.
  #     Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodesSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#input_config ⇒ ::Google::Cloud::Translate::V3::GlossaryInputConfig

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

Returns:



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 991

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Used with unidirectional glossaries.
  # @!attribute [rw] source_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code of the input text, for example,
  #     "en-US". Expected to be an exact match for GlossaryTerm.language_code.
  # @!attribute [rw] target_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code for translation output, for example,
  #     "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodePair
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used with equivalent term set glossaries.
  # @!attribute [rw] language_codes
  #   @return [::Array<::String>]
  #     The ISO-639 language code(s) for terms defined in the glossary.
  #     All entries are unique. The list contains at least two entries.
  #     Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodesSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#language_codes_set ⇒ ::Google::Cloud::Translate::V3::Glossary::LanguageCodesSet

Returns Used with equivalent term set glossaries.

Note: The following fields are mutually exclusive: language_codes_set, language_pair. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Translate::V3::Glossary::LanguageCodesSet) —

    Used with equivalent term set glossaries.

    Note: The following fields are mutually exclusive: language_codes_set, language_pair. If a field in that set is populated, all other fields in the set will automatically be cleared.



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 991

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Used with unidirectional glossaries.
  # @!attribute [rw] source_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code of the input text, for example,
  #     "en-US". Expected to be an exact match for GlossaryTerm.language_code.
  # @!attribute [rw] target_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code for translation output, for example,
  #     "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodePair
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used with equivalent term set glossaries.
  # @!attribute [rw] language_codes
  #   @return [::Array<::String>]
  #     The ISO-639 language code(s) for terms defined in the glossary.
  #     All entries are unique. The list contains at least two entries.
  #     Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodesSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#language_pair ⇒ ::Google::Cloud::Translate::V3::Glossary::LanguageCodePair

Returns Used with unidirectional glossaries.

Note: The following fields are mutually exclusive: language_pair, language_codes_set. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 991

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Used with unidirectional glossaries.
  # @!attribute [rw] source_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code of the input text, for example,
  #     "en-US". Expected to be an exact match for GlossaryTerm.language_code.
  # @!attribute [rw] target_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code for translation output, for example,
  #     "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodePair
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used with equivalent term set glossaries.
  # @!attribute [rw] language_codes
  #   @return [::Array<::String>]
  #     The ISO-639 language code(s) for terms defined in the glossary.
  #     All entries are unique. The list contains at least two entries.
  #     Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodesSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

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

Returns:

  • (::String) —

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



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 991

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Used with unidirectional glossaries.
  # @!attribute [rw] source_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code of the input text, for example,
  #     "en-US". Expected to be an exact match for GlossaryTerm.language_code.
  # @!attribute [rw] target_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code for translation output, for example,
  #     "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodePair
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used with equivalent term set glossaries.
  # @!attribute [rw] language_codes
  #   @return [::Array<::String>]
  #     The ISO-639 language code(s) for terms defined in the glossary.
  #     All entries are unique. The list contains at least two entries.
  #     Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodesSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#submit_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. When CreateGlossary was called.

Returns:



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 991

class Glossary
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Used with unidirectional glossaries.
  # @!attribute [rw] source_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code of the input text, for example,
  #     "en-US". Expected to be an exact match for GlossaryTerm.language_code.
  # @!attribute [rw] target_language_code
  #   @return [::String]
  #     Required. The ISO-639 language code for translation output, for example,
  #     "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodePair
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Used with equivalent term set glossaries.
  # @!attribute [rw] language_codes
  #   @return [::Array<::String>]
  #     The ISO-639 language code(s) for terms defined in the glossary.
  #     All entries are unique. The list contains at least two entries.
  #     Expected to be an exact match for GlossaryTerm.language_code.
  class LanguageCodesSet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end