1. Packages
  2. Ibm Provider
  3. API Docs
  4. getEventStreamsSchema
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getEventStreamsSchema

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Retrieve information about the Event Streams schema data sources. For more information, about Event Streams schema, see Event Streams Schema Registry.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const esInstance = ibm.getResourceInstance({
        name: "terraform-integration",
        resourceGroupId: data.ibm_resource_group.group.id,
    });
    const esSchema = esInstance.then(esInstance => ibm.getEventStreamsSchema({
        resourceInstanceId: esInstance.id,
        schemaId: "my-es-schema",
    }));
    
    import pulumi
    import pulumi_ibm as ibm
    
    es_instance = ibm.get_resource_instance(name="terraform-integration",
        resource_group_id=data["ibm_resource_group"]["group"]["id"])
    es_schema = ibm.get_event_streams_schema(resource_instance_id=es_instance.id,
        schema_id="my-es-schema")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		esInstance, err := ibm.LookupResourceInstance(ctx, &ibm.LookupResourceInstanceArgs{
    			Name:            pulumi.StringRef("terraform-integration"),
    			ResourceGroupId: pulumi.StringRef(data.Ibm_resource_group.Group.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = ibm.LookupEventStreamsSchema(ctx, &ibm.LookupEventStreamsSchemaArgs{
    			ResourceInstanceId: esInstance.Id,
    			SchemaId:           "my-es-schema",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var esInstance = Ibm.GetResourceInstance.Invoke(new()
        {
            Name = "terraform-integration",
            ResourceGroupId = data.Ibm_resource_group.Group.Id,
        });
    
        var esSchema = Ibm.GetEventStreamsSchema.Invoke(new()
        {
            ResourceInstanceId = esInstance.Apply(getResourceInstanceResult => getResourceInstanceResult.Id),
            SchemaId = "my-es-schema",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetResourceInstanceArgs;
    import com.pulumi.ibm.inputs.GetEventStreamsSchemaArgs;
    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 esInstance = IbmFunctions.getResourceInstance(GetResourceInstanceArgs.builder()
                .name("terraform-integration")
                .resourceGroupId(data.ibm_resource_group().group().id())
                .build());
    
            final var esSchema = IbmFunctions.getEventStreamsSchema(GetEventStreamsSchemaArgs.builder()
                .resourceInstanceId(esInstance.applyValue(getResourceInstanceResult -> getResourceInstanceResult.id()))
                .schemaId("my-es-schema")
                .build());
    
        }
    }
    
    variables:
      esInstance:
        fn::invoke:
          function: ibm:getResourceInstance
          arguments:
            name: terraform-integration
            resourceGroupId: ${data.ibm_resource_group.group.id}
      esSchema:
        fn::invoke:
          function: ibm:getEventStreamsSchema
          arguments:
            resourceInstanceId: ${esInstance.id}
            schemaId: my-es-schema
    

    Using getEventStreamsSchema

    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 getEventStreamsSchema(args: GetEventStreamsSchemaArgs, opts?: InvokeOptions): Promise<GetEventStreamsSchemaResult>
    function getEventStreamsSchemaOutput(args: GetEventStreamsSchemaOutputArgs, opts?: InvokeOptions): Output<GetEventStreamsSchemaResult>
    def get_event_streams_schema(id: Optional[str] = None,
                                 resource_instance_id: Optional[str] = None,
                                 schema_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetEventStreamsSchemaResult
    def get_event_streams_schema_output(id: Optional[pulumi.Input[str]] = None,
                                 resource_instance_id: Optional[pulumi.Input[str]] = None,
                                 schema_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetEventStreamsSchemaResult]
    func LookupEventStreamsSchema(ctx *Context, args *LookupEventStreamsSchemaArgs, opts ...InvokeOption) (*LookupEventStreamsSchemaResult, error)
    func LookupEventStreamsSchemaOutput(ctx *Context, args *LookupEventStreamsSchemaOutputArgs, opts ...InvokeOption) LookupEventStreamsSchemaResultOutput

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

    public static class GetEventStreamsSchema 
    {
        public static Task<GetEventStreamsSchemaResult> InvokeAsync(GetEventStreamsSchemaArgs args, InvokeOptions? opts = null)
        public static Output<GetEventStreamsSchemaResult> Invoke(GetEventStreamsSchemaInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEventStreamsSchemaResult> getEventStreamsSchema(GetEventStreamsSchemaArgs args, InvokeOptions options)
    public static Output<GetEventStreamsSchemaResult> getEventStreamsSchema(GetEventStreamsSchemaArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getEventStreamsSchema:getEventStreamsSchema
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceInstanceId string
    The ID or CRN of the Event Streams service instance.
    SchemaId string
    The schema ID.
    Id string
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    ResourceInstanceId string
    The ID or CRN of the Event Streams service instance.
    SchemaId string
    The schema ID.
    Id string
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    resourceInstanceId String
    The ID or CRN of the Event Streams service instance.
    schemaId String
    The schema ID.
    id String
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    resourceInstanceId string
    The ID or CRN of the Event Streams service instance.
    schemaId string
    The schema ID.
    id string
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    resource_instance_id str
    The ID or CRN of the Event Streams service instance.
    schema_id str
    The schema ID.
    id str
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    resourceInstanceId String
    The ID or CRN of the Event Streams service instance.
    schemaId String
    The schema ID.
    id String
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.

    getEventStreamsSchema Result

    The following output properties are available:

    Id string
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    KafkaHttpUrl string
    (String) The API endpoint for interacting with Event Streams REST API.
    ResourceInstanceId string
    SchemaId string
    Id string
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    KafkaHttpUrl string
    (String) The API endpoint for interacting with Event Streams REST API.
    ResourceInstanceId string
    SchemaId string
    id String
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    kafkaHttpUrl String
    (String) The API endpoint for interacting with Event Streams REST API.
    resourceInstanceId String
    schemaId String
    id string
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    kafkaHttpUrl string
    (String) The API endpoint for interacting with Event Streams REST API.
    resourceInstanceId string
    schemaId string
    id str
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    kafka_http_url str
    (String) The API endpoint for interacting with Event Streams REST API.
    resource_instance_id str
    schema_id str
    id String
    (String) The ID of the schema in CRN format. For example, crn:v1:bluemix:public:messagehub:us-south:a/6db1b0d0b5c54ee5c201552547febcd8:cb5a0252-8b8d-4390-b017-80b743d32839:schema:my-es-schema.
    kafkaHttpUrl String
    (String) The API endpoint for interacting with Event Streams REST API.
    resourceInstanceId String
    schemaId String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud