java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.generativeaisandbox.GenerativeAiSandboxClient

All Implemented Interfaces:: GenerativeAiSandbox, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 1.0")
public class GenerativeAiSandboxClient
extends BaseSyncClient
implements GenerativeAiSandbox

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GenerativeAiSandboxClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for GenerativeAiSandbox.

Constructor Summary

Constructors
Constructor	Description
`GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GenerativeAiSandboxClient.Builder`	`builder()`	Create a builder for this client.
`CancelSandboxCommandResponse`	`cancelSandboxCommand(CancelSandboxCommandRequest request)`	Requests cancellation of a running sandbox command.
`void`	`close()`
`CreateSandboxResponse`	`createSandbox(CreateSandboxRequest request)`	Creates a sandbox resource and returns its initial state.
`CreateSandboxSnapshotResponse`	`createSandboxSnapshot(CreateSandboxSnapshotRequest request)`	Creates a sandbox snapshot resource and returns its initial state.
`DeleteSandboxResponse`	`deleteSandbox(DeleteSandboxRequest request)`	Deletes a sandbox.
`DeleteSandboxSnapshotResponse`	`deleteSandboxSnapshot(DeleteSandboxSnapshotRequest request)`	Deletes a sandbox snapshot.
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`ExtendSandboxResponse`	`extendSandbox(ExtendSandboxRequest request)`	Extends the duration of a sandbox.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`	Get the endpoint of the client.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Map<String,Boolean>`	`getOptionsMap()`	Return an immutable snapshot representing the current options set for this client.
`GenerativeAiSandboxPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`String`	`getResolvedEndpoint(Map<String,Object> requiredParametersMap)`	Returns the endpoint after filling in the current options, as determined by `BaseClient.getOptionsMap()`, and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
`GetSandboxResponse`	`getSandbox(GetSandboxRequest request)`	Gets information about a sandbox.
`GetSandboxCommandResponse`	`getSandboxCommand(GetSandboxCommandRequest request)`	Gets command metadata for a sandbox command.
`GetSandboxCommandOutputResponse`	`getSandboxCommandOutput(GetSandboxCommandOutputRequest request)`	Gets captured output for a sandbox command starting from the requested event sequence.
`GetSandboxSnapshotResponse`	`getSandboxSnapshot(GetSandboxSnapshotRequest request)`	Gets information about a sandbox snapshot.
`GenerativeAiSandboxWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`ListSandboxCommandResponse`	`listSandboxCommand(ListSandboxCommandRequest request)`	Lists sandbox commands for a sandbox with optional pagination.
`ListSandboxesResponse`	`listSandboxes(ListSandboxesRequest request)`	Lists sandbox resources with optional filtering and pagination.
`ListSandboxSnapshotsResponse`	`listSandboxSnapshots(ListSandboxSnapshotsRequest request)`	Lists sandbox snapshot resources with optional filtering and pagination.
`ReadSandboxFileResponse`	`readSandboxFile(ReadSandboxFileRequest request)`	Reads a file from a sandbox.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`ResumeSandboxResponse`	`resumeSandbox(ResumeSandboxRequest request)`	Resumes a suspended sandbox by scaling its backing runtime back to one replica.
`RunSandboxCommandResponse`	`runSandboxCommand(RunSandboxCommandRequest request)`	Runs a command in a sandbox and returns the command identifier immediately.
`RunSandboxCommandAndStreamResponse`	`runSandboxCommandAndStream(RunSandboxCommandAndStreamRequest request)`	Runs a command in a sandbox and streams command events as newline-delimited JSON.
`RunSandboxCommandAndWaitResponse`	`runSandboxCommandAndWait(RunSandboxCommandAndWaitRequest request)`	Runs a command in a sandbox, blocks until command execution finishes, and returns the final command metadata.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)`	Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)`	Sets the region to call (ex, ‘us-phoenix-1’).
`StopSandboxResponse`	`stopSandbox(StopSandboxRequest request)`	Stops a running sandbox.
`StreamSandboxCommandEventsResponse`	`streamSandboxCommandEvents(StreamSandboxCommandEventsRequest request)`	Streams command events for an existing sandbox command from `fromSeq` through `untilSeq` using Server-Sent Events.
`SuspendSandboxResponse`	`suspendSandbox(SuspendSandboxRequest request)`	Suspends a running sandbox by scaling its backing runtime to zero replicas while retaining the workspace block volume.
`UpdateSandboxResponse`	`updateSandbox(UpdateSandboxRequest request)`	Updates a sandbox.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.
`WriteSandboxFileResponse`	`writeSandboxFile(WriteSandboxFileRequest request)`	Writes a file in a sandbox and returns the resulting file resource.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.generativeaisandbox.GenerativeAiSandbox
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for GenerativeAiSandbox.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - GenerativeAiSandboxClient
```
@Deprecated
public GenerativeAiSandboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - GenerativeAiSandboxClient
```
@Deprecated
public GenerativeAiSandboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - GenerativeAiSandboxClient
```
@Deprecated
public GenerativeAiSandboxClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - GenerativeAiSandboxClient
```
@Deprecated
public GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - GenerativeAiSandboxClient
```
@Deprecated
public GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - GenerativeAiSandboxClient
```
@Deprecated
public GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - GenerativeAiSandboxClient
```
@Deprecated
public GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
  - GenerativeAiSandboxClient
```
@Deprecated
public GenerativeAiSandboxClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                 ClientConfiguration configuration,
                                 ClientConfigurator clientConfigurator,
                                 RequestSignerFactory defaultRequestSignerFactory,
                                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                 List<ClientConfigurator> additionalClientConfigurators,
                                 String endpoint,
                                 ExecutorService executorService)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
    
    executorService - GenerativeAiSandboxClient.Builder.executorService
- Method Detail
  - builder
```
public static GenerativeAiSandboxClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: GenerativeAiSandbox
    
    Sets the region to call (ex, Region.US_PHOENIX_1).
    Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
    
    Specified by:
    
    setRegion in interface GenerativeAiSandbox
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: GenerativeAiSandbox
    
    Sets the region to call (ex, ‘us-phoenix-1’).
    Note, this will first try to map the region ID to a known Region and call setRegion.
    If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.
    
    Specified by:
    
    setRegion in interface GenerativeAiSandbox
    
    Parameters:
    
    regionId - The public region ID.
  - cancelSandboxCommand
```
public CancelSandboxCommandResponse cancelSandboxCommand(CancelSandboxCommandRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Requests cancellation of a running sandbox command.
    
    Specified by:
    
    cancelSandboxCommand in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createSandbox
```
public CreateSandboxResponse createSandbox(CreateSandboxRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Creates a sandbox resource and returns its initial state.
    
    Specified by:
    
    createSandbox in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createSandboxSnapshot
```
public CreateSandboxSnapshotResponse createSandboxSnapshot(CreateSandboxSnapshotRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Creates a sandbox snapshot resource and returns its initial state.
    
    Specified by:
    
    createSandboxSnapshot in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteSandbox
```
public DeleteSandboxResponse deleteSandbox(DeleteSandboxRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Deletes a sandbox.
    
    Specified by:
    
    deleteSandbox in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteSandboxSnapshot
```
public DeleteSandboxSnapshotResponse deleteSandboxSnapshot(DeleteSandboxSnapshotRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Deletes a sandbox snapshot.
    
    Specified by:
    
    deleteSandboxSnapshot in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - extendSandbox
```
public ExtendSandboxResponse extendSandbox(ExtendSandboxRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Extends the duration of a sandbox.
    
    Specified by:
    
    extendSandbox in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSandbox
```
public GetSandboxResponse getSandbox(GetSandboxRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Gets information about a sandbox.
    
    Specified by:
    
    getSandbox in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSandboxCommand
```
public GetSandboxCommandResponse getSandboxCommand(GetSandboxCommandRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Gets command metadata for a sandbox command.
    
    Specified by:
    
    getSandboxCommand in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSandboxCommandOutput
```
public GetSandboxCommandOutputResponse getSandboxCommandOutput(GetSandboxCommandOutputRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Gets captured output for a sandbox command starting from the requested event sequence.
    
    Specified by:
    
    getSandboxCommandOutput in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getSandboxSnapshot
```
public GetSandboxSnapshotResponse getSandboxSnapshot(GetSandboxSnapshotRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Gets information about a sandbox snapshot.
    
    Specified by:
    
    getSandboxSnapshot in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSandboxCommand
```
public ListSandboxCommandResponse listSandboxCommand(ListSandboxCommandRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Lists sandbox commands for a sandbox with optional pagination.
    
    Specified by:
    
    listSandboxCommand in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSandboxSnapshots
```
public ListSandboxSnapshotsResponse listSandboxSnapshots(ListSandboxSnapshotsRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Lists sandbox snapshot resources with optional filtering and pagination.
    
    Specified by:
    
    listSandboxSnapshots in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSandboxes
```
public ListSandboxesResponse listSandboxes(ListSandboxesRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Lists sandbox resources with optional filtering and pagination.
    Specify exactly one of projectId or compartmentId. A compartment-scoped request returns sandboxes from Generative AI projects directly contained in that compartment; child compartments are not included.
    
    Specified by:
    
    listSandboxes in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - readSandboxFile
```
public ReadSandboxFileResponse readSandboxFile(ReadSandboxFileRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Reads a file from a sandbox.
    
    Specified by:
    
    readSandboxFile in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - resumeSandbox
```
public ResumeSandboxResponse resumeSandbox(ResumeSandboxRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Resumes a suspended sandbox by scaling its backing runtime back to one replica.
    
    Specified by:
    
    resumeSandbox in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - runSandboxCommand
```
public RunSandboxCommandResponse runSandboxCommand(RunSandboxCommandRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Runs a command in a sandbox and returns the command identifier immediately.
    
    Specified by:
    
    runSandboxCommand in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - runSandboxCommandAndStream
```
public RunSandboxCommandAndStreamResponse runSandboxCommandAndStream(RunSandboxCommandAndStreamRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Runs a command in a sandbox and streams command events as newline-delimited JSON.
    Each line is a serialized SandboxCommandEvent.
    
    Specified by:
    
    runSandboxCommandAndStream in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - runSandboxCommandAndWait
```
public RunSandboxCommandAndWaitResponse runSandboxCommandAndWait(RunSandboxCommandAndWaitRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Runs a command in a sandbox, blocks until command execution finishes, and returns the final command metadata.
    
    Specified by:
    
    runSandboxCommandAndWait in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - stopSandbox
```
public StopSandboxResponse stopSandbox(StopSandboxRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Stops a running sandbox.
    
    Specified by:
    
    stopSandbox in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - streamSandboxCommandEvents
```
public StreamSandboxCommandEventsResponse streamSandboxCommandEvents(StreamSandboxCommandEventsRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Streams command events for an existing sandbox command from fromSeq through untilSeq using Server-Sent Events.
    Each SSE data field contains a serialized SandboxCommandEvent.
    
    Specified by:
    
    streamSandboxCommandEvents in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - suspendSandbox
```
public SuspendSandboxResponse suspendSandbox(SuspendSandboxRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Suspends a running sandbox by scaling its backing runtime to zero replicas while retaining the workspace block volume.
    
    Specified by:
    
    suspendSandbox in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateSandbox
```
public UpdateSandboxResponse updateSandbox(UpdateSandboxRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Updates a sandbox.
    
    Specified by:
    
    updateSandbox in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - writeSandboxFile
```
public WriteSandboxFileResponse writeSandboxFile(WriteSandboxFileRequest request)
```
    Description copied from interface: GenerativeAiSandbox
    
    Writes a file in a sandbox and returns the resulting file resource.
    Note: This operation consumes a stream.
    If the stream supports InputStream.mark(int) and InputStream.reset(), when a retry is necessary, the stream is reset so it starts at the beginning (or whatever the stream's position was at the time this operation is called}.
    Note this means that if the caller has used InputStream.mark(int) before, then the mark will not be the same anymore after this operation, and a subsequent call to InputStream.reset() by the caller will reset the stream not to the caller's mark, but to the position the stream was in when this operation was called.
    If the stream is a FileInputStream, and the stream's FileChannel position can be changed (like for a regular file), the stream will be wrapped in such a way that it does provide support for InputStream.mark(int) and InputStream.reset(). Then the same procedure as above is followed. If the stream's FileChannel position cannot be changed (like for a named pipe), then the stream's contents will be buffered in memory, as described below.
    If the stream does not support InputStream.mark(int) and InputStream.reset(), then the stream is wrapped in a BufferedInputStream, which means the entire contents may be buffered in memory. Then the same procedure as above is followed.
    The contents of the stream, except when the stream is a FileInputStream whose FileChannel position can be changed, should be less than 2 GiB in size if retries are used. This is because streams 2 GiB in size or larger do no guarantee that mark-and-reset can be performed. If the stream is larger, do not use built-in retries and manage retries yourself.
    
    Specified by:
    
    writeSandboxFile in interface GenerativeAiSandbox
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public GenerativeAiSandboxWaiters getWaiters()
```
    Description copied from interface: GenerativeAiSandbox
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface GenerativeAiSandbox
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public GenerativeAiSandboxPaginators getPaginators()
```
    Description copied from interface: GenerativeAiSandbox
    
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
    These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Specified by:
    
    getPaginators in interface GenerativeAiSandbox
    
    Returns:
    
    The service paginators.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - enableDualStackEndpoints
```
public void enableDualStackEndpoints(boolean enableDualStackEndpoints)
```
    This method should be used to enable or disable the use of dual-stack endpoints.
    The default value is false i.e. dual-stack endpoints are disabled by default.
    
    Parameters:
    
    enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively
  - getOptionsMap
```
public Map<String,Boolean> getOptionsMap()
```
    Return an immutable snapshot representing the current options set for this client.
    
    Returns:
    
    immutable snapshot representing the current options set for this client
  - getResolvedEndpoint
```
public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)
```
    Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
    
    Parameters:
    
    requiredParametersMap - the map from required parameter name to their values
    
    Returns:
    
    resolved endpoint, with all options and placeholders filled in
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
    Get the endpoint of the client.
    Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.
    Examples of endpoints this may return:
    
    Unparameterized endpoints
    https://identity.us-phoenix-1.oci.oraclecloud.com https://identity.us-ashburn-1.oci.oraclecloud.com https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with placeholders
    https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    Parameterized endpoints with options
    https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
    
    Parameterized endpoints with placeholders and options
    https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
    
    To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).
    Returns:
    
    the endpoint being used by the client
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```

Class GenerativeAiSandboxClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.generativeaisandbox.GenerativeAiSandbox

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

GenerativeAiSandboxClient

GenerativeAiSandboxClient

GenerativeAiSandboxClient

GenerativeAiSandboxClient

GenerativeAiSandboxClient

GenerativeAiSandboxClient

GenerativeAiSandboxClient

GenerativeAiSandboxClient

Method Detail

builder

setRegion

setRegion

cancelSandboxCommand

createSandbox

createSandboxSnapshot

deleteSandbox

deleteSandboxSnapshot

extendSandbox

getSandbox

getSandboxCommand

getSandboxCommandOutput

getSandboxSnapshot

listSandboxCommand

listSandboxSnapshots

listSandboxes

readSandboxFile

resumeSandbox

runSandboxCommand

runSandboxCommandAndStream

runSandboxCommandAndWait

stopSandbox

streamSandboxCommandEvents

suspendSandbox

updateSandbox

writeSandboxFile

getWaiters

getPaginators

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient