io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchema Maven / Gradle / Ivy
Show all versions of generative-ai-cdk-constructs Show documentation
package io.github.cdklabs.generative_ai_cdk_constructs.bedrock;
/**
* (experimental) Bedrock Agents Action Group API Schema definition.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-23T18:35:37.385Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.generative_ai_cdk_constructs.$Module.class, fqn = "@cdklabs/generative-ai-cdk-constructs.bedrock.ApiSchema")
public abstract class ApiSchema extends software.amazon.jsii.JsiiObject {
protected ApiSchema(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected ApiSchema(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
protected ApiSchema() {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this);
}
/**
* (experimental) Loads the API Schema from a local disk path.
*
* @return InlineApiSchema with the contents of path
* @param path Path to the Open API schema file in yaml or JSON. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.InlineApiSchema fromAsset(final @org.jetbrains.annotations.NotNull java.lang.String path) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchema.class, "fromAsset", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.InlineApiSchema.class), new Object[] { java.util.Objects.requireNonNull(path, "path is required") });
}
/**
* (experimental) API Schema as an S3 object.
*
* @return S3ApiSchema with the S3 bucket and key.
* @param bucket The S3 bucket. This parameter is required.
* @param key The object key. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.S3ApiSchema fromBucket(final @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.s3.IBucket bucket, final @org.jetbrains.annotations.NotNull java.lang.String key) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchema.class, "fromBucket", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.S3ApiSchema.class), new Object[] { java.util.Objects.requireNonNull(bucket, "bucket is required"), java.util.Objects.requireNonNull(key, "key is required") });
}
/**
* (experimental) Inline code for API Schema.
*
* @return InlineApiSchema with inline schema
* @param schema The actual Open API schema. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.InlineApiSchema fromInline(final @org.jetbrains.annotations.NotNull java.lang.String schema) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchema.class, "fromInline", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.InlineApiSchema.class), new Object[] { java.util.Objects.requireNonNull(schema, "schema is required") });
}
/**
* (experimental) Called when the action group is initialized to allow this object to bind to the stack, add resources and have fun.
*
* @param scope The binding scope. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchemaConfig bind(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope);
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
private static final class Jsii$Proxy extends io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchema {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* (experimental) Called when the action group is initialized to allow this object to bind to the stack, add resources and have fun.
*
* @param scope The binding scope. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchemaConfig bind(final @org.jetbrains.annotations.NotNull software.constructs.Construct scope) {
return software.amazon.jsii.Kernel.call(this, "bind", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.ApiSchemaConfig.class), new Object[] { java.util.Objects.requireNonNull(scope, "scope is required") });
}
}
}