Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. contentwarehouse
  5. contentwarehouse/v1
  6. SynonymSet

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.contentwarehouse/v1.SynonymSet

Explore with Pulumi AI

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

Creates a SynonymSet for a single context. Throws an ALREADY_EXISTS exception if a synonymset already exists for the context.

Create SynonymSet Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SynonymSet(name: string, args?: SynonymSetArgs, opts?: CustomResourceOptions);
@overload
def SynonymSet(resource_name: str,
               args: Optional[SynonymSetArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def SynonymSet(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               context: Optional[str] = None,
               location: Optional[str] = None,
               name: Optional[str] = None,
               project: Optional[str] = None,
               synonyms: Optional[Sequence[GoogleCloudContentwarehouseV1SynonymSetSynonymArgs]] = None)
func NewSynonymSet(ctx *Context, name string, args *SynonymSetArgs, opts ...ResourceOption) (*SynonymSet, error)
public SynonymSet(string name, SynonymSetArgs? args = null, CustomResourceOptions? opts = null)
public SynonymSet(String name, SynonymSetArgs args)
public SynonymSet(String name, SynonymSetArgs args, CustomResourceOptions options)

type: google-native:contentwarehouse/v1:SynonymSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SynonymSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SynonymSetArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SynonymSetArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SynonymSetArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SynonymSetArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var synonymSetResource = new GoogleNative.Contentwarehouse.V1.SynonymSet("synonymSetResource", new()
{
    Context = "string",
    Location = "string",
    Name = "string",
    Project = "string",
    Synonyms = new[]
    {
        new GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1SynonymSetSynonymArgs
        {
            Words = new[]
            {
                "string",
            },
        },
    },
});
Copy
example, err := contentwarehouse.NewSynonymSet(ctx, "synonymSetResource", &contentwarehouse.SynonymSetArgs{
	Context:  pulumi.String("string"),
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
	Synonyms: contentwarehouse.GoogleCloudContentwarehouseV1SynonymSetSynonymArray{
		&contentwarehouse.GoogleCloudContentwarehouseV1SynonymSetSynonymArgs{
			Words: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})
Copy
var synonymSetResource = new SynonymSet("synonymSetResource", SynonymSetArgs.builder()
    .context("string")
    .location("string")
    .name("string")
    .project("string")
    .synonyms(GoogleCloudContentwarehouseV1SynonymSetSynonymArgs.builder()
        .words("string")
        .build())
    .build());
Copy
synonym_set_resource = google_native.contentwarehouse.v1.SynonymSet("synonymSetResource",
    context="string",
    location="string",
    name="string",
    project="string",
    synonyms=[{
        "words": ["string"],
    }])
Copy
const synonymSetResource = new google_native.contentwarehouse.v1.SynonymSet("synonymSetResource", {
    context: "string",
    location: "string",
    name: "string",
    project: "string",
    synonyms: [{
        words: ["string"],
    }],
});
Copy
type: google-native:contentwarehouse/v1:SynonymSet
properties:
    context: string
    location: string
    name: string
    project: string
    synonyms:
        - words:
            - string
Copy

SynonymSet Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SynonymSet resource accepts the following input properties:

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.
Location Changes to this property will trigger replacement. string
Name string
The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
Project Changes to this property will trigger replacement. string
Synonyms List<Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1SynonymSetSynonym>
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.
Location Changes to this property will trigger replacement. string
Name string
The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
Project Changes to this property will trigger replacement. string
Synonyms []GoogleCloudContentwarehouseV1SynonymSetSynonymArgs
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.
location Changes to this property will trigger replacement. String
name String
The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
project Changes to this property will trigger replacement. String
synonyms List<GoogleCloudContentwarehouseV1SynonymSetSynonym>
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.
location Changes to this property will trigger replacement. string
name string
The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
project Changes to this property will trigger replacement. string
synonyms GoogleCloudContentwarehouseV1SynonymSetSynonym[]
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.
location Changes to this property will trigger replacement. str
name str
The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
project Changes to this property will trigger replacement. str
synonyms Sequence[GoogleCloudContentwarehouseV1SynonymSetSynonymArgs]
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.
location Changes to this property will trigger replacement. String
name String
The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}.
project Changes to this property will trigger replacement. String
synonyms List<Property Map>
List of Synonyms for the context.

Outputs

All input properties are implicitly available as output properties. Additionally, the SynonymSet resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

GoogleCloudContentwarehouseV1SynonymSetSynonym
, GoogleCloudContentwarehouseV1SynonymSetSynonymArgs

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

GoogleCloudContentwarehouseV1SynonymSetSynonymResponse
, GoogleCloudContentwarehouseV1SynonymSetSynonymResponseArgs

Words This property is required. List<string>
For example: sale, invoice, bill, order
Words This property is required. []string
For example: sale, invoice, bill, order
words This property is required. List<String>
For example: sale, invoice, bill, order
words This property is required. string[]
For example: sale, invoice, bill, order
words This property is required. Sequence[str]
For example: sale, invoice, bill, order
words This property is required. List<String>
For example: sale, invoice, bill, order

Package Details

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

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