com.cloudsnorkel.cdk.github.runners.IImageBuilder Maven / Gradle / Ivy
package com.cloudsnorkel.cdk.github.runners;
/**
* (experimental) Interface for constructs that build an image that can be used in {@link IRunnerProvider}.
*
* Anything that ends up with an ECR repository containing a Docker image that runs GitHub self-hosted runners can be used. A simple implementation could even point to an existing image and nothing else.
*
* It's important that the specified image tag be available at the time the repository is available. Providers usually assume the image is ready and will fail if it's not.
*
* The image can be further updated over time manually or using a schedule as long as it is always written to the same tag.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.73.0 (build 6faeda3)", date = "2023-01-17T21:04:03.033Z")
@software.amazon.jsii.Jsii(module = com.cloudsnorkel.cdk.github.runners.$Module.class, fqn = "@cloudsnorkel/cdk-github-runners.IImageBuilder")
@software.amazon.jsii.Jsii.Proxy(IImageBuilder.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface IImageBuilder extends software.amazon.jsii.JsiiSerializable {
/**
* (experimental) Finalize and return all required information about the Docker image built by this builder.
*
* This method can be called multiple times if the image is bound to multiple providers. Make sure you cache the image when implementing or return an error if this builder doesn't support reusing images.
*
* @return image
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImage bind();
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements com.cloudsnorkel.cdk.github.runners.IImageBuilder.Jsii$Default {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* (experimental) Finalize and return all required information about the Docker image built by this builder.
*
* This method can be called multiple times if the image is bound to multiple providers. Make sure you cache the image when implementing or return an error if this builder doesn't support reusing images.
*
* @return image
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public final @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImage bind() {
return software.amazon.jsii.Kernel.call(this, "bind", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.RunnerImage.class));
}
}
/**
* Internal default implementation for {@link IImageBuilder}.
*/
@software.amazon.jsii.Internal
interface Jsii$Default extends IImageBuilder {
/**
* (experimental) Finalize and return all required information about the Docker image built by this builder.
*
* This method can be called multiple times if the image is bound to multiple providers. Make sure you cache the image when implementing or return an error if this builder doesn't support reusing images.
*
* @return image
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
default @org.jetbrains.annotations.NotNull com.cloudsnorkel.cdk.github.runners.RunnerImage bind() {
return software.amazon.jsii.Kernel.call(this, "bind", software.amazon.jsii.NativeType.forClass(com.cloudsnorkel.cdk.github.runners.RunnerImage.class));
}
}
}