Class ConversationItem.LocalShellCall.Action
-
- All Implemented Interfaces:
public final class ConversationItem.LocalShellCall.ActionExecute a shell command on the server.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classConversationItem.LocalShellCall.Action.BuilderA builder for Action.
public final classConversationItem.LocalShellCall.Action.EnvEnvironment variables to set for the command.
-
Method Summary
Modifier and Type Method Description final List<String>command()The command to run. final ConversationItem.LocalShellCall.Action.Envenv()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<ConversationItem.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 ConversationItem.LocalShellCall.Action.BuildertoBuilder()final ConversationItem.LocalShellCall.Actionvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ConversationItem.LocalShellCall.Action.Builderbuilder()Returns a mutable builder for constructing an instance of Action. -
-
Method Detail
-
env
final ConversationItem.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<ConversationItem.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 ConversationItem.LocalShellCall.Action.Builder toBuilder()
-
validate
final ConversationItem.LocalShellCall.Action validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static ConversationItem.LocalShellCall.Action.Builder builder()
Returns a mutable builder for constructing an instance of Action.
The following fields are required:
.command() .env()
-
-
-
-