1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. getSchema
Viewing docs for googleworkspace 0.7.0
published on Wednesday, Jan 15, 2025 by hashicorp
Schema (JSON)
hashicorp/terraform-provider-googleworkspace

googleworkspace.getSchema

googleworkspace logo
Viewing docs for googleworkspace 0.7.0
published on Wednesday, Jan 15, 2025 by hashicorp
Schema (JSON)
hashicorp/terraform-provider-googleworkspace

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as googleworkspace from "@pulumi/googleworkspace";

const birthday = googleworkspace.getSchema({
    schemaName: "birthday",
});
export const schemaDisplayName = birthday.then(birthday => birthday.displayName);

    import pulumi
import pulumi_googleworkspace as googleworkspace

birthday = googleworkspace.get_schema(schema_name="birthday")
pulumi.export("schemaDisplayName", birthday.display_name)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/googleworkspace/googleworkspace"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		birthday, err := googleworkspace.LookupSchema(ctx, &googleworkspace.LookupSchemaArgs{
			SchemaName: pulumi.StringRef("birthday"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("schemaDisplayName", birthday.DisplayName)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Googleworkspace = Pulumi.Googleworkspace;

return await Deployment.RunAsync(() => 
{
    var birthday = Googleworkspace.GetSchema.Invoke(new()
    {
        SchemaName = "birthday",
    });

    return new Dictionary<string, object?>
    {
        ["schemaDisplayName"] = birthday.Apply(getSchemaResult => getSchemaResult.DisplayName),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.googleworkspace.GoogleworkspaceFunctions;
import com.pulumi.googleworkspace.inputs.GetSchemaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var birthday = GoogleworkspaceFunctions.getSchema(GetSchemaArgs.builder()
            .schemaName("birthday")
            .build());

        ctx.export("schemaDisplayName", birthday.applyValue(getSchemaResult -> getSchemaResult.displayName()));
    }
}

    variables:
  birthday:
    fn::invoke:
      function: googleworkspace:getSchema
      arguments:
        schemaName: birthday
outputs:
  schemaDisplayName: ${birthday.displayName}

    Using getSchema

    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 getSchema(args: GetSchemaArgs, opts?: InvokeOptions): Promise<GetSchemaResult>
function getSchemaOutput(args: GetSchemaOutputArgs, opts?: InvokeOptions): Output<GetSchemaResult>
    def get_schema(schema_id: Optional[str] = None,
               schema_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSchemaResult
def get_schema_output(schema_id: Optional[pulumi.Input[str]] = None,
               schema_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSchemaResult]
    func LookupSchema(ctx *Context, args *LookupSchemaArgs, opts ...InvokeOption) (*LookupSchemaResult, error)
func LookupSchemaOutput(ctx *Context, args *LookupSchemaOutputArgs, opts ...InvokeOption) LookupSchemaResultOutput

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

    public static class GetSchema 
{
    public static Task<GetSchemaResult> InvokeAsync(GetSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemaResult> Invoke(GetSchemaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
public static Output<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)

    fn::invoke:
  function: googleworkspace:index/getSchema:getSchema
  arguments:
    # arguments dictionary

    The following arguments are supported:

    SchemaId string
    The unique identifier of the schema.
    SchemaName string
    The schema's name.
    SchemaId string
    The unique identifier of the schema.
    SchemaName string
    The schema's name.
    schemaId String
    The unique identifier of the schema.
    schemaName String
    The schema's name.
    schemaId string
    The unique identifier of the schema.
    schemaName string
    The schema's name.
    schema_id str
    The unique identifier of the schema.
    schema_name str
    The schema's name.
    schemaId String
    The unique identifier of the schema.
    schemaName String
    The schema's name.

    getSchema Result

    The following output properties are available:

    DisplayName string
    Display name for the schema.
    Etag string
    ETag of the resource.
    Fields List<GetSchemaField>
    A list of fields in the schema.
    Id string
    The ID of this resource.
    SchemaId string
    The unique identifier of the schema.
    SchemaName string
    The schema's name.
    DisplayName string
    Display name for the schema.
    Etag string
    ETag of the resource.
    Fields []GetSchemaField
    A list of fields in the schema.
    Id string
    The ID of this resource.
    SchemaId string
    The unique identifier of the schema.
    SchemaName string
    The schema's name.
    displayName String
    Display name for the schema.
    etag String
    ETag of the resource.
    fields List<GetSchemaField>
    A list of fields in the schema.
    id String
    The ID of this resource.
    schemaId String
    The unique identifier of the schema.
    schemaName String
    The schema's name.
    displayName string
    Display name for the schema.
    etag string
    ETag of the resource.
    fields GetSchemaField[]
    A list of fields in the schema.
    id string
    The ID of this resource.
    schemaId string
    The unique identifier of the schema.
    schemaName string
    The schema's name.
    display_name str
    Display name for the schema.
    etag str
    ETag of the resource.
    fields Sequence[GetSchemaField]
    A list of fields in the schema.
    id str
    The ID of this resource.
    schema_id str
    The unique identifier of the schema.
    schema_name str
    The schema's name.
    displayName String
    Display name for the schema.
    etag String
    ETag of the resource.
    fields List<Property Map>
    A list of fields in the schema.
    id String
    The ID of this resource.
    schemaId String
    The unique identifier of the schema.
    schemaName String
    The schema's name.

    Supporting Types

    GetSchemaField

    GetSchemaFieldNumericIndexingSpec

    MaxValue double
    MinValue double
    MaxValue float64
    MinValue float64
    maxValue Double
    minValue Double
    maxValue number
    minValue number
    max_value float
    min_value float
    maxValue Number
    minValue Number

    Package Details

    Repository
    googleworkspace hashicorp/terraform-provider-googleworkspace
    License
    Notes
    This Pulumi package is based on the googleworkspace Terraform Provider.
    googleworkspace logo
    Viewing docs for googleworkspace 0.7.0
    published on Wednesday, Jan 15, 2025 by hashicorp
    Schema (JSON)
    hashicorp/terraform-provider-googleworkspace
      Try Pulumi Cloud free. Your team will thank you.