1. Packages
  2. Google Cloud Native
  3. API Docs
  4. speech
  5. speech/v1
  6. CustomClass

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.speech/v1.CustomClass

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

Create a custom class.

Create CustomClass Resource

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

Constructor syntax

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

@overload
def CustomClass(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                custom_class_id: Optional[str] = None,
                items: Optional[Sequence[ClassItemArgs]] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                project: Optional[str] = None)
func NewCustomClass(ctx *Context, name string, args CustomClassArgs, opts ...ResourceOption) (*CustomClass, error)
public CustomClass(string name, CustomClassArgs args, CustomResourceOptions? opts = null)
public CustomClass(String name, CustomClassArgs args)
public CustomClass(String name, CustomClassArgs args, CustomResourceOptions options)
type: google-native:speech/v1:CustomClass
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 This property is required. CustomClassArgs
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 This property is required. CustomClassArgs
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 This property is required. CustomClassArgs
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 This property is required. CustomClassArgs
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. CustomClassArgs
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 customClassResource = new GoogleNative.Speech.V1.CustomClass("customClassResource", new()
{
    CustomClassId = "string",
    Items = new[]
    {
        new GoogleNative.Speech.V1.Inputs.ClassItemArgs
        {
            Value = "string",
        },
    },
    Location = "string",
    Name = "string",
    Project = "string",
});
Copy
example, err := speech.NewCustomClass(ctx, "customClassResource", &speech.CustomClassArgs{
	CustomClassId: pulumi.String("string"),
	Items: speech.ClassItemArray{
		&speech.ClassItemArgs{
			Value: pulumi.String("string"),
		},
	},
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Project:  pulumi.String("string"),
})
Copy
var customClassResource = new CustomClass("customClassResource", CustomClassArgs.builder()
    .customClassId("string")
    .items(ClassItemArgs.builder()
        .value("string")
        .build())
    .location("string")
    .name("string")
    .project("string")
    .build());
Copy
custom_class_resource = google_native.speech.v1.CustomClass("customClassResource",
    custom_class_id="string",
    items=[{
        "value": "string",
    }],
    location="string",
    name="string",
    project="string")
Copy
const customClassResource = new google_native.speech.v1.CustomClass("customClassResource", {
    customClassId: "string",
    items: [{
        value: "string",
    }],
    location: "string",
    name: "string",
    project: "string",
});
Copy
type: google-native:speech/v1:CustomClass
properties:
    customClassId: string
    items:
        - value: string
    location: string
    name: string
    project: string
Copy

CustomClass 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 CustomClass resource accepts the following input properties:

CustomClassId This property is required. string
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.
Items List<Pulumi.GoogleNative.Speech.V1.Inputs.ClassItem>
A collection of class items.
Location Changes to this property will trigger replacement. string
Name string
The resource name of the custom class.
Project Changes to this property will trigger replacement. string
CustomClassId This property is required. string
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.
Items []ClassItemArgs
A collection of class items.
Location Changes to this property will trigger replacement. string
Name string
The resource name of the custom class.
Project Changes to this property will trigger replacement. string
customClassId This property is required. String
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.
items List<ClassItem>
A collection of class items.
location Changes to this property will trigger replacement. String
name String
The resource name of the custom class.
project Changes to this property will trigger replacement. String
customClassId This property is required. string
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.
items ClassItem[]
A collection of class items.
location Changes to this property will trigger replacement. string
name string
The resource name of the custom class.
project Changes to this property will trigger replacement. string
custom_class_id This property is required. str
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.
items Sequence[ClassItemArgs]
A collection of class items.
location Changes to this property will trigger replacement. str
name str
The resource name of the custom class.
project Changes to this property will trigger replacement. str
customClassId This property is required. String
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.
items List<Property Map>
A collection of class items.
location Changes to this property will trigger replacement. String
name String
The resource name of the custom class.
project Changes to this property will trigger replacement. String

Outputs

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

Annotations Dictionary<string, string>
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.
DeleteTime string
The time at which this resource was requested for deletion. This field is not used.
DisplayName string
User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
Etag string
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.
ExpireTime string
The time at which this resource will be purged. This field is not used.
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyName string
The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
KmsKeyVersionName string
The KMS key version name 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}.
Reconciling bool
Whether or not this CustomClass is in the process of being updated. This field is not used.
State string
The CustomClass lifecycle state. This field is not used.
Uid string
System-assigned unique identifier for the CustomClass. This field is not used.
Annotations map[string]string
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.
DeleteTime string
The time at which this resource was requested for deletion. This field is not used.
DisplayName string
User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
Etag string
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.
ExpireTime string
The time at which this resource will be purged. This field is not used.
Id string
The provider-assigned unique ID for this managed resource.
KmsKeyName string
The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
KmsKeyVersionName string
The KMS key version name 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}.
Reconciling bool
Whether or not this CustomClass is in the process of being updated. This field is not used.
State string
The CustomClass lifecycle state. This field is not used.
Uid string
System-assigned unique identifier for the CustomClass. This field is not used.
annotations Map<String,String>
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.
deleteTime String
The time at which this resource was requested for deletion. This field is not used.
displayName String
User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
etag String
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.
expireTime String
The time at which this resource will be purged. This field is not used.
id String
The provider-assigned unique ID for this managed resource.
kmsKeyName String
The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
kmsKeyVersionName String
The KMS key version name 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}.
reconciling Boolean
Whether or not this CustomClass is in the process of being updated. This field is not used.
state String
The CustomClass lifecycle state. This field is not used.
uid String
System-assigned unique identifier for the CustomClass. This field is not used.
annotations {[key: string]: string}
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.
deleteTime string
The time at which this resource was requested for deletion. This field is not used.
displayName string
User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
etag string
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.
expireTime string
The time at which this resource will be purged. This field is not used.
id string
The provider-assigned unique ID for this managed resource.
kmsKeyName string
The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
kmsKeyVersionName string
The KMS key version name 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}.
reconciling boolean
Whether or not this CustomClass is in the process of being updated. This field is not used.
state string
The CustomClass lifecycle state. This field is not used.
uid string
System-assigned unique identifier for the CustomClass. This field is not used.
annotations Mapping[str, str]
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.
delete_time str
The time at which this resource was requested for deletion. This field is not used.
display_name str
User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
etag str
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.
expire_time str
The time at which this resource will be purged. This field is not used.
id str
The provider-assigned unique ID for this managed resource.
kms_key_name str
The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
kms_key_version_name str
The KMS key version name 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}.
reconciling bool
Whether or not this CustomClass is in the process of being updated. This field is not used.
state str
The CustomClass lifecycle state. This field is not used.
uid str
System-assigned unique identifier for the CustomClass. This field is not used.
annotations Map<String>
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.
deleteTime String
The time at which this resource was requested for deletion. This field is not used.
displayName String
User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.
etag String
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.
expireTime String
The time at which this resource will be purged. This field is not used.
id String
The provider-assigned unique ID for this managed resource.
kmsKeyName String
The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
kmsKeyVersionName String
The KMS key version name 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}.
reconciling Boolean
Whether or not this CustomClass is in the process of being updated. This field is not used.
state String
The CustomClass lifecycle state. This field is not used.
uid String
System-assigned unique identifier for the CustomClass. This field is not used.

Supporting Types

ClassItem
, ClassItemArgs

Value string
The class item's value.
Value string
The class item's value.
value String
The class item's value.
value string
The class item's value.
value str
The class item's value.
value String
The class item's value.

ClassItemResponse
, ClassItemResponseArgs

Value This property is required. string
The class item's value.
Value This property is required. string
The class item's value.
value This property is required. String
The class item's value.
value This property is required. string
The class item's value.
value This property is required. str
The class item's value.
value This property is required. String
The class item's value.

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