Interface CommandOrBuilder (2.56.0)

public interface CommandOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getArgs(int index)

public abstract String getArgs(int index)

Command-line arguments used when executing this command.

repeated string args = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The args at the given index.

getArgsBytes(int index)

public abstract ByteString getArgsBytes(int index)

Command-line arguments used when executing this command.

repeated string args = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the args at the given index.

getArgsCount()

public abstract int getArgsCount()

Command-line arguments used when executing this command.

repeated string args = 3;

Returns
Type Description
int

The count of args.

getArgsList()

public abstract List<String> getArgsList()

Command-line arguments used when executing this command.

repeated string args = 3;

Returns
Type Description
List<String>

A list containing the args.

getDir()

public abstract String getDir()

Working directory (relative to project source root) used when running this command.

string dir = 4;

Returns
Type Description
String

The dir.

getDirBytes()

public abstract ByteString getDirBytes()

Working directory (relative to project source root) used when running this command.

string dir = 4;

Returns
Type Description
ByteString

The bytes for dir.

getEnv(int index)

public abstract String getEnv(int index)

Environment variables set before running this command.

repeated string env = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The env at the given index.

getEnvBytes(int index)

public abstract ByteString getEnvBytes(int index)

Environment variables set before running this command.

repeated string env = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the env at the given index.

getEnvCount()

public abstract int getEnvCount()

Environment variables set before running this command.

repeated string env = 2;

Returns
Type Description
int

The count of env.

getEnvList()

public abstract List<String> getEnvList()

Environment variables set before running this command.

repeated string env = 2;

Returns
Type Description
List<String>

A list containing the env.

getId()

public abstract String getId()

Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

string id = 5;

Returns
Type Description
String

The id.

getIdBytes()

public abstract ByteString getIdBytes()

Optional unique identifier for this command, used in wait_for to reference this command as a dependency.

string id = 5;

Returns
Type Description
ByteString

The bytes for id.

getName()

public abstract String getName()

Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to docker pull.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. Name of the command, as presented on the command line, or if the command is packaged as a Docker container, as presented to docker pull.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getWaitFor(int index)

public abstract String getWaitFor(int index)

The ID(s) of the command(s) that this command depends on.

repeated string wait_for = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The waitFor at the given index.

getWaitForBytes(int index)

public abstract ByteString getWaitForBytes(int index)

The ID(s) of the command(s) that this command depends on.

repeated string wait_for = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the waitFor at the given index.

getWaitForCount()

public abstract int getWaitForCount()

The ID(s) of the command(s) that this command depends on.

repeated string wait_for = 6;

Returns
Type Description
int

The count of waitFor.

getWaitForList()

public abstract List<String> getWaitForList()

The ID(s) of the command(s) that this command depends on.

repeated string wait_for = 6;

Returns
Type Description
List<String>

A list containing the waitFor.