Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. discoveryengine
  5. discoveryengine/v1beta
  6. Schema

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.discoveryengine/v1beta.Schema

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

    Creates a Schema.

    Create Schema Resource

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

    Constructor syntax

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

@overload
def Schema(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           collection_id: Optional[str] = None,
           data_store_id: Optional[str] = None,
           schema_id: Optional[str] = None,
           json_schema: Optional[str] = None,
           location: Optional[str] = None,
           name: Optional[str] = None,
           project: Optional[str] = None,
           struct_schema: Optional[Mapping[str, str]] = None)
    func NewSchema(ctx *Context, name string, args SchemaArgs, opts ...ResourceOption) (*Schema, error)
    public Schema(string name, SchemaArgs args, CustomResourceOptions? opts = null)
    public Schema(String name, SchemaArgs args)
public Schema(String name, SchemaArgs args, CustomResourceOptions options)

    type: google-native:discoveryengine/v1beta:Schema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Example

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

    var google_nativeSchemaResource = new GoogleNative.DiscoveryEngine.V1Beta.Schema("google-nativeSchemaResource", new()
{
    CollectionId = "string",
    DataStoreId = "string",
    SchemaId = "string",
    JsonSchema = "string",
    Location = "string",
    Name = "string",
    Project = "string",
    StructSchema = 
    {
        { "string", "string" },
    },
});

    example, err := discoveryenginev1beta.NewSchema(ctx, "google-nativeSchemaResource", &discoveryenginev1beta.SchemaArgs{
CollectionId: pulumi.String("string"),
DataStoreId: pulumi.String("string"),
SchemaId: pulumi.String("string"),
JsonSchema: pulumi.String("string"),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
StructSchema: pulumi.StringMap{
"string": pulumi.String("string"),
},
})

    var google_nativeSchemaResource = new Schema("google-nativeSchemaResource", SchemaArgs.builder()        
    .collectionId("string")
    .dataStoreId("string")
    .schemaId("string")
    .jsonSchema("string")
    .location("string")
    .name("string")
    .project("string")
    .structSchema(Map.of("string", "string"))
    .build());

    google_native_schema_resource = google_native.discoveryengine.v1beta.Schema("google-nativeSchemaResource",
    collection_id="string",
    data_store_id="string",
    schema_id="string",
    json_schema="string",
    location="string",
    name="string",
    project="string",
    struct_schema={
        "string": "string",
    })

    const google_nativeSchemaResource = new google_native.discoveryengine.v1beta.Schema("google-nativeSchemaResource", {
    collectionId: "string",
    dataStoreId: "string",
    schemaId: "string",
    jsonSchema: "string",
    location: "string",
    name: "string",
    project: "string",
    structSchema: {
        string: "string",
    },
});

    type: google-native:discoveryengine/v1beta:Schema
properties:
    collectionId: string
    dataStoreId: string
    jsonSchema: string
    location: string
    name: string
    project: string
    schemaId: string
    structSchema:
        string: string

    Schema Resource Properties

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

    Inputs

    The Schema resource accepts the following input properties:

    CollectionId string
    DataStoreId string
    SchemaId string
    Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.
    JsonSchema string
    The JSON representation of the schema.
    Location string
    Name string
    Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    Project string
    StructSchema Dictionary<string, string>
    The structured representation of the schema.
    CollectionId string
    DataStoreId string
    SchemaId string
    Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.
    JsonSchema string
    The JSON representation of the schema.
    Location string
    Name string
    Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    Project string
    StructSchema map[string]string
    The structured representation of the schema.
    collectionId String
    dataStoreId String
    schemaId String
    Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.
    jsonSchema String
    The JSON representation of the schema.
    location String
    name String
    Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    project String
    structSchema Map<String,String>
    The structured representation of the schema.
    collectionId string
    dataStoreId string
    schemaId string
    Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.
    jsonSchema string
    The JSON representation of the schema.
    location string
    name string
    Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    project string
    structSchema {[key: string]: string}
    The structured representation of the schema.
    collection_id str
    data_store_id str
    schema_id str
    Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.
    json_schema str
    The JSON representation of the schema.
    location str
    name str
    Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    project str
    struct_schema Mapping[str, str]
    The structured representation of the schema.
    collectionId String
    dataStoreId String
    schemaId String
    Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.
    jsonSchema String
    The JSON representation of the schema.
    location String
    name String
    Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
    project String
    structSchema Map<String>
    The structured representation of the schema.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Schema 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.

    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