com.thoughtworks.go.plugin.api.task.EnvironmentVariables Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of go-plugin-api Show documentation

The APIs described here are needed for developing plugins for GoCD - A continuous delivery server

There is a newer version: 24.4.0

/*
 * Copyright 2020 ThoughtWorks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.thoughtworks.go.plugin.api.task;

import java.util.Map;

/**
 * Environment variables for the task.
 */
@Deprecated
//Will be moved to internal scope
public interface EnvironmentVariables {
    /**
     * @return A map (key-value pairs) of the environment variables.
     */
    Map asMap();

    /**
     * Write the environment variables to a {@link com.thoughtworks.go.plugin.api.task.Console}.
     * @param console to write
     */
    void writeTo(Console console);

    /**
     * @return the {@link com.thoughtworks.go.plugin.api.task.Console.SecureEnvVarSpecifier}
     */
    Console.SecureEnvVarSpecifier secureEnvSpecifier();
}