v1

package
v0.32.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 29, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClassItem

type ClassItem struct {
	// The class item's value.
	Value *string `pulumi:"value"`
}

An item of the class.

type ClassItemArgs

type ClassItemArgs struct {
	// The class item's value.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

An item of the class.

func (ClassItemArgs) ElementType

func (ClassItemArgs) ElementType() reflect.Type

func (ClassItemArgs) ToClassItemOutput

func (i ClassItemArgs) ToClassItemOutput() ClassItemOutput

func (ClassItemArgs) ToClassItemOutputWithContext

func (i ClassItemArgs) ToClassItemOutputWithContext(ctx context.Context) ClassItemOutput

type ClassItemArray

type ClassItemArray []ClassItemInput

func (ClassItemArray) ElementType

func (ClassItemArray) ElementType() reflect.Type

func (ClassItemArray) ToClassItemArrayOutput

func (i ClassItemArray) ToClassItemArrayOutput() ClassItemArrayOutput

func (ClassItemArray) ToClassItemArrayOutputWithContext

func (i ClassItemArray) ToClassItemArrayOutputWithContext(ctx context.Context) ClassItemArrayOutput

type ClassItemArrayInput

type ClassItemArrayInput interface {
	pulumi.Input

	ToClassItemArrayOutput() ClassItemArrayOutput
	ToClassItemArrayOutputWithContext(context.Context) ClassItemArrayOutput
}

ClassItemArrayInput is an input type that accepts ClassItemArray and ClassItemArrayOutput values. You can construct a concrete instance of `ClassItemArrayInput` via:

ClassItemArray{ ClassItemArgs{...} }

type ClassItemArrayOutput

type ClassItemArrayOutput struct{ *pulumi.OutputState }

func (ClassItemArrayOutput) ElementType

func (ClassItemArrayOutput) ElementType() reflect.Type

func (ClassItemArrayOutput) Index

func (ClassItemArrayOutput) ToClassItemArrayOutput

func (o ClassItemArrayOutput) ToClassItemArrayOutput() ClassItemArrayOutput

func (ClassItemArrayOutput) ToClassItemArrayOutputWithContext

func (o ClassItemArrayOutput) ToClassItemArrayOutputWithContext(ctx context.Context) ClassItemArrayOutput

type ClassItemInput

type ClassItemInput interface {
	pulumi.Input

	ToClassItemOutput() ClassItemOutput
	ToClassItemOutputWithContext(context.Context) ClassItemOutput
}

ClassItemInput is an input type that accepts ClassItemArgs and ClassItemOutput values. You can construct a concrete instance of `ClassItemInput` via:

ClassItemArgs{...}

type ClassItemOutput

type ClassItemOutput struct{ *pulumi.OutputState }

An item of the class.

func (ClassItemOutput) ElementType

func (ClassItemOutput) ElementType() reflect.Type

func (ClassItemOutput) ToClassItemOutput

func (o ClassItemOutput) ToClassItemOutput() ClassItemOutput

func (ClassItemOutput) ToClassItemOutputWithContext

func (o ClassItemOutput) ToClassItemOutputWithContext(ctx context.Context) ClassItemOutput

func (ClassItemOutput) Value

The class item's value.

type ClassItemResponse

type ClassItemResponse struct {
	// The class item's value.
	Value string `pulumi:"value"`
}

An item of the class.

type ClassItemResponseArrayOutput

type ClassItemResponseArrayOutput struct{ *pulumi.OutputState }

func (ClassItemResponseArrayOutput) ElementType

func (ClassItemResponseArrayOutput) Index

func (ClassItemResponseArrayOutput) ToClassItemResponseArrayOutput

func (o ClassItemResponseArrayOutput) ToClassItemResponseArrayOutput() ClassItemResponseArrayOutput

func (ClassItemResponseArrayOutput) ToClassItemResponseArrayOutputWithContext

func (o ClassItemResponseArrayOutput) ToClassItemResponseArrayOutputWithContext(ctx context.Context) ClassItemResponseArrayOutput

type ClassItemResponseOutput

type ClassItemResponseOutput struct{ *pulumi.OutputState }

An item of the class.

func (ClassItemResponseOutput) ElementType

func (ClassItemResponseOutput) ElementType() reflect.Type

func (ClassItemResponseOutput) ToClassItemResponseOutput

func (o ClassItemResponseOutput) ToClassItemResponseOutput() ClassItemResponseOutput

func (ClassItemResponseOutput) ToClassItemResponseOutputWithContext

func (o ClassItemResponseOutput) ToClassItemResponseOutputWithContext(ctx context.Context) ClassItemResponseOutput

func (ClassItemResponseOutput) Value

The class item's value.

type CustomClass

type CustomClass struct {
	pulumi.CustomResourceState

	// Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
	Annotations pulumi.StringMapOutput `pulumi:"annotations"`
	// If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
	CustomClassId pulumi.StringOutput `pulumi:"customClassId"`
	// The time at which this resource was requested for deletion. This field is not used.
	DeleteTime pulumi.StringOutput `pulumi:"deleteTime"`
	// User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
	Etag pulumi.StringOutput `pulumi:"etag"`
	// The time at which this resource will be purged. This field is not used.
	ExpireTime pulumi.StringOutput `pulumi:"expireTime"`
	// A collection of class items.
	Items ClassItemResponseArrayOutput `pulumi:"items"`
	// The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
	KmsKeyName pulumi.StringOutput `pulumi:"kmsKeyName"`
	// The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
	KmsKeyVersionName pulumi.StringOutput `pulumi:"kmsKeyVersionName"`
	Location          pulumi.StringOutput `pulumi:"location"`
	// The resource name of the custom class.
	Name    pulumi.StringOutput `pulumi:"name"`
	Project pulumi.StringOutput `pulumi:"project"`
	// Whether or not this CustomClass is in the process of being updated. This field is not used.
	Reconciling pulumi.BoolOutput `pulumi:"reconciling"`
	// The CustomClass lifecycle state. This field is not used.
	State pulumi.StringOutput `pulumi:"state"`
	// System-assigned unique identifier for the CustomClass. This field is not used.
	Uid pulumi.StringOutput `pulumi:"uid"`
}

Create a custom class.

func GetCustomClass

func GetCustomClass(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CustomClassState, opts ...pulumi.ResourceOption) (*CustomClass, error)

GetCustomClass gets an existing CustomClass resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCustomClass

func NewCustomClass(ctx *pulumi.Context,
	name string, args *CustomClassArgs, opts ...pulumi.ResourceOption) (*CustomClass, error)

NewCustomClass registers a new resource with the given unique name, arguments, and options.

func (*CustomClass) ElementType

func (*CustomClass) ElementType() reflect.Type

func (*CustomClass) ToCustomClassOutput

func (i *CustomClass) ToCustomClassOutput() CustomClassOutput

func (*CustomClass) ToCustomClassOutputWithContext

func (i *CustomClass) ToCustomClassOutputWithContext(ctx context.Context) CustomClassOutput

type CustomClassArgs

type CustomClassArgs struct {
	// The ID to use for the custom class, which will become the final component of the custom class' resource name. This value should restrict to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and be 4-63 characters.
	CustomClassId pulumi.StringInput
	// A collection of class items.
	Items    ClassItemArrayInput
	Location pulumi.StringPtrInput
	// The resource name of the custom class.
	Name    pulumi.StringPtrInput
	Project pulumi.StringPtrInput
}

The set of arguments for constructing a CustomClass resource.

func (CustomClassArgs) ElementType

func (CustomClassArgs) ElementType() reflect.Type

type CustomClassInput

type CustomClassInput interface {
	pulumi.Input

	ToCustomClassOutput() CustomClassOutput
	ToCustomClassOutputWithContext(ctx context.Context) CustomClassOutput
}

type CustomClassOutput

type CustomClassOutput struct{ *pulumi.OutputState }

func (CustomClassOutput) Annotations added in v0.32.0

func (o CustomClassOutput) Annotations() pulumi.StringMapOutput

Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.

func (CustomClassOutput) CustomClassId added in v0.19.0

func (o CustomClassOutput) CustomClassId() pulumi.StringOutput

If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.

func (CustomClassOutput) DeleteTime added in v0.32.0

func (o CustomClassOutput) DeleteTime() pulumi.StringOutput

The time at which this resource was requested for deletion. This field is not used.

func (CustomClassOutput) DisplayName added in v0.32.0

func (o CustomClassOutput) DisplayName() pulumi.StringOutput

User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.

func (CustomClassOutput) ElementType

func (CustomClassOutput) ElementType() reflect.Type

func (CustomClassOutput) Etag added in v0.32.0

This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.

func (CustomClassOutput) ExpireTime added in v0.32.0

func (o CustomClassOutput) ExpireTime() pulumi.StringOutput

The time at which this resource will be purged. This field is not used.

func (CustomClassOutput) Items added in v0.19.0

A collection of class items.

func (CustomClassOutput) KmsKeyName added in v0.31.1

func (o CustomClassOutput) KmsKeyName() pulumi.StringOutput

The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

func (CustomClassOutput) KmsKeyVersionName added in v0.31.1

func (o CustomClassOutput) KmsKeyVersionName() pulumi.StringOutput

The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

func (CustomClassOutput) Location added in v0.21.0

func (o CustomClassOutput) Location() pulumi.StringOutput

func (CustomClassOutput) Name added in v0.19.0

The resource name of the custom class.

func (CustomClassOutput) Project added in v0.21.0

func (CustomClassOutput) Reconciling added in v0.32.0

func (o CustomClassOutput) Reconciling() pulumi.BoolOutput

Whether or not this CustomClass is in the process of being updated. This field is not used.

func (CustomClassOutput) State added in v0.32.0

The CustomClass lifecycle state. This field is not used.

func (CustomClassOutput) ToCustomClassOutput

func (o CustomClassOutput) ToCustomClassOutput() CustomClassOutput

func (CustomClassOutput) ToCustomClassOutputWithContext

func (o CustomClassOutput) ToCustomClassOutputWithContext(ctx context.Context) CustomClassOutput

func (CustomClassOutput) Uid added in v0.32.0

System-assigned unique identifier for the CustomClass. This field is not used.

type CustomClassState

type CustomClassState struct {
}

func (CustomClassState) ElementType

func (CustomClassState) ElementType() reflect.Type

type LookupCustomClassArgs

type LookupCustomClassArgs struct {
	CustomClassId string  `pulumi:"customClassId"`
	Location      string  `pulumi:"location"`
	Project       *string `pulumi:"project"`
}

type LookupCustomClassOutputArgs

type LookupCustomClassOutputArgs struct {
	CustomClassId pulumi.StringInput    `pulumi:"customClassId"`
	Location      pulumi.StringInput    `pulumi:"location"`
	Project       pulumi.StringPtrInput `pulumi:"project"`
}

func (LookupCustomClassOutputArgs) ElementType

type LookupCustomClassResult

type LookupCustomClassResult struct {
	// Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
	Annotations map[string]string `pulumi:"annotations"`
	// If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
	CustomClassId string `pulumi:"customClassId"`
	// The time at which this resource was requested for deletion. This field is not used.
	DeleteTime string `pulumi:"deleteTime"`
	// User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
	DisplayName string `pulumi:"displayName"`
	// This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
	Etag string `pulumi:"etag"`
	// The time at which this resource will be purged. This field is not used.
	ExpireTime string `pulumi:"expireTime"`
	// A collection of class items.
	Items []ClassItemResponse `pulumi:"items"`
	// The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
	KmsKeyName string `pulumi:"kmsKeyName"`
	// The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
	KmsKeyVersionName string `pulumi:"kmsKeyVersionName"`
	// The resource name of the custom class.
	Name string `pulumi:"name"`
	// Whether or not this CustomClass is in the process of being updated. This field is not used.
	Reconciling bool `pulumi:"reconciling"`
	// The CustomClass lifecycle state. This field is not used.
	State string `pulumi:"state"`
	// System-assigned unique identifier for the CustomClass. This field is not used.
	Uid string `pulumi:"uid"`
}

func LookupCustomClass

func LookupCustomClass(ctx *pulumi.Context, args *LookupCustomClassArgs, opts ...pulumi.InvokeOption) (*LookupCustomClassResult, error)

Get a custom class.

type LookupCustomClassResultOutput

type LookupCustomClassResultOutput struct{ *pulumi.OutputState }

func (LookupCustomClassResultOutput) Annotations added in v0.32.0

Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.

func (LookupCustomClassResultOutput) CustomClassId

If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.

func (LookupCustomClassResultOutput) DeleteTime added in v0.32.0

The time at which this resource was requested for deletion. This field is not used.

func (LookupCustomClassResultOutput) DisplayName added in v0.32.0

User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.

func (LookupCustomClassResultOutput) ElementType

func (LookupCustomClassResultOutput) Etag added in v0.32.0

This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.

func (LookupCustomClassResultOutput) ExpireTime added in v0.32.0

The time at which this resource will be purged. This field is not used.

func (LookupCustomClassResultOutput) Items

A collection of class items.

func (LookupCustomClassResultOutput) KmsKeyName added in v0.31.1

The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

func (LookupCustomClassResultOutput) KmsKeyVersionName added in v0.31.1

func (o LookupCustomClassResultOutput) KmsKeyVersionName() pulumi.StringOutput

The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

func (LookupCustomClassResultOutput) Name

The resource name of the custom class.

func (LookupCustomClassResultOutput) Reconciling added in v0.32.0

Whether or not this CustomClass is in the process of being updated. This field is not used.

func (LookupCustomClassResultOutput) State added in v0.32.0

The CustomClass lifecycle state. This field is not used.

func (LookupCustomClassResultOutput) ToLookupCustomClassResultOutput

func (o LookupCustomClassResultOutput) ToLookupCustomClassResultOutput() LookupCustomClassResultOutput

func (LookupCustomClassResultOutput) ToLookupCustomClassResultOutputWithContext

func (o LookupCustomClassResultOutput) ToLookupCustomClassResultOutputWithContext(ctx context.Context) LookupCustomClassResultOutput

func (LookupCustomClassResultOutput) Uid added in v0.32.0

System-assigned unique identifier for the CustomClass. This field is not used.

type LookupPhraseSetArgs

type LookupPhraseSetArgs struct {
	Location    string  `pulumi:"location"`
	PhraseSetId string  `pulumi:"phraseSetId"`
	Project     *string `pulumi:"project"`
}

type LookupPhraseSetOutputArgs

type LookupPhraseSetOutputArgs struct {
	Location    pulumi.StringInput    `pulumi:"location"`
	PhraseSetId pulumi.StringInput    `pulumi:"phraseSetId"`
	Project     pulumi.StringPtrInput `pulumi:"project"`
}

func (LookupPhraseSetOutputArgs) ElementType

func (LookupPhraseSetOutputArgs) ElementType() reflect.Type

type LookupPhraseSetResult

type LookupPhraseSetResult struct {
	// Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
	Annotations map[string]string `pulumi:"annotations"`
	// Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
	Boost float64 `pulumi:"boost"`
	// The time at which this resource was requested for deletion. This field is not used.
	DeleteTime string `pulumi:"deleteTime"`
	// User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
	DisplayName string `pulumi:"displayName"`
	// This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
	Etag string `pulumi:"etag"`
	// The time at which this resource will be purged. This field is not used.
	ExpireTime string `pulumi:"expireTime"`
	// The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
	KmsKeyName string `pulumi:"kmsKeyName"`
	// The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
	KmsKeyVersionName string `pulumi:"kmsKeyVersionName"`
	// The resource name of the phrase set.
	Name string `pulumi:"name"`
	// A list of word and phrases.
	Phrases []PhraseResponse `pulumi:"phrases"`
	// Whether or not this PhraseSet is in the process of being updated. This field is not used.
	Reconciling bool `pulumi:"reconciling"`
	// The CustomClass lifecycle state. This field is not used.
	State string `pulumi:"state"`
	// System-assigned unique identifier for the PhraseSet. This field is not used.
	Uid string `pulumi:"uid"`
}

func LookupPhraseSet

func LookupPhraseSet(ctx *pulumi.Context, args *LookupPhraseSetArgs, opts ...pulumi.InvokeOption) (*LookupPhraseSetResult, error)

Get a phrase set.

type LookupPhraseSetResultOutput

type LookupPhraseSetResultOutput struct{ *pulumi.OutputState }

func (LookupPhraseSetResultOutput) Annotations added in v0.32.0

Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.

func (LookupPhraseSetResultOutput) Boost

Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.

func (LookupPhraseSetResultOutput) DeleteTime added in v0.32.0

The time at which this resource was requested for deletion. This field is not used.

func (LookupPhraseSetResultOutput) DisplayName added in v0.32.0

User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.

func (LookupPhraseSetResultOutput) ElementType

func (LookupPhraseSetResultOutput) Etag added in v0.32.0

This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.

func (LookupPhraseSetResultOutput) ExpireTime added in v0.32.0

The time at which this resource will be purged. This field is not used.

func (LookupPhraseSetResultOutput) KmsKeyName added in v0.31.1

The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

func (LookupPhraseSetResultOutput) KmsKeyVersionName added in v0.31.1

func (o LookupPhraseSetResultOutput) KmsKeyVersionName() pulumi.StringOutput

The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

func (LookupPhraseSetResultOutput) Name

The resource name of the phrase set.

func (LookupPhraseSetResultOutput) Phrases

A list of word and phrases.

func (LookupPhraseSetResultOutput) Reconciling added in v0.32.0

Whether or not this PhraseSet is in the process of being updated. This field is not used.

func (LookupPhraseSetResultOutput) State added in v0.32.0

The CustomClass lifecycle state. This field is not used.

func (LookupPhraseSetResultOutput) ToLookupPhraseSetResultOutput

func (o LookupPhraseSetResultOutput) ToLookupPhraseSetResultOutput() LookupPhraseSetResultOutput

func (LookupPhraseSetResultOutput) ToLookupPhraseSetResultOutputWithContext

func (o LookupPhraseSetResultOutput) ToLookupPhraseSetResultOutputWithContext(ctx context.Context) LookupPhraseSetResultOutput

func (LookupPhraseSetResultOutput) Uid added in v0.32.0

System-assigned unique identifier for the PhraseSet. This field is not used.

type Phrase

type Phrase struct {
	// Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
	Boost *float64 `pulumi:"boost"`
	// The phrase itself.
	Value *string `pulumi:"value"`
}

A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

type PhraseArgs

type PhraseArgs struct {
	// Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
	Boost pulumi.Float64PtrInput `pulumi:"boost"`
	// The phrase itself.
	Value pulumi.StringPtrInput `pulumi:"value"`
}

A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (PhraseArgs) ElementType

func (PhraseArgs) ElementType() reflect.Type

func (PhraseArgs) ToPhraseOutput

func (i PhraseArgs) ToPhraseOutput() PhraseOutput

func (PhraseArgs) ToPhraseOutputWithContext

func (i PhraseArgs) ToPhraseOutputWithContext(ctx context.Context) PhraseOutput

type PhraseArray

type PhraseArray []PhraseInput

func (PhraseArray) ElementType

func (PhraseArray) ElementType() reflect.Type

func (PhraseArray) ToPhraseArrayOutput

func (i PhraseArray) ToPhraseArrayOutput() PhraseArrayOutput

func (PhraseArray) ToPhraseArrayOutputWithContext

func (i PhraseArray) ToPhraseArrayOutputWithContext(ctx context.Context) PhraseArrayOutput

type PhraseArrayInput

type PhraseArrayInput interface {
	pulumi.Input

	ToPhraseArrayOutput() PhraseArrayOutput
	ToPhraseArrayOutputWithContext(context.Context) PhraseArrayOutput
}

PhraseArrayInput is an input type that accepts PhraseArray and PhraseArrayOutput values. You can construct a concrete instance of `PhraseArrayInput` via:

PhraseArray{ PhraseArgs{...} }

type PhraseArrayOutput

type PhraseArrayOutput struct{ *pulumi.OutputState }

func (PhraseArrayOutput) ElementType

func (PhraseArrayOutput) ElementType() reflect.Type

func (PhraseArrayOutput) Index

func (PhraseArrayOutput) ToPhraseArrayOutput

func (o PhraseArrayOutput) ToPhraseArrayOutput() PhraseArrayOutput

func (PhraseArrayOutput) ToPhraseArrayOutputWithContext

func (o PhraseArrayOutput) ToPhraseArrayOutputWithContext(ctx context.Context) PhraseArrayOutput

type PhraseInput

type PhraseInput interface {
	pulumi.Input

	ToPhraseOutput() PhraseOutput
	ToPhraseOutputWithContext(context.Context) PhraseOutput
}

PhraseInput is an input type that accepts PhraseArgs and PhraseOutput values. You can construct a concrete instance of `PhraseInput` via:

PhraseArgs{...}

type PhraseOutput

type PhraseOutput struct{ *pulumi.OutputState }

A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (PhraseOutput) Boost

Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.

func (PhraseOutput) ElementType

func (PhraseOutput) ElementType() reflect.Type

func (PhraseOutput) ToPhraseOutput

func (o PhraseOutput) ToPhraseOutput() PhraseOutput

func (PhraseOutput) ToPhraseOutputWithContext

func (o PhraseOutput) ToPhraseOutputWithContext(ctx context.Context) PhraseOutput

func (PhraseOutput) Value

The phrase itself.

type PhraseResponse

type PhraseResponse struct {
	// Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
	Boost float64 `pulumi:"boost"`
	// The phrase itself.
	Value string `pulumi:"value"`
}

A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

type PhraseResponseArrayOutput

type PhraseResponseArrayOutput struct{ *pulumi.OutputState }

func (PhraseResponseArrayOutput) ElementType

func (PhraseResponseArrayOutput) ElementType() reflect.Type

func (PhraseResponseArrayOutput) Index

func (PhraseResponseArrayOutput) ToPhraseResponseArrayOutput

func (o PhraseResponseArrayOutput) ToPhraseResponseArrayOutput() PhraseResponseArrayOutput

func (PhraseResponseArrayOutput) ToPhraseResponseArrayOutputWithContext

func (o PhraseResponseArrayOutput) ToPhraseResponseArrayOutputWithContext(ctx context.Context) PhraseResponseArrayOutput

type PhraseResponseOutput

type PhraseResponseOutput struct{ *pulumi.OutputState }

A phrases containing words and phrase "hints" so that the speech recognition is more likely to recognize them. This can be used to improve the accuracy for specific words and phrases, for example, if specific commands are typically spoken by the user. This can also be used to add additional words to the vocabulary of the recognizer. See [usage limits](https://cloud.google.com/speech-to-text/quotas#content). List items can also include pre-built or custom classes containing groups of words that represent common concepts that occur in natural language. For example, rather than providing a phrase hint for every month of the year (e.g. "i was born in january", "i was born in febuary", ...), use the pre-built `$MONTH` class improves the likelihood of correctly transcribing audio that includes months (e.g. "i was born in $month"). To refer to pre-built classes, use the class' symbol prepended with `$` e.g. `$MONTH`. To refer to custom classes that were defined inline in the request, set the class's `custom_class_id` to a string unique to all class resources and inline classes. Then use the class' id wrapped in $`{...}` e.g. "${my-months}". To refer to custom classes resources, use the class' id wrapped in `${}` (e.g. `${my-months}`). Speech-to-Text supports three locations: `global`, `us` (US North America), and `eu` (Europe). If you are calling the `speech.googleapis.com` endpoint, use the `global` location. To specify a region, use a [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints) with matching `us` or `eu` location value.

func (PhraseResponseOutput) Boost

Hint Boost. Overrides the boost set at the phrase set level. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.

func (PhraseResponseOutput) ElementType

func (PhraseResponseOutput) ElementType() reflect.Type

func (PhraseResponseOutput) ToPhraseResponseOutput

func (o PhraseResponseOutput) ToPhraseResponseOutput() PhraseResponseOutput

func (PhraseResponseOutput) ToPhraseResponseOutputWithContext

func (o PhraseResponseOutput) ToPhraseResponseOutputWithContext(ctx context.Context) PhraseResponseOutput

func (PhraseResponseOutput) Value

The phrase itself.

type PhraseSet

type PhraseSet struct {
	pulumi.CustomResourceState

	// Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.
	Annotations pulumi.StringMapOutput `pulumi:"annotations"`
	// Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
	Boost pulumi.Float64Output `pulumi:"boost"`
	// The time at which this resource was requested for deletion. This field is not used.
	DeleteTime pulumi.StringOutput `pulumi:"deleteTime"`
	// User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.
	Etag pulumi.StringOutput `pulumi:"etag"`
	// The time at which this resource will be purged. This field is not used.
	ExpireTime pulumi.StringOutput `pulumi:"expireTime"`
	// The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
	KmsKeyName pulumi.StringOutput `pulumi:"kmsKeyName"`
	// The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
	KmsKeyVersionName pulumi.StringOutput `pulumi:"kmsKeyVersionName"`
	Location          pulumi.StringOutput `pulumi:"location"`
	// The resource name of the phrase set.
	Name pulumi.StringOutput `pulumi:"name"`
	// A list of word and phrases.
	Phrases PhraseResponseArrayOutput `pulumi:"phrases"`
	Project pulumi.StringOutput       `pulumi:"project"`
	// Whether or not this PhraseSet is in the process of being updated. This field is not used.
	Reconciling pulumi.BoolOutput `pulumi:"reconciling"`
	// The CustomClass lifecycle state. This field is not used.
	State pulumi.StringOutput `pulumi:"state"`
	// System-assigned unique identifier for the PhraseSet. This field is not used.
	Uid pulumi.StringOutput `pulumi:"uid"`
}

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

func GetPhraseSet

func GetPhraseSet(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PhraseSetState, opts ...pulumi.ResourceOption) (*PhraseSet, error)

GetPhraseSet gets an existing PhraseSet resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewPhraseSet

func NewPhraseSet(ctx *pulumi.Context,
	name string, args *PhraseSetArgs, opts ...pulumi.ResourceOption) (*PhraseSet, error)

NewPhraseSet registers a new resource with the given unique name, arguments, and options.

func (*PhraseSet) ElementType

func (*PhraseSet) ElementType() reflect.Type

func (*PhraseSet) ToPhraseSetOutput

func (i *PhraseSet) ToPhraseSetOutput() PhraseSetOutput

func (*PhraseSet) ToPhraseSetOutputWithContext

func (i *PhraseSet) ToPhraseSetOutputWithContext(ctx context.Context) PhraseSetOutput

type PhraseSetArgs

type PhraseSetArgs struct {
	// Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
	Boost    pulumi.Float64PtrInput
	Location pulumi.StringPtrInput
	// The resource name of the phrase set.
	Name pulumi.StringPtrInput
	// The ID to use for the phrase set, which will become the final component of the phrase set's resource name. This value should restrict to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and be 4-63 characters.
	PhraseSetId pulumi.StringInput
	// A list of word and phrases.
	Phrases PhraseArrayInput
	Project pulumi.StringPtrInput
}

The set of arguments for constructing a PhraseSet resource.

func (PhraseSetArgs) ElementType

func (PhraseSetArgs) ElementType() reflect.Type

type PhraseSetInput

type PhraseSetInput interface {
	pulumi.Input

	ToPhraseSetOutput() PhraseSetOutput
	ToPhraseSetOutputWithContext(ctx context.Context) PhraseSetOutput
}

type PhraseSetOutput

type PhraseSetOutput struct{ *pulumi.OutputState }

func (PhraseSetOutput) Annotations added in v0.32.0

func (o PhraseSetOutput) Annotations() pulumi.StringMapOutput

Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.

func (PhraseSetOutput) Boost added in v0.19.0

Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Negative boost values would correspond to anti-biasing. Anti-biasing is not enabled, so negative boost will simply be ignored. Though `boost` can accept a wide range of positive values, most use cases are best served with values between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.

func (PhraseSetOutput) DeleteTime added in v0.32.0

func (o PhraseSetOutput) DeleteTime() pulumi.StringOutput

The time at which this resource was requested for deletion. This field is not used.

func (PhraseSetOutput) DisplayName added in v0.32.0

func (o PhraseSetOutput) DisplayName() pulumi.StringOutput

User-settable, human-readable name for the PhraseSet. Must be 63 characters or less. This field is not used.

func (PhraseSetOutput) ElementType

func (PhraseSetOutput) ElementType() reflect.Type

func (PhraseSetOutput) Etag added in v0.32.0

This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.

func (PhraseSetOutput) ExpireTime added in v0.32.0

func (o PhraseSetOutput) ExpireTime() pulumi.StringOutput

The time at which this resource will be purged. This field is not used.

func (PhraseSetOutput) KmsKeyName added in v0.31.1

func (o PhraseSetOutput) KmsKeyName() pulumi.StringOutput

The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

func (PhraseSetOutput) KmsKeyVersionName added in v0.31.1

func (o PhraseSetOutput) KmsKeyVersionName() pulumi.StringOutput

The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

func (PhraseSetOutput) Location added in v0.21.0

func (o PhraseSetOutput) Location() pulumi.StringOutput

func (PhraseSetOutput) Name added in v0.19.0

The resource name of the phrase set.

func (PhraseSetOutput) Phrases added in v0.19.0

A list of word and phrases.

func (PhraseSetOutput) Project added in v0.21.0

func (o PhraseSetOutput) Project() pulumi.StringOutput

func (PhraseSetOutput) Reconciling added in v0.32.0

func (o PhraseSetOutput) Reconciling() pulumi.BoolOutput

Whether or not this PhraseSet is in the process of being updated. This field is not used.

func (PhraseSetOutput) State added in v0.32.0

The CustomClass lifecycle state. This field is not used.

func (PhraseSetOutput) ToPhraseSetOutput

func (o PhraseSetOutput) ToPhraseSetOutput() PhraseSetOutput

func (PhraseSetOutput) ToPhraseSetOutputWithContext

func (o PhraseSetOutput) ToPhraseSetOutputWithContext(ctx context.Context) PhraseSetOutput

func (PhraseSetOutput) Uid added in v0.32.0

System-assigned unique identifier for the PhraseSet. This field is not used.

type PhraseSetState

type PhraseSetState struct {
}

func (PhraseSetState) ElementType

func (PhraseSetState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL