Confluent v1.26.0, Sep 28 23

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

confluentcloud.getSchemas

Explore with Pulumi AI

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

Using getSchemas

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 getSchemas(args: GetSchemasArgs, opts?: InvokeOptions): Promise<GetSchemasResult>
function getSchemasOutput(args: GetSchemasOutputArgs, opts?: InvokeOptions): Output<GetSchemasResult>

def get_schemas(credentials: Optional[GetSchemasCredentials] = None,
                filter: Optional[GetSchemasFilter] = None,
                rest_endpoint: Optional[str] = None,
                schema_registry_cluster: Optional[GetSchemasSchemaRegistryCluster] = None,
                opts: Optional[InvokeOptions] = None) -> GetSchemasResult
def get_schemas_output(credentials: Optional[pulumi.Input[GetSchemasCredentialsArgs]] = None,
                filter: Optional[pulumi.Input[GetSchemasFilterArgs]] = None,
                rest_endpoint: Optional[pulumi.Input[str]] = None,
                schema_registry_cluster: Optional[pulumi.Input[GetSchemasSchemaRegistryClusterArgs]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetSchemasResult]

func GetSchemas(ctx *Context, args *GetSchemasArgs, opts ...InvokeOption) (*GetSchemasResult, error)
func GetSchemasOutput(ctx *Context, args *GetSchemasOutputArgs, opts ...InvokeOption) GetSchemasResultOutput

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

public static class GetSchemas 
{
    public static Task<GetSchemasResult> InvokeAsync(GetSchemasArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemasResult> Invoke(GetSchemasInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSchemasResult> getSchemas(GetSchemasArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

Credentials Pulumi.ConfluentCloud.Inputs.GetSchemasCredentials
Filter Pulumi.ConfluentCloud.Inputs.GetSchemasFilter
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.GetSchemasSchemaRegistryCluster

Credentials GetSchemasCredentials
Filter GetSchemasFilter
RestEndpoint string: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
SchemaRegistryCluster GetSchemasSchemaRegistryCluster

credentials GetSchemasCredentials
filter GetSchemasFilter
restEndpoint String: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster GetSchemasSchemaRegistryCluster

credentials GetSchemasCredentials
filter GetSchemasFilter
restEndpoint string: The REST endpoint of the Schema Registry cluster, for example, https://psrc-00000.us-central1.gcp.confluent.cloud:443).
schemaRegistryCluster GetSchemasSchemaRegistryCluster

credentials GetSchemasCredentials
filter GetSchemasFilter
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 GetSchemasSchemaRegistryCluster

credentials Property Map
filter 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

getSchemas Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Schemas List<Pulumi.ConfluentCloud.Outputs.GetSchemasSchema>: (List of Object) List of schemas. Each schema object exports the following attributes:
Credentials Pulumi.ConfluentCloud.Outputs.GetSchemasCredentials
Filter Pulumi.ConfluentCloud.Outputs.GetSchemasFilter
RestEndpoint string
SchemaRegistryCluster Pulumi.ConfluentCloud.Outputs.GetSchemasSchemaRegistryCluster

Id string: The provider-assigned unique ID for this managed resource.
Schemas []GetSchemasSchema: (List of Object) List of schemas. Each schema object exports the following attributes:
Credentials GetSchemasCredentials
Filter GetSchemasFilter
RestEndpoint string
SchemaRegistryCluster GetSchemasSchemaRegistryCluster

id String: The provider-assigned unique ID for this managed resource.
schemas List<GetSchemasSchema>: (List of Object) List of schemas. Each schema object exports the following attributes:
credentials GetSchemasCredentials
filter GetSchemasFilter
restEndpoint String
schemaRegistryCluster GetSchemasSchemaRegistryCluster

id string: The provider-assigned unique ID for this managed resource.
schemas GetSchemasSchema[]: (List of Object) List of schemas. Each schema object exports the following attributes:
credentials GetSchemasCredentials
filter GetSchemasFilter
restEndpoint string
schemaRegistryCluster GetSchemasSchemaRegistryCluster

id str: The provider-assigned unique ID for this managed resource.
schemas Sequence[GetSchemasSchema]: (List of Object) List of schemas. Each schema object exports the following attributes:
credentials GetSchemasCredentials
filter GetSchemasFilter
rest_endpoint str
schema_registry_cluster GetSchemasSchemaRegistryCluster

id String: The provider-assigned unique ID for this managed resource.
schemas List<Property Map>: (List of Object) List of schemas. Each schema object exports the following attributes:
credentials Property Map
filter Property Map
restEndpoint String
schemaRegistryCluster Property Map

Supporting Types

GetSchemasCredentials

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.

GetSchemasFilter

Deleted bool: The boolean flag to control whether to return soft deleted schemas. Defaults to false.
LatestOnly bool: The boolean flag to control whether to return latest schema versions only for each matching subject. Defaults to false.
SubjectPrefix string: The prefix of the subjects (in other words, the namespaces), representing the subjects under which the schemas are registered.

Deleted bool: The boolean flag to control whether to return soft deleted schemas. Defaults to false.
LatestOnly bool: The boolean flag to control whether to return latest schema versions only for each matching subject. Defaults to false.
SubjectPrefix string: The prefix of the subjects (in other words, the namespaces), representing the subjects under which the schemas are registered.

deleted Boolean: The boolean flag to control whether to return soft deleted schemas. Defaults to false.
latestOnly Boolean: The boolean flag to control whether to return latest schema versions only for each matching subject. Defaults to false.
subjectPrefix String: The prefix of the subjects (in other words, the namespaces), representing the subjects under which the schemas are registered.

deleted boolean: The boolean flag to control whether to return soft deleted schemas. Defaults to false.
latestOnly boolean: The boolean flag to control whether to return latest schema versions only for each matching subject. Defaults to false.
subjectPrefix string: The prefix of the subjects (in other words, the namespaces), representing the subjects under which the schemas are registered.

deleted bool: The boolean flag to control whether to return soft deleted schemas. Defaults to false.
latest_only bool: The boolean flag to control whether to return latest schema versions only for each matching subject. Defaults to false.
subject_prefix str: The prefix of the subjects (in other words, the namespaces), representing the subjects under which the schemas are registered.

deleted Boolean: The boolean flag to control whether to return soft deleted schemas. Defaults to false.
latestOnly Boolean: The boolean flag to control whether to return latest schema versions only for each matching subject. Defaults to false.
subjectPrefix String: The prefix of the subjects (in other words, the namespaces), representing the subjects under which the schemas are registered.

GetSchemasSchema

Format string: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
Schema string: (Required String) The schema string.
SchemaIdentifier int: (Required String) The ID of the Schema, for example: lsrc-abc123/test-subject/100003.
SchemaReferences List<Pulumi.ConfluentCloud.Inputs.GetSchemasSchemaSchemaReference>: (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.

Format string: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
Schema string: (Required String) The schema string.
SchemaIdentifier int: (Required String) The ID of the Schema, for example: lsrc-abc123/test-subject/100003.
SchemaReferences []GetSchemasSchemaSchemaReference: (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.

format String: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
schema String: (Required String) The schema string.
schemaIdentifier Integer: (Required String) The ID of the Schema, for example: lsrc-abc123/test-subject/100003.
schemaReferences List<GetSchemasSchemaSchemaReference>: (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.

format string: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
schema string: (Required String) The schema string.
schemaIdentifier number: (Required String) The ID of the Schema, for example: lsrc-abc123/test-subject/100003.
schemaReferences GetSchemasSchemaSchemaReference[]: (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.

format str: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
schema str: (Required String) The schema string.
schema_identifier int: (Required String) The ID of the Schema, for example: lsrc-abc123/test-subject/100003.
schema_references Sequence[GetSchemasSchemaSchemaReference]: (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.

format String: (Required String) The format of the schema. Accepted values are: AVRO, PROTOBUF, and JSON.
schema String: (Required String) The schema string.
schemaIdentifier Number: (Required String) The ID of the Schema, for example: lsrc-abc123/test-subject/100003.
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.

GetSchemasSchemaRegistryCluster

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.

GetSchemasSchemaSchemaReference

Name string: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
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.

Name string: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
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.

name String: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
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.

name string: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
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.

name str: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
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.

name String: (Required String) The name of the subject, representing the subject under which the referenced schema is registered.
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.

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.getSchemas

On this page

On this page

Using getSchemas

getSchemas Result

Supporting Types

GetSchemasCredentials

GetSchemasFilter

GetSchemasSchema

GetSchemasSchemaRegistryCluster

GetSchemasSchemaSchemaReference

Package Details

On this page

On this page