Confluent v1.26.0, Sep 28 23

Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

confluentcloud.getSchema

Explore with Pulumi AI

Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

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(credentials: Optional[GetSchemaCredentials] = None,
               rest_endpoint: Optional[str] = None,
               schema_identifier: Optional[int] = None,
               schema_registry_cluster: Optional[GetSchemaSchemaRegistryCluster] = None,
               subject_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSchemaResult
def get_schema_output(credentials: Optional[pulumi.Input[GetSchemaCredentialsArgs]] = None,
               rest_endpoint: Optional[pulumi.Input[str]] = None,
               schema_identifier: Optional[pulumi.Input[int]] = None,
               schema_registry_cluster: Optional[pulumi.Input[GetSchemaSchemaRegistryClusterArgs]] = None,
               subject_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)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

SchemaIdentifier int: The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
SubjectName string: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
Credentials Pulumi.ConfluentCloud.Inputs.GetSchemaCredentials
RestEndpoint string: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster Pulumi.ConfluentCloud.Inputs.GetSchemaSchemaRegistryCluster

SchemaIdentifier int: The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
SubjectName string: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
Credentials GetSchemaCredentials
RestEndpoint string: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster GetSchemaSchemaRegistryCluster

schemaIdentifier Integer: The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
subjectName String: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
credentials GetSchemaCredentials
restEndpoint String: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster GetSchemaSchemaRegistryCluster

schemaIdentifier number: The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
subjectName string: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
credentials GetSchemaCredentials
restEndpoint string: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster GetSchemaSchemaRegistryCluster

schema_identifier int: The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
subject_name str: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
credentials GetSchemaCredentials
rest_endpoint str: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schema_registry_cluster GetSchemaSchemaRegistryCluster

schemaIdentifier Number: The globally unique ID of the Schema, for example, 100003. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects.
Note: A Schema Registry API key consists of a key and a secret. Schema Registry API keys are required to interact with Schema Registry clusters in Confluent Cloud. Each Schema Registry API key is valid for one specific Schema Registry cluster.
subjectName String: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
credentials Property Map
restEndpoint String: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster Property Map

getSchema Result

The following output properties are available:

Format string: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
HardDelete bool
Id string: The provider-assigned unique ID for this managed resource.
RecreateOnUpdate bool
Schema string: (Required String) The schema string, for example, file("./schema_version_1.avsc").
SchemaIdentifier int
SchemaReferences List<Pulumi.ConfluentCloud.Outputs.GetSchemaSchemaReference>: (Optional List) The list of referenced schemas (see Schema References for more details):
SubjectName string: (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
Version int: (Required Integer) The version of the Schema, for example, 4.
Credentials Pulumi.ConfluentCloud.Outputs.GetSchemaCredentials
RestEndpoint string
SchemaRegistryCluster Pulumi.ConfluentCloud.Outputs.GetSchemaSchemaRegistryCluster

Format string: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
HardDelete bool
Id string: The provider-assigned unique ID for this managed resource.
RecreateOnUpdate bool
Schema string: (Required String) The schema string, for example, file("./schema_version_1.avsc").
SchemaIdentifier int
SchemaReferences []GetSchemaSchemaReference: (Optional List) The list of referenced schemas (see Schema References for more details):
SubjectName string: (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
Version int: (Required Integer) The version of the Schema, for example, 4.
Credentials GetSchemaCredentials
RestEndpoint string
SchemaRegistryCluster GetSchemaSchemaRegistryCluster

format String: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
hardDelete Boolean
id String: The provider-assigned unique ID for this managed resource.
recreateOnUpdate Boolean
schema String: (Required String) The schema string, for example, file("./schema_version_1.avsc").
schemaIdentifier Integer
schemaReferences List<GetSchemaSchemaReference>: (Optional List) The list of referenced schemas (see Schema References for more details):
subjectName String: (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
version Integer: (Required Integer) The version of the Schema, for example, 4.
credentials GetSchemaCredentials
restEndpoint String
schemaRegistryCluster GetSchemaSchemaRegistryCluster

format string: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
hardDelete boolean
id string: The provider-assigned unique ID for this managed resource.
recreateOnUpdate boolean
schema string: (Required String) The schema string, for example, file("./schema_version_1.avsc").
schemaIdentifier number
schemaReferences GetSchemaSchemaReference[]: (Optional List) The list of referenced schemas (see Schema References for more details):
subjectName string: (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
version number: (Required Integer) The version of the Schema, for example, 4.
credentials GetSchemaCredentials
restEndpoint string
schemaRegistryCluster GetSchemaSchemaRegistryCluster

format str: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
hard_delete bool
id str: The provider-assigned unique ID for this managed resource.
recreate_on_update bool
schema str: (Required String) The schema string, for example, file("./schema_version_1.avsc").
schema_identifier int
schema_references Sequence[GetSchemaSchemaReference]: (Optional List) The list of referenced schemas (see Schema References for more details):
subject_name str: (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
version int: (Required Integer) The version of the Schema, for example, 4.
credentials GetSchemaCredentials
rest_endpoint str
schema_registry_cluster GetSchemaSchemaRegistryCluster

format String: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
hardDelete Boolean
id String: The provider-assigned unique ID for this managed resource.
recreateOnUpdate Boolean
schema String: (Required String) The schema string, for example, file("./schema_version_1.avsc").
schemaIdentifier Number
schemaReferences List<Property Map>: (Optional List) The list of referenced schemas (see Schema References for more details):
subjectName String: (Required String) The name for the reference. (For Avro Schema, the reference name is the fully qualified schema name, for JSON Schema it is a URL, and for Protobuf Schema, it is the name of another Protobuf file.)
version Number: (Required Integer) The version of the Schema, for example, 4.
credentials Property Map
restEndpoint String
schemaRegistryCluster Property Map

Supporting Types

GetSchemaCredentials

Key string: The Schema Registry API Key.
Secret string: The Schema Registry API Secret.

Key string: The Schema Registry API Key.
Secret string: The Schema Registry API Secret.

key String: The Schema Registry API Key.
secret String: The Schema Registry API Secret.

key string: The Schema Registry API Key.
secret string: The Schema Registry API Secret.

key str: The Schema Registry API Key.
secret str: The Schema Registry API Secret.

key String: The Schema Registry API Key.
secret String: The Schema Registry API Secret.

GetSchemaSchemaReference

Name string: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
SubjectName string: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
Version int: (Required Integer) The version of the Schema, for example, 4.

Name string: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
SubjectName string: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
Version int: (Required Integer) The version of the Schema, for example, 4.

name String: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
subjectName String: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
version Integer: (Required Integer) The version of the Schema, for example, 4.

name string: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
subjectName string: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
version number: (Required Integer) The version of the Schema, for example, 4.

name str: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
subject_name str: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
version int: (Required Integer) The version of the Schema, for example, 4.

name String: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
subjectName String: The name of the subject (in other words, the namespace), representing the subject under which the schema will be registered, for example, test-subject. Schemas evolve safely, following a compatibility mode defined, under a subject name.
version Number: (Required Integer) The version of the Schema, for example, 4.

GetSchemaSchemaRegistryCluster

Id string: The ID of the Schema Registry cluster, for example, lsrc-abc123.

Id string: The ID of the Schema Registry cluster, for example, lsrc-abc123.

id String: The ID of the Schema Registry cluster, for example, lsrc-abc123.

id string: The ID of the Schema Registry cluster, for example, lsrc-abc123.

id str: The ID of the Schema Registry cluster, for example, lsrc-abc123.

id String: The ID of the Schema Registry cluster, for example, lsrc-abc123.

Package Details

Repository: Confluent Cloud pulumi/pulumi-confluentcloud
License: Apache-2.0
Notes: This Pulumi package is based on the confluent Terraform Provider.

Confluent v1.26.0 published on Thursday, Sep 28, 2023 by Pulumi

pulumi/pulumi-confluentcloud

confluentcloud.getSchema

On this page

On this page

Using getSchema

getSchema Result

Supporting Types

GetSchemaCredentials

GetSchemaSchemaReference

GetSchemaSchemaRegistryCluster

Package Details

On this page

On this page