Namespace Oci.BatchService.Models
Classes
BatchContext
Representation of a batch context and its configurations.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to
an administrator. If you're an administrator who needs to write policies to give users access, see
Getting Started with Policies.
BatchContextCollection
Results of a batch context search. Contains both batch context summary items and other information, such as metadata.
BatchContextShapeCollection
A collection of container instance shapes.
BatchContextShapeSummary
Details about a shape for a container instance.
BatchContextSummary
Summary information about a batch context.
BatchJob
A batch job represents the execution unit that is invoked on a batch's pools of compute resources.
A job is composed of one or more tasks, which are the executable commands.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to
an administrator. If you're an administrator who needs to write policies to give users access, see
Getting Started with Policies.
BatchJobCollection
Results of a batch job search. Contains both batch job summary items and other information, such as metadata.
BatchJobPool
A batch job pool represents an abstract group for jobs.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to
an administrator. If you're an administrator who needs to write policies to give users access, see
Getting Started with Policies.
BatchJobPoolCollection
Results of a batch job pool search. Contains both batch job pool summary items and other information, such as metadata.
BatchJobPoolSummary
Summary information about a batch job pool.
BatchJobSummary
Summary information about a batch job.
BatchTask
A batch task contains common properties for all types of job tasks.
BatchTaskCollection
Results of a batch task search. Contains both batch task summary items and other information, such as metadata.
BatchTaskEnvironment
A batch task environment resource defines the software that is used to execute tasks.
It mainly contains a URL to a container image along with other configurations that are needed by the image.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to
an administrator. If you're an administrator who needs to write policies to give users access, see
Getting Started with Policies.
BatchTaskEnvironmentCollection
Results of a batch task environment search. Contains both batch task environment summary items and other information, such as metadata.
BatchTaskEnvironmentSummary
Summary information about a batch task environment.
BatchTaskEnvironmentVolume
A base type for volume for batch task environment.
BatchTaskEnvironmentVolumeModelConverter
BatchTaskExecutionDetails
Execution details for a batch task.
BatchTaskExecutionDetailsModelConverter
BatchTaskModelConverter
BatchTaskProfile
A batch task profile resource describes the minimum hardware requirements requested for a task.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to
an administrator. If you're an administrator who needs to write policies to give users access, see
Getting Started with Policies.
BatchTaskProfileCollection
Results of a batch task profile search. Contains both batch task profile summary items and other information, such as metadata.
BatchTaskProfileExtendedInformation
Extended information for the task profile.
BatchTaskProfileExtendedInformationModelConverter
BatchTaskProfileSummary
Summary information about a batch task profile.
BatchTaskSummary
Summary information about a batch task.
BatchTaskSummaryModelConverter
BestFitFleetAssignmentPolicy
The system will assign a task to the smallest sufficient fleet, with no flexibility for using larger fleets.
ChangeBatchContextCompartmentDetails
The configuration details for the move operation.
ChangeBatchJobCompartmentDetails
The configuration details for the move operation.
ChangeBatchJobPoolCompartmentDetails
The configuration details for the move operation.
ChangeBatchTaskEnvironmentCompartmentDetails
The configuration details for the move operation.
ChangeBatchTaskProfileCompartmentDetails
The configuration details for the move operation.
ComputeTask
compute task represents a single executable command together with its dependencies and resources.
ComputeTaskExecutionDetails
Execution details for a compute task.
ComputeTaskSummary
Summary information about a compute task.
CpuArchitectureTaskProfileExtendedInformation
Extended information about CPU architecture for the task profile.
CpuFleetShapeExecutionDetails
Details about the CPU shape which was used for the task execution.
CpuShapeTaskProfileExtendedInformation
Extended information for the CPU-specific task profile.
CreateBatchContextDetails
The data to create a batch context. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
CreateBatchJobDetails
The data to create a batch job. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
CreateBatchJobPoolDetails
The data to create a batch job pool. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
CreateBatchTaskDetails
A batch task contains common properties for all types of job tasks.
CreateBatchTaskDetailsModelConverter
CreateBatchTaskEnvironmentDetails
The data to create a batch task environment. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
CreateBatchTaskProfileDetails
The data to create a batch task profile. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
CreateBatchTaskProfileExtendedInformationDetails
Extended information for the task profile.
CreateBatchTaskProfileExtendedInformationDetailsModelConverter
CreateComputeTaskDetails
compute task represents a single executable command together with its dependencies and resources.
CreateCpuArchitectureTaskProfileExtendedInformationDetails
Extended information about CPU architecture for the task profile.
CreateCpuShapeTaskProfileExtendedInformationDetails
Extended information for the CPU-specific task profile.
CreateFixedGpuFleetShapeDetails
Fixed shape of the GPU fleet. Describes hardware resources of each node in the fleet.
CreateFleetDetails
Fleet configuration of the batch context.
CreateFleetDetailsModelConverter
CreateGpuFleetShapeDetails
Shape of the GPU fleet. Describes hardware resources of each node in the fleet.
CreateGpuFleetShapeDetailsModelConverter
CreateGpuShapeTaskProfileExtendedInformationDetails
Extended information for the GPU-specific task profile.
CreateGroupTaskDetails
Group task is a construct that represents a container of tasks for execution.
CreateNetworkDetails
Network configuration of the batch context.
CreateServiceManagedFleetDetails
Service managed Fleet configuration of the batch context.
CreateServiceManagedGpuFleetDetails
Service managed GPU Fleet configuration of the batch context.
EnvironmentVariable
OS environment variable.
FixedGpuFleetShape
Fixed shape of the GPU fleet. Describes hardware resources of each node in the fleet.
Fleet
Fleet configuration of the batch context.
FleetAssignmentPolicy
A fleet assignment policy provides instructions to the system as to how a task should be assigned to a fleet, given it's minimum hardware requirements.
FleetAssignmentPolicyModelConverter
FleetModelConverter
FleetShape
Shape of the fleet. Describes hardware resources of each node in the fleet.
FleetShapeExecutionDetails
Details about the shape which was used for the task execution.
FleetShapeExecutionDetailsModelConverter
FlexFitFleetAssignmentPolicy
Similar to best-fit, but with the ability for the system to use larger fleets if the smallest sufficient fleet is not available, up to a specified max shaped fleet, based on a user-configured threshold value.
GpuFleetShape
Shape of the GPU fleet. Describes hardware resources of each node in the fleet.
GpuFleetShapeExecutionDetails
Details about the GPU shape which was used for the task execution.
GpuFleetShapeModelConverter
GpuShapeTaskProfileExtendedInformation
Extended information for the GPU-specific task profile.
GroupTask
Group task is a construct that represents a container of tasks for execution.
GroupTaskSummary
Summary information about a group task.
JobPriorityConfiguration
Job priority configuration to instruct the service on how to use priority tags.
LoggingConfiguration
Logging configuration of the batch context.
LoggingConfigurationModelConverter
Network
Network configuration of the batch context.
NetworkSecurityGroup
VirtualNetwork service NetworkSecurityGroup
NfsVolume
A description of a NFS type of batch task environment volume.
OciLoggingConfiguration
Logging configuration for OCI Logging service.
PauseBatchJobDetails
Information needed to pause the batch job.
PrivateIp
VirtualNetwork service PrivateIp
SecurityContext
Security context for container runtime configuration.
See also docs.
ServiceManagedFleet
Service managed Fleet configuration of the batch context.
ServiceManagedGpuFleet
Service managed GPU Fleet configuration of the batch context.
ShapeMemoryOptions
The amount of memory available for container instances that use this shape.
ShapeNetworkingBandwidthOptions
For a flexible shape, the amount of networking bandwidth available for container instances that use this shape.
ShapeOcpuOptions
For a flexible shape, the number of OCPUs available for container instances that use this shape.
StartBatchContextDetails
Information needed to start the batch context.
StartBatchJobPoolDetails
Information needed to start the batch job pool.
StopBatchContextDetails
Information needed to stop the batch context.
StopBatchJobPoolDetails
Information needed to stop the batch job pool.
Subnet
VirtualNetwork service Subnet
UnpauseBatchJobDetails
Information needed to unpause the batch job.
UpdateBatchContextDetails
The data to update a batch context. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
UpdateBatchJobDetails
The data to update a batch job. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
UpdateBatchJobPoolDetails
The data to update a batch job pool. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
UpdateBatchTaskEnvironmentDetails
The data to update a batch task environment. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
UpdateBatchTaskProfileDetails
The data to update a batch task profile. If the value of a collection is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.
UpdateLoggingConfigurationDetails
The data to update logging configuration of the batch context.
UpdateLoggingConfigurationDetailsModelConverter
UpdateOciLoggingConfiguration
The data to update logging configuration for OCI Logging service.
VirtualNetworkVnic
VirtualNetwork service Vnic
Vnic
Private endpoint's VNIC.
WorkRequest
An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation, the service creates a work request. A work request is an activity log that lets you track each step in the operation's progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.
WorkRequestError
An error encountered while performing an operation that is tracked by a work request.
WorkRequestErrorCollection
A list of work request errors. Can contain both errors and other information, such as metadata.
WorkRequestLogEntry
A log message from performing an operation that is tracked by a work request.
WorkRequestLogEntryCollection
A list of work request logs. Can contain both logs and other information, such as metadata.
WorkRequestResource
A resource created or operated on by a work request.
WorkRequestSummary
Summary information about an asynchronous work request.
WorkRequestSummaryCollection
A list of work requests. Can contain both work requests and other information, such as metadata.
Enums
ActionType
Possible types of actions.
BatchContext.LifecycleStateEnum
BatchJob.LifecycleStateEnum
BatchJobPool.LifecycleStateEnum
BatchTask.LifecycleStateEnum
BatchTask.TypeEnum
BatchTaskEnvironment.LifecycleStateEnum
BatchTaskEnvironmentVolume.TypeEnum
BatchTaskExecutionDetails.TypeEnum
BatchTaskHierarchyView
Defines the hierarchical scope of the tasks to be returned. When set to SHALLOW, which is default, only tasks contained directly (non-recursively) within current hierarchy entry are returned. When set to DEEP, tasks contained within current hierarchy entry and all its descendants recursively are returned. The default hierarchy entry is root, i.e. batch job itself. To use a different hierarchy entry, provide the group task name as a query parameter. The specified group task becomes the entry point instead of the batch job.
BatchTaskProfile.LifecycleStateEnum
BatchTaskProfileExtendedInformation.TypeEnum
BatchTaskSortBy
The default field to use for sorting, (name).
CpuArchitectureTaskProfileExtendedInformation.ArchitectureEnum
CreateBatchTaskDetails.TypeEnum
CreateBatchTaskProfileExtendedInformationDetails.TypeEnum
CreateCpuArchitectureTaskProfileExtendedInformationDetails.ArchitectureEnum
CreateFleetDetails.TypeEnum
CreateGpuFleetShapeDetails.TypeEnum
Fleet.TypeEnum
FleetAssignmentPolicy.TypeEnum
FleetShapeExecutionDetails.TypeEnum
GpuFleetShape.TypeEnum
LoggingConfiguration.TypeEnum
OperationStatus
The status of the work request.
OperationType
The asynchronous operation tracked by the work request.
ShapeType
The type of a shape.
SortBy
The default field to use for sorting, either (timeCreated) or (displayName).
SortOrder
The sort order to use, either ascending (ASC) or descending (DESC). The displayName
sort order is case sensitive.
UpdateLoggingConfigurationDetails.TypeEnum
WorkRequestLogAndErrorSortBy
The default field to use for sorting, (timeCreated).
WorkRequestResourceMetadataKey
Possible metadata keys for work request resource metadata.
WorkRequestSortBy
The default field to use for sorting, (timeAccepted).