1. Packages
  2. Google Cloud Native
  3. API Docs
  4. contentwarehouse
  5. contentwarehouse/v1
  6. getSynonymSet

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

google-native.contentwarehouse/v1.getSynonymSet

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

    Gets a SynonymSet for a particular context. Throws a NOT_FOUND exception if the Synonymset does not exist

    Using getSynonymSet

    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 getSynonymSet(args: GetSynonymSetArgs, opts?: InvokeOptions): Promise<GetSynonymSetResult>
    function getSynonymSetOutput(args: GetSynonymSetOutputArgs, opts?: InvokeOptions): Output<GetSynonymSetResult>
    def get_synonym_set(location: Optional[str] = None,
                        project: Optional[str] = None,
                        synonym_set_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSynonymSetResult
    def get_synonym_set_output(location: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        synonym_set_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSynonymSetResult]
    func LookupSynonymSet(ctx *Context, args *LookupSynonymSetArgs, opts ...InvokeOption) (*LookupSynonymSetResult, error)
    func LookupSynonymSetOutput(ctx *Context, args *LookupSynonymSetOutputArgs, opts ...InvokeOption) LookupSynonymSetResultOutput

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

    public static class GetSynonymSet 
    {
        public static Task<GetSynonymSetResult> InvokeAsync(GetSynonymSetArgs args, InvokeOptions? opts = null)
        public static Output<GetSynonymSetResult> Invoke(GetSynonymSetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSynonymSetResult> getSynonymSet(GetSynonymSetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:contentwarehouse/v1:getSynonymSet
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Location string
    SynonymSetId string
    Project string
    Location string
    SynonymSetId string
    Project string
    location String
    synonymSetId String
    project String
    location string
    synonymSetId string
    project string
    location String
    synonymSetId String
    project String

    getSynonymSet Result

    The following output properties are available:

    Context string
    This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests.
    Name string
    The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
    Synonyms List<Pulumi.GoogleNative.Contentwarehouse.V1.Outputs.GoogleCloudContentwarehouseV1SynonymSetSynonymResponse>
    List of Synonyms for the context.
    Context string
    This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests.
    Name string
    The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
    Synonyms []GoogleCloudContentwarehouseV1SynonymSetSynonymResponse
    List of Synonyms for the context.
    context String
    This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests.
    name String
    The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
    synonyms List<GoogleCloudContentwarehouseV1SynonymSetSynonymResponse>
    List of Synonyms for the context.
    context string
    This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests.
    name string
    The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
    synonyms GoogleCloudContentwarehouseV1SynonymSetSynonymResponse[]
    List of Synonyms for the context.
    context str
    This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests.
    name str
    The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
    synonyms Sequence[GoogleCloudContentwarehouseV1SynonymSetSynonymResponse]
    List of Synonyms for the context.
    context String
    This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests.
    name String
    The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
    synonyms List<Property Map>
    List of Synonyms for the context.

    Supporting Types

    GoogleCloudContentwarehouseV1SynonymSetSynonymResponse

    Words List<string>
    For example: sale, invoice, bill, order
    Words []string
    For example: sale, invoice, bill, order
    words List<String>
    For example: sale, invoice, bill, order
    words string[]
    For example: sale, invoice, bill, order
    words Sequence[str]
    For example: sale, invoice, bill, order
    words List<String>
    For example: sale, invoice, bill, order

    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