Class ResponseOutputItem.LocalShellCall.Action
-
- All Implemented Interfaces:
public final class ResponseOutputItem.LocalShellCall.Action
Execute a shell command on the server.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseOutputItem.LocalShellCall.Action.Builder
A builder for Action.
public final class
ResponseOutputItem.LocalShellCall.Action.Env
Environment variables to set for the command.
-
Method Summary
Modifier and Type Method Description final List<String>
command()
The command to run. final ResponseOutputItem.LocalShellCall.Action.Env
env()
Environment variables to set for the command. final JsonValue
_type()
The type of the local shell action. final Optional<Long>
timeoutMs()
Optional timeout in milliseconds for the command. final Optional<String>
user()
Optional user to run the command as. final Optional<String>
workingDirectory()
Optional working directory to run the command in. final JsonField<List<String>>
_command()
Returns the raw JSON value of command. final JsonField<ResponseOutputItem.LocalShellCall.Action.Env>
_env()
Returns the raw JSON value of env. final JsonField<Long>
_timeoutMs()
Returns the raw JSON value of timeoutMs. final JsonField<String>
_user()
Returns the raw JSON value of user. final JsonField<String>
_workingDirectory()
Returns the raw JSON value of workingDirectory. final Map<String, JsonValue>
_additionalProperties()
final ResponseOutputItem.LocalShellCall.Action.Builder
toBuilder()
final ResponseOutputItem.LocalShellCall.Action
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseOutputItem.LocalShellCall.Action.Builder
builder()
Returns a mutable builder for constructing an instance of Action. -
-
Method Detail
-
env
final ResponseOutputItem.LocalShellCall.Action.Env env()
Environment variables to set for the command.
-
_type
final JsonValue _type()
The type of the local shell action. Always
exec
.Expected to always return the following:
JsonValue.from("exec")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
workingDirectory
final Optional<String> workingDirectory()
Optional working directory to run the command in.
-
_command
final JsonField<List<String>> _command()
Returns the raw JSON value of command.
Unlike command, this method doesn't throw if the JSON field has an unexpected type.
-
_env
final JsonField<ResponseOutputItem.LocalShellCall.Action.Env> _env()
Returns the raw JSON value of env.
Unlike env, this method doesn't throw if the JSON field has an unexpected type.
-
_timeoutMs
final JsonField<Long> _timeoutMs()
Returns the raw JSON value of timeoutMs.
Unlike timeoutMs, this method doesn't throw if the JSON field has an unexpected type.
-
_user
final JsonField<String> _user()
Returns the raw JSON value of user.
Unlike user, this method doesn't throw if the JSON field has an unexpected type.
-
_workingDirectory
final JsonField<String> _workingDirectory()
Returns the raw JSON value of workingDirectory.
Unlike workingDirectory, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseOutputItem.LocalShellCall.Action.Builder toBuilder()
-
validate
final ResponseOutputItem.LocalShellCall.Action validate()
-
builder
final static ResponseOutputItem.LocalShellCall.Action.Builder builder()
Returns a mutable builder for constructing an instance of Action.
The following fields are required:
.command() .env()
-
-
-
-