Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. translate
  5. translate/v3
  6. getGlossary

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.translate/v3.getGlossary

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets a glossary. Returns NOT_FOUND, if the glossary doesn’t exist.

    Using getGlossary

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGlossary(args: GetGlossaryArgs, opts?: InvokeOptions): Promise<GetGlossaryResult>
function getGlossaryOutput(args: GetGlossaryOutputArgs, opts?: InvokeOptions): Output<GetGlossaryResult>
    def get_glossary(glossary_id: Optional[str] = None,
                 location: Optional[str] = None,
                 project: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetGlossaryResult
def get_glossary_output(glossary_id: Optional[pulumi.Input[str]] = None,
                 location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetGlossaryResult]
    func LookupGlossary(ctx *Context, args *LookupGlossaryArgs, opts ...InvokeOption) (*LookupGlossaryResult, error)
func LookupGlossaryOutput(ctx *Context, args *LookupGlossaryOutputArgs, opts ...InvokeOption) LookupGlossaryResultOutput

    > Note: This function is named LookupGlossary in the Go SDK.

    public static class GetGlossary 
{
    public static Task<GetGlossaryResult> InvokeAsync(GetGlossaryArgs args, InvokeOptions? opts = null)
    public static Output<GetGlossaryResult> Invoke(GetGlossaryInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGlossaryResult> getGlossary(GetGlossaryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:translate/v3:getGlossary
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GlossaryId string
    Location string
    Project string
    GlossaryId string
    Location string
    Project string
    glossaryId String
    location String
    project String
    glossaryId string
    location string
    project string
    glossaryId String
    location String
    project String

    getGlossary Result

    The following output properties are available:

    DisplayName string
    Optional. The display name of the glossary.
    EndTime string
    When the glossary creation was finished.
    EntryCount int
    The number of entries defined in the glossary.
    InputConfig Pulumi.GoogleNative.Translate.V3.Outputs.GlossaryInputConfigResponse
    Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
    LanguageCodesSet Pulumi.GoogleNative.Translate.V3.Outputs.LanguageCodesSetResponse
    Used with equivalent term set glossaries.
    LanguagePair Pulumi.GoogleNative.Translate.V3.Outputs.LanguageCodePairResponse
    Used with unidirectional glossaries.
    Name string
    The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.
    SubmitTime string
    When CreateGlossary was called.
    DisplayName string
    Optional. The display name of the glossary.
    EndTime string
    When the glossary creation was finished.
    EntryCount int
    The number of entries defined in the glossary.
    InputConfig GlossaryInputConfigResponse
    Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
    LanguageCodesSet LanguageCodesSetResponse
    Used with equivalent term set glossaries.
    LanguagePair LanguageCodePairResponse
    Used with unidirectional glossaries.
    Name string
    The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.
    SubmitTime string
    When CreateGlossary was called.
    displayName String
    Optional. The display name of the glossary.
    endTime String
    When the glossary creation was finished.
    entryCount Integer
    The number of entries defined in the glossary.
    inputConfig GlossaryInputConfigResponse
    Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
    languageCodesSet LanguageCodesSetResponse
    Used with equivalent term set glossaries.
    languagePair LanguageCodePairResponse
    Used with unidirectional glossaries.
    name String
    The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.
    submitTime String
    When CreateGlossary was called.
    displayName string
    Optional. The display name of the glossary.
    endTime string
    When the glossary creation was finished.
    entryCount number
    The number of entries defined in the glossary.
    inputConfig GlossaryInputConfigResponse
    Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
    languageCodesSet LanguageCodesSetResponse
    Used with equivalent term set glossaries.
    languagePair LanguageCodePairResponse
    Used with unidirectional glossaries.
    name string
    The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.
    submitTime string
    When CreateGlossary was called.
    display_name str
    Optional. The display name of the glossary.
    end_time str
    When the glossary creation was finished.
    entry_count int
    The number of entries defined in the glossary.
    input_config GlossaryInputConfigResponse
    Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
    language_codes_set LanguageCodesSetResponse
    Used with equivalent term set glossaries.
    language_pair LanguageCodePairResponse
    Used with unidirectional glossaries.
    name str
    The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.
    submit_time str
    When CreateGlossary was called.
    displayName String
    Optional. The display name of the glossary.
    endTime String
    When the glossary creation was finished.
    entryCount Number
    The number of entries defined in the glossary.
    inputConfig Property Map
    Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints.
    languageCodesSet Property Map
    Used with equivalent term set glossaries.
    languagePair Property Map
    Used with unidirectional glossaries.
    name String
    The resource name of the glossary. Glossary names have the form projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}.
    submitTime String
    When CreateGlossary was called.

    Supporting Types

    GcsSourceResponse

    InputUri string
    Source data URI. For example, gs://my_bucket/my_object.
    InputUri string
    Source data URI. For example, gs://my_bucket/my_object.
    inputUri String
    Source data URI. For example, gs://my_bucket/my_object.
    inputUri string
    Source data URI. For example, gs://my_bucket/my_object.
    input_uri str
    Source data URI. For example, gs://my_bucket/my_object.
    inputUri String
    Source data URI. For example, gs://my_bucket/my_object.

    GlossaryInputConfigResponse

    GcsSource Pulumi.GoogleNative.Translate.V3.Inputs.GcsSourceResponse
    Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (.tsv/.csv): Two column file, tab- or comma-separated. The first column is source text. The second column is target text. No headers in this file. The first row contains data and not column names. - TMX (.tmx): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (.csv): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - glossaries.
    GcsSource GcsSourceResponse
    Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (.tsv/.csv): Two column file, tab- or comma-separated. The first column is source text. The second column is target text. No headers in this file. The first row contains data and not column names. - TMX (.tmx): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (.csv): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - glossaries.
    gcsSource GcsSourceResponse
    Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (.tsv/.csv): Two column file, tab- or comma-separated. The first column is source text. The second column is target text. No headers in this file. The first row contains data and not column names. - TMX (.tmx): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (.csv): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - glossaries.
    gcsSource GcsSourceResponse
    Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (.tsv/.csv): Two column file, tab- or comma-separated. The first column is source text. The second column is target text. No headers in this file. The first row contains data and not column names. - TMX (.tmx): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (.csv): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - glossaries.
    gcs_source GcsSourceResponse
    Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (.tsv/.csv): Two column file, tab- or comma-separated. The first column is source text. The second column is target text. No headers in this file. The first row contains data and not column names. - TMX (.tmx): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (.csv): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - glossaries.
    gcsSource Property Map
    Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (.tsv/.csv): Two column file, tab- or comma-separated. The first column is source text. The second column is target text. No headers in this file. The first row contains data and not column names. - TMX (.tmx): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (.csv): Multi-column CSV file defining equivalent glossary terms in multiple languages. See documentation for more information - glossaries.

    LanguageCodePairResponse

    SourceLanguageCode string
    The ISO-639 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code.
    TargetLanguageCode string
    The ISO-639 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
    SourceLanguageCode string
    The ISO-639 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code.
    TargetLanguageCode string
    The ISO-639 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
    sourceLanguageCode String
    The ISO-639 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code.
    targetLanguageCode String
    The ISO-639 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
    sourceLanguageCode string
    The ISO-639 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code.
    targetLanguageCode string
    The ISO-639 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
    source_language_code str
    The ISO-639 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code.
    target_language_code str
    The ISO-639 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.
    sourceLanguageCode String
    The ISO-639 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code.
    targetLanguageCode String
    The ISO-639 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code.

    LanguageCodesSetResponse

    LanguageCodes List<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.
    LanguageCodes []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.
    languageCodes List<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.
    languageCodes 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.
    language_codes Sequence[str]
    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.
    languageCodes List<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.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native