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.



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 923

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:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 923

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.



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 923

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:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 923

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.

Returns:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 923

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.

Returns:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 923

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}.



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 923

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:



923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'proto_docs/google/cloud/translate/v3/translation_service.rb', line 923

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