com.pulumi.deployment.internal.EngineLogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi Show documentation
Pulumi Java SDK
There is a newer version: 0.17.0
package com.pulumi.deployment.internal;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.pulumi.core.internal.annotations.InternalUse;
import com.pulumi.resources.Resource;

import javax.annotation.Nullable;
import java.util.concurrent.CompletableFuture;
import java.util.logging.Level;

@InternalUse
public interface EngineLogger extends CountingLogger {

    /**
     * Logs a debug-level message that is generally hidden from end-users.
     */
    @CanIgnoreReturnValue
    default CompletableFuture debugAsync(String message) {
        return debugAsync(message, null, null, null);
    }

    /**
     * Logs an informational message that is generally printed to stdout during resource operations.
     */
    @CanIgnoreReturnValue
    default CompletableFuture infoAsync(String message) {
        return infoAsync(message, null);
    }

    /**
     * Warn logs a warning to indicate that something went wrong, but not catastrophically so.
     */
    @CanIgnoreReturnValue
    default CompletableFuture warnAsync(String message) {
        return warnAsync(message, null);
    }

    /**
     * Logs a fatal condition. Consider raising an exception
     * after calling this method to stop the Pulumi program.
     */
    @CanIgnoreReturnValue
    default CompletableFuture errorAsync(String message) {
        return errorAsync(message, null);
    }

    /**
     * Logs a debug-level message that is generally hidden from end-users.
     */
    @CanIgnoreReturnValue
    default CompletableFuture debugAsync(String message, @Nullable Resource resource) {
        return debugAsync(message, resource, null, null);
    }

    /**
     * Logs an informational message that is generally printed to stdout during resource operations.
     */
    @CanIgnoreReturnValue
    default CompletableFuture infoAsync(String message, @Nullable Resource resource) {
        return infoAsync(message, resource, null, null);
    }

    /**
     * Warn logs a warning to indicate that something went wrong, but not catastrophically so.
     */
    @CanIgnoreReturnValue
    default CompletableFuture warnAsync(String message, @Nullable Resource resource) {
        return warnAsync(message, resource, null, null);
    }

    /**
     * Logs a fatal condition. Consider raising an exception after calling this method to stop the Pulumi program.
     */
    @CanIgnoreReturnValue
    default CompletableFuture errorAsync(String message, @Nullable Resource resource) {
        return errorAsync(message, resource, null, null);
    }

    @CanIgnoreReturnValue
    CompletableFuture logAsync(Level level,
                                     String message,
                                     @Nullable Resource resource,
                                     @Nullable Integer streamId,
                                     @Nullable Boolean ephemeral);

    /**
     * Logs a debug-level message that is generally hidden from end-users.
     */
    @CanIgnoreReturnValue
    default CompletableFuture debugAsync(String message,
                                               @Nullable Resource resource,
                                               @Nullable Integer streamId,
                                               @Nullable Boolean ephemeral) {
        return logAsync(Level.FINE, message, resource, streamId, ephemeral);
    }

    /**
     * Logs an informational message that is generally printed to stdout during resource operations.
     */
    @CanIgnoreReturnValue
    default CompletableFuture infoAsync(String message,
                                              @Nullable Resource resource,
                                              @Nullable Integer streamId,
                                              @Nullable Boolean ephemeral) {
        return logAsync(Level.INFO, message, resource, streamId, ephemeral);
    }

    /**
     * Warn logs a warning to indicate that something went wrong, but not catastrophically so.
     */
    @CanIgnoreReturnValue
    default CompletableFuture warnAsync(String message,
                                              @Nullable Resource resource,
                                              @Nullable Integer streamId,
                                              @Nullable Boolean ephemeral) {
        return logAsync(Level.WARNING, message, resource, streamId, ephemeral);
    }

    /**
     * Logs a fatal condition. Consider raising an exception
     * after calling this method to stop the Pulumi program.
     */
    @CanIgnoreReturnValue
    default CompletableFuture errorAsync(String message,
                                               @Nullable Resource resource,
                                               @Nullable Integer streamId,
                                               @Nullable Boolean ephemeral) {
        return logAsync(Level.SEVERE, message, resource, streamId, ephemeral);
    }

    static EngineLogger ignore() {
        return new NullLogger();
    }

    class NullLogger implements EngineLogger {
        @Override
        public CompletableFuture logAsync(Level level,
                                                String message,
                                                @Nullable Resource resource,
                                                @Nullable Integer streamId,
                                                @Nullable Boolean ephemeral) {
            return CompletableFuture.completedFuture(null);
        }

        @Override
        public int getErrorCount() {
            return 0;
        }

        @Override
        public boolean hasLoggedErrors() {
            return false;
        }
    }
}