Show / Hide Table of Contents

Class GenerativeAiSandboxClient

Service client instance for GenerativeAiSandbox.

Inheritance
object
ClientBase
RegionalClientBase
GenerativeAiSandboxClient
Implements
IDisposable
Inherited Members
RegionalClientBase.logger
RegionalClientBase.SetRegion(Region)
RegionalClientBase.SetRegion(string)
RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)
RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
RegionalClientBase.parseEndpointForParameters(string)
ClientBase.restClient
ClientBase.service
ClientBase.userAgent
ClientBase.Dispose()
ClientBase.Dispose(bool)
ClientBase.SetEndpoint(string)
ClientBase.GetEndpoint()
ClientBase.GetUserAgent()
ClientBase.SetRealmSpecificEndpointTemplate(string)
ClientBase.EnableDualStackEndpoints(bool)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.GenerativeaisandboxService
Assembly: OCI.DotNetSDK.Generativeaisandbox.dll
Syntax
public class GenerativeAiSandboxClient : RegionalClientBase, IDisposable

Constructors

GenerativeAiSandboxClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration
public GenerativeAiSandboxClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type Name Description
IBasicAuthenticationDetailsProvider authenticationDetailsProvider

The authentication details provider. Required.

ClientConfiguration clientConfiguration

The client configuration that contains settings to adjust REST client behaviors. Optional.

string endpoint

The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration
public GenerativeAiSandboxPaginators Paginators { get; }
Property Value
Type Description
GenerativeAiSandboxPaginators

Waiters

Declaration
public GenerativeAiSandboxWaiters Waiters { get; }
Property Value
Type Description
GenerativeAiSandboxWaiters

Methods

CancelSandboxCommand(CancelSandboxCommandRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Requests cancellation of a running sandbox command.

Declaration
public Task<CancelSandboxCommandResponse> CancelSandboxCommand(CancelSandboxCommandRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelSandboxCommandRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CancelSandboxCommandResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelSandboxCommand API.

CreateSandbox(CreateSandboxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a sandbox resource and returns its initial state.

Declaration
public Task<CreateSandboxResponse> CreateSandbox(CreateSandboxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateSandboxRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateSandboxResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSandbox API.

CreateSandboxSnapshot(CreateSandboxSnapshotRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a sandbox snapshot resource and returns its initial state.

Declaration
public Task<CreateSandboxSnapshotResponse> CreateSandboxSnapshot(CreateSandboxSnapshotRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateSandboxSnapshotRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateSandboxSnapshotResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSandboxSnapshot API.

DeleteSandbox(DeleteSandboxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a sandbox.

Declaration
public Task<DeleteSandboxResponse> DeleteSandbox(DeleteSandboxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteSandboxRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteSandboxResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSandbox API.

DeleteSandboxSnapshot(DeleteSandboxSnapshotRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a sandbox snapshot.

Declaration
public Task<DeleteSandboxSnapshotResponse> DeleteSandboxSnapshot(DeleteSandboxSnapshotRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteSandboxSnapshotRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteSandboxSnapshotResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteSandboxSnapshot API.

ExtendSandbox(ExtendSandboxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Extends the duration of a sandbox.

Declaration
public Task<ExtendSandboxResponse> ExtendSandbox(ExtendSandboxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ExtendSandboxRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ExtendSandboxResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ExtendSandbox API.

GetSandbox(GetSandboxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a sandbox.

Declaration
public Task<GetSandboxResponse> GetSandbox(GetSandboxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSandboxRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetSandboxResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSandbox API.

GetSandboxCommand(GetSandboxCommandRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets command metadata for a sandbox command.

Declaration
public Task<GetSandboxCommandResponse> GetSandboxCommand(GetSandboxCommandRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSandboxCommandRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetSandboxCommandResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSandboxCommand API.

GetSandboxCommandOutput(GetSandboxCommandOutputRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets captured output for a sandbox command starting from the requested event sequence.

Declaration
public Task<GetSandboxCommandOutputResponse> GetSandboxCommandOutput(GetSandboxCommandOutputRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSandboxCommandOutputRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetSandboxCommandOutputResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSandboxCommandOutput API.

GetSandboxSnapshot(GetSandboxSnapshotRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a sandbox snapshot.

Declaration
public Task<GetSandboxSnapshotResponse> GetSandboxSnapshot(GetSandboxSnapshotRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetSandboxSnapshotRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetSandboxSnapshotResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSandboxSnapshot API.

ListSandboxCommand(ListSandboxCommandRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists sandbox commands for a sandbox with optional pagination.

Declaration
public Task<ListSandboxCommandResponse> ListSandboxCommand(ListSandboxCommandRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSandboxCommandRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListSandboxCommandResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSandboxCommand API.

ListSandboxSnapshots(ListSandboxSnapshotsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists sandbox snapshot resources with optional filtering and pagination.

Declaration
public Task<ListSandboxSnapshotsResponse> ListSandboxSnapshots(ListSandboxSnapshotsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSandboxSnapshotsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListSandboxSnapshotsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSandboxSnapshots API.

ListSandboxes(ListSandboxesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration
public Task<ListSandboxesResponse> ListSandboxes(ListSandboxesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListSandboxesRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListSandboxesResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSandboxes API.

ReadSandboxFile(ReadSandboxFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Reads a file from a sandbox.

Declaration
public Task<ReadSandboxFileResponse> ReadSandboxFile(ReadSandboxFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ReadSandboxFileRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ReadSandboxFileResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ReadSandboxFile API.

ResumeSandbox(ResumeSandboxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Resumes a suspended sandbox by scaling its backing runtime back to one replica.

Declaration
public Task<ResumeSandboxResponse> ResumeSandbox(ResumeSandboxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ResumeSandboxRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ResumeSandboxResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ResumeSandbox API.

RunSandboxCommand(RunSandboxCommandRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Runs a command in a sandbox and returns the command identifier immediately.

Declaration
public Task<RunSandboxCommandResponse> RunSandboxCommand(RunSandboxCommandRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RunSandboxCommandRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<RunSandboxCommandResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RunSandboxCommand API.

RunSandboxCommandAndStream(RunSandboxCommandAndStreamRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Runs a command in a sandbox and streams command events as newline-delimited JSON. Each line is a serialized SandboxCommandEvent.

Declaration
public Task<RunSandboxCommandAndStreamResponse> RunSandboxCommandAndStream(RunSandboxCommandAndStreamRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RunSandboxCommandAndStreamRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<RunSandboxCommandAndStreamResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RunSandboxCommandAndStream API.

RunSandboxCommandAndWait(RunSandboxCommandAndWaitRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Runs a command in a sandbox, blocks until command execution finishes, and returns the final command metadata.

Declaration
public Task<RunSandboxCommandAndWaitResponse> RunSandboxCommandAndWait(RunSandboxCommandAndWaitRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RunSandboxCommandAndWaitRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<RunSandboxCommandAndWaitResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use RunSandboxCommandAndWait API.

StopSandbox(StopSandboxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stops a running sandbox.

Declaration
public Task<StopSandboxResponse> StopSandbox(StopSandboxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StopSandboxRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<StopSandboxResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use StopSandbox API.

StreamSandboxCommandEvents(StreamSandboxCommandEventsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Streams command events for an existing sandbox command from fromSeq through untilSeq using Server-Sent Events. Each SSE data field contains a serialized SandboxCommandEvent.

Declaration
public Task<StreamSandboxCommandEventsResponse> StreamSandboxCommandEvents(StreamSandboxCommandEventsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StreamSandboxCommandEventsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<StreamSandboxCommandEventsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use StreamSandboxCommandEvents API.

SuspendSandbox(SuspendSandboxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Suspends a running sandbox by scaling its backing runtime to zero replicas while retaining the workspace block volume.

Declaration
public Task<SuspendSandboxResponse> SuspendSandbox(SuspendSandboxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
SuspendSandboxRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<SuspendSandboxResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use SuspendSandbox API.

UpdateSandbox(UpdateSandboxRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a sandbox.

Declaration
public Task<UpdateSandboxResponse> UpdateSandbox(UpdateSandboxRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateSandboxRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateSandboxResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSandbox API.

WriteSandboxFile(WriteSandboxFileRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Writes a file in a sandbox and returns the resulting file resource.

Declaration
public Task<WriteSandboxFileResponse> WriteSandboxFile(WriteSandboxFileRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
WriteSandboxFileRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<WriteSandboxFileResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use WriteSandboxFile API.

Implements

IDisposable
In this article
Back to top