java.lang.Object
- com.oracle.bmc.http.internal.BaseAsyncClient
- - com.oracle.bmc.generativeaisandbox.GenerativeAiSandboxAsyncClient

All Implemented Interfaces:

GenerativeAiSandboxAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 1.0")
public class GenerativeAiSandboxAsyncClient
extends BaseAsyncClient
implements GenerativeAiSandboxAsync
```
Async client implementation for GenerativeAiSandbox service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GenerativeAiSandboxAsyncClient.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
`GenerativeAiSandboxAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`GenerativeAiSandboxAsyncClient(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 GenerativeAiSandboxAsyncClient.Builder`	`builder()`	Create a builder for this client.
`Future<CancelSandboxCommandResponse>`	`cancelSandboxCommand(CancelSandboxCommandRequest request, AsyncHandler<CancelSandboxCommandRequest,CancelSandboxCommandResponse> handler)`	Requests cancellation of a running sandbox command.
`protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>`	`clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)`
`void`	`close()`
`Future<CreateSandboxResponse>`	`createSandbox(CreateSandboxRequest request, AsyncHandler<CreateSandboxRequest,CreateSandboxResponse> handler)`	Creates a sandbox resource and returns its initial state.
`Future<CreateSandboxSnapshotResponse>`	`createSandboxSnapshot(CreateSandboxSnapshotRequest request, AsyncHandler<CreateSandboxSnapshotRequest,CreateSandboxSnapshotResponse> handler)`	Creates a sandbox snapshot resource and returns its initial state.
`Future<DeleteSandboxResponse>`	`deleteSandbox(DeleteSandboxRequest request, AsyncHandler<DeleteSandboxRequest,DeleteSandboxResponse> handler)`	Deletes a sandbox.
`Future<DeleteSandboxSnapshotResponse>`	`deleteSandboxSnapshot(DeleteSandboxSnapshotRequest request, AsyncHandler<DeleteSandboxSnapshotRequest,DeleteSandboxSnapshotResponse> handler)`	Deletes a sandbox snapshot.
`void`	`enableDualStackEndpoints(boolean enableDualStackEndpoints)`	This method should be used to enable or disable the use of dual-stack endpoints.
`Future<ExtendSandboxResponse>`	`extendSandbox(ExtendSandboxRequest request, AsyncHandler<ExtendSandboxRequest,ExtendSandboxResponse> handler)`	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.
`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.
`Future<GetSandboxResponse>`	`getSandbox(GetSandboxRequest request, AsyncHandler<GetSandboxRequest,GetSandboxResponse> handler)`	Gets information about a sandbox.
`Future<GetSandboxCommandResponse>`	`getSandboxCommand(GetSandboxCommandRequest request, AsyncHandler<GetSandboxCommandRequest,GetSandboxCommandResponse> handler)`	Gets command metadata for a sandbox command.
`Future<GetSandboxCommandOutputResponse>`	`getSandboxCommandOutput(GetSandboxCommandOutputRequest request, AsyncHandler<GetSandboxCommandOutputRequest,GetSandboxCommandOutputResponse> handler)`	Gets captured output for a sandbox command starting from the requested event sequence.
`Future<GetSandboxSnapshotResponse>`	`getSandboxSnapshot(GetSandboxSnapshotRequest request, AsyncHandler<GetSandboxSnapshotRequest,GetSandboxSnapshotResponse> handler)`	Gets information about a sandbox snapshot.
`Future<ListSandboxCommandResponse>`	`listSandboxCommand(ListSandboxCommandRequest request, AsyncHandler<ListSandboxCommandRequest,ListSandboxCommandResponse> handler)`	Lists sandbox commands for a sandbox with optional pagination.
`Future<ListSandboxesResponse>`	`listSandboxes(ListSandboxesRequest request, AsyncHandler<ListSandboxesRequest,ListSandboxesResponse> handler)`	Lists sandbox resources with optional filtering and pagination.
`Future<ListSandboxSnapshotsResponse>`	`listSandboxSnapshots(ListSandboxSnapshotsRequest request, AsyncHandler<ListSandboxSnapshotsRequest,ListSandboxSnapshotsResponse> handler)`	Lists sandbox snapshot resources with optional filtering and pagination.
`Future<ReadSandboxFileResponse>`	`readSandboxFile(ReadSandboxFileRequest request, AsyncHandler<ReadSandboxFileRequest,ReadSandboxFileResponse> handler)`	Reads a file from a sandbox.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`Future<ResumeSandboxResponse>`	`resumeSandbox(ResumeSandboxRequest request, AsyncHandler<ResumeSandboxRequest,ResumeSandboxResponse> handler)`	Resumes a suspended sandbox by scaling its backing runtime back to one replica.
`Future<RunSandboxCommandResponse>`	`runSandboxCommand(RunSandboxCommandRequest request, AsyncHandler<RunSandboxCommandRequest,RunSandboxCommandResponse> handler)`	Runs a command in a sandbox and returns the command identifier immediately.
`Future<RunSandboxCommandAndStreamResponse>`	`runSandboxCommandAndStream(RunSandboxCommandAndStreamRequest request, AsyncHandler<RunSandboxCommandAndStreamRequest,RunSandboxCommandAndStreamResponse> handler)`	Runs a command in a sandbox and streams command events as newline-delimited JSON.
`Future<RunSandboxCommandAndWaitResponse>`	`runSandboxCommandAndWait(RunSandboxCommandAndWaitRequest request, AsyncHandler<RunSandboxCommandAndWaitRequest,RunSandboxCommandAndWaitResponse> handler)`	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’).
`Future<StopSandboxResponse>`	`stopSandbox(StopSandboxRequest request, AsyncHandler<StopSandboxRequest,StopSandboxResponse> handler)`	Stops a running sandbox.
`Future<StreamSandboxCommandEventsResponse>`	`streamSandboxCommandEvents(StreamSandboxCommandEventsRequest request, AsyncHandler<StreamSandboxCommandEventsRequest,StreamSandboxCommandEventsResponse> handler)`	Streams command events for an existing sandbox command from `fromSeq` through `untilSeq` using Server-Sent Events.
`Future<SuspendSandboxResponse>`	`suspendSandbox(SuspendSandboxRequest request, AsyncHandler<SuspendSandboxRequest,SuspendSandboxResponse> handler)`	Suspends a running sandbox by scaling its backing runtime to zero replicas while retaining the workspace block volume.
`Future<UpdateSandboxResponse>`	`updateSandbox(UpdateSandboxRequest request, AsyncHandler<UpdateSandboxRequest,UpdateSandboxResponse> handler)`	Updates a sandbox.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.
`Future<WriteSandboxFileResponse>`	`writeSandboxFile(WriteSandboxFileRequest request, AsyncHandler<WriteSandboxFileRequest,WriteSandboxFileResponse> handler)`	Writes a file in a sandbox and returns the resulting file resource.

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.GenerativeAiSandboxAsync
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
  - GenerativeAiSandboxAsyncClient
```
@Deprecated
public GenerativeAiSandboxAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - GenerativeAiSandboxAsyncClient
```
@Deprecated
public GenerativeAiSandboxAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - GenerativeAiSandboxAsyncClient
```
@Deprecated
public GenerativeAiSandboxAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - GenerativeAiSandboxAsyncClient
```
@Deprecated
public GenerativeAiSandboxAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                      ClientConfiguration configuration,
                                      ClientConfigurator clientConfigurator,
                                      RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see GenerativeAiSandboxAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - GenerativeAiSandboxAsyncClient
```
@Deprecated
public GenerativeAiSandboxAsyncClient(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 GenerativeAiSandboxAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - GenerativeAiSandboxAsyncClient
```
@Deprecated
public GenerativeAiSandboxAsyncClient(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 GenerativeAiSandboxAsyncClient.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)
  - GenerativeAiSandboxAsyncClient
```
@Deprecated
public GenerativeAiSandboxAsyncClient(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 GenerativeAiSandboxAsyncClient.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
- Method Detail
  - builder
```
public static GenerativeAiSandboxAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    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 GenerativeAiSandboxAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    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 GenerativeAiSandboxAsync
    
    Parameters:
    
    regionId - The public region ID.
  - cancelSandboxCommand
```
public Future<CancelSandboxCommandResponse> cancelSandboxCommand(CancelSandboxCommandRequest request,
                                                                 AsyncHandler<CancelSandboxCommandRequest,CancelSandboxCommandResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Requests cancellation of a running sandbox command.
    
    Specified by:
    
    cancelSandboxCommand in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createSandbox
```
public Future<CreateSandboxResponse> createSandbox(CreateSandboxRequest request,
                                                   AsyncHandler<CreateSandboxRequest,CreateSandboxResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Creates a sandbox resource and returns its initial state.
    
    Specified by:
    
    createSandbox in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - createSandboxSnapshot
```
public Future<CreateSandboxSnapshotResponse> createSandboxSnapshot(CreateSandboxSnapshotRequest request,
                                                                   AsyncHandler<CreateSandboxSnapshotRequest,CreateSandboxSnapshotResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Creates a sandbox snapshot resource and returns its initial state.
    
    Specified by:
    
    createSandboxSnapshot in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteSandbox
```
public Future<DeleteSandboxResponse> deleteSandbox(DeleteSandboxRequest request,
                                                   AsyncHandler<DeleteSandboxRequest,DeleteSandboxResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Deletes a sandbox.
    
    Specified by:
    
    deleteSandbox in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - deleteSandboxSnapshot
```
public Future<DeleteSandboxSnapshotResponse> deleteSandboxSnapshot(DeleteSandboxSnapshotRequest request,
                                                                   AsyncHandler<DeleteSandboxSnapshotRequest,DeleteSandboxSnapshotResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Deletes a sandbox snapshot.
    
    Specified by:
    
    deleteSandboxSnapshot in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - extendSandbox
```
public Future<ExtendSandboxResponse> extendSandbox(ExtendSandboxRequest request,
                                                   AsyncHandler<ExtendSandboxRequest,ExtendSandboxResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Extends the duration of a sandbox.
    
    Specified by:
    
    extendSandbox in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getSandbox
```
public Future<GetSandboxResponse> getSandbox(GetSandboxRequest request,
                                             AsyncHandler<GetSandboxRequest,GetSandboxResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Gets information about a sandbox.
    
    Specified by:
    
    getSandbox in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getSandboxCommand
```
public Future<GetSandboxCommandResponse> getSandboxCommand(GetSandboxCommandRequest request,
                                                           AsyncHandler<GetSandboxCommandRequest,GetSandboxCommandResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Gets command metadata for a sandbox command.
    
    Specified by:
    
    getSandboxCommand in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getSandboxCommandOutput
```
public Future<GetSandboxCommandOutputResponse> getSandboxCommandOutput(GetSandboxCommandOutputRequest request,
                                                                       AsyncHandler<GetSandboxCommandOutputRequest,GetSandboxCommandOutputResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Gets captured output for a sandbox command starting from the requested event sequence.
    
    Specified by:
    
    getSandboxCommandOutput in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - getSandboxSnapshot
```
public Future<GetSandboxSnapshotResponse> getSandboxSnapshot(GetSandboxSnapshotRequest request,
                                                             AsyncHandler<GetSandboxSnapshotRequest,GetSandboxSnapshotResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Gets information about a sandbox snapshot.
    
    Specified by:
    
    getSandboxSnapshot in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listSandboxCommand
```
public Future<ListSandboxCommandResponse> listSandboxCommand(ListSandboxCommandRequest request,
                                                             AsyncHandler<ListSandboxCommandRequest,ListSandboxCommandResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Lists sandbox commands for a sandbox with optional pagination.
    
    Specified by:
    
    listSandboxCommand in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listSandboxSnapshots
```
public Future<ListSandboxSnapshotsResponse> listSandboxSnapshots(ListSandboxSnapshotsRequest request,
                                                                 AsyncHandler<ListSandboxSnapshotsRequest,ListSandboxSnapshotsResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Lists sandbox snapshot resources with optional filtering and pagination.
    
    Specified by:
    
    listSandboxSnapshots in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - listSandboxes
```
public Future<ListSandboxesResponse> listSandboxes(ListSandboxesRequest request,
                                                   AsyncHandler<ListSandboxesRequest,ListSandboxesResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    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 GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - readSandboxFile
```
public Future<ReadSandboxFileResponse> readSandboxFile(ReadSandboxFileRequest request,
                                                       AsyncHandler<ReadSandboxFileRequest,ReadSandboxFileResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Reads a file from a sandbox.
    
    Specified by:
    
    readSandboxFile in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - resumeSandbox
```
public Future<ResumeSandboxResponse> resumeSandbox(ResumeSandboxRequest request,
                                                   AsyncHandler<ResumeSandboxRequest,ResumeSandboxResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Resumes a suspended sandbox by scaling its backing runtime back to one replica.
    
    Specified by:
    
    resumeSandbox in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - runSandboxCommand
```
public Future<RunSandboxCommandResponse> runSandboxCommand(RunSandboxCommandRequest request,
                                                           AsyncHandler<RunSandboxCommandRequest,RunSandboxCommandResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Runs a command in a sandbox and returns the command identifier immediately.
    
    Specified by:
    
    runSandboxCommand in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - runSandboxCommandAndStream
```
public Future<RunSandboxCommandAndStreamResponse> runSandboxCommandAndStream(RunSandboxCommandAndStreamRequest request,
                                                                             AsyncHandler<RunSandboxCommandAndStreamRequest,RunSandboxCommandAndStreamResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    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 GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - runSandboxCommandAndWait
```
public Future<RunSandboxCommandAndWaitResponse> runSandboxCommandAndWait(RunSandboxCommandAndWaitRequest request,
                                                                         AsyncHandler<RunSandboxCommandAndWaitRequest,RunSandboxCommandAndWaitResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Runs a command in a sandbox, blocks until command execution finishes, and returns the final command metadata.
    
    Specified by:
    
    runSandboxCommandAndWait in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - stopSandbox
```
public Future<StopSandboxResponse> stopSandbox(StopSandboxRequest request,
                                               AsyncHandler<StopSandboxRequest,StopSandboxResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Stops a running sandbox.
    
    Specified by:
    
    stopSandbox in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - streamSandboxCommandEvents
```
public Future<StreamSandboxCommandEventsResponse> streamSandboxCommandEvents(StreamSandboxCommandEventsRequest request,
                                                                             AsyncHandler<StreamSandboxCommandEventsRequest,StreamSandboxCommandEventsResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    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 GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - suspendSandbox
```
public Future<SuspendSandboxResponse> suspendSandbox(SuspendSandboxRequest request,
                                                     AsyncHandler<SuspendSandboxRequest,SuspendSandboxResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Suspends a running sandbox by scaling its backing runtime to zero replicas while retaining the workspace block volume.
    
    Specified by:
    
    suspendSandbox in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - updateSandbox
```
public Future<UpdateSandboxResponse> updateSandbox(UpdateSandboxRequest request,
                                                   AsyncHandler<UpdateSandboxRequest,UpdateSandboxResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Updates a sandbox.
    
    Specified by:
    
    updateSandbox in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - writeSandboxFile
```
public Future<WriteSandboxFileResponse> writeSandboxFile(WriteSandboxFileRequest request,
                                                         AsyncHandler<WriteSandboxFileRequest,WriteSandboxFileResponse> handler)
```
    Description copied from interface: GenerativeAiSandboxAsync
    
    Writes a file in a sandbox and returns the resulting file resource.
    
    Specified by:
    
    writeSandboxFile in interface GenerativeAiSandboxAsync
    
    Parameters:
    
    request - The request object containing the details to send
    
    handler - The request handler to invoke upon completion, may be null.
    
    Returns:
    
    A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.
  - 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()
```
  - clientCall
```
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)
```

Class GenerativeAiSandboxAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

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

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

GenerativeAiSandboxAsyncClient

GenerativeAiSandboxAsyncClient

GenerativeAiSandboxAsyncClient

GenerativeAiSandboxAsyncClient

GenerativeAiSandboxAsyncClient

GenerativeAiSandboxAsyncClient

GenerativeAiSandboxAsyncClient

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

getDefaultConfigurator

enableDualStackEndpoints

getOptionsMap

getResolvedEndpoint

useRealmSpecificEndpointTemplate

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient

clientCall