batch

package
v65.121.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 21, 2026 License: Apache-2.0, UPL-1.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetActionTypeEnumStringValues

func GetActionTypeEnumStringValues() []string

GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum

func GetBatchContextLifecycleStateEnumStringValues

func GetBatchContextLifecycleStateEnumStringValues() []string

GetBatchContextLifecycleStateEnumStringValues Enumerates the set of values in String for BatchContextLifecycleStateEnum

func GetBatchJobLifecycleStateEnumStringValues

func GetBatchJobLifecycleStateEnumStringValues() []string

GetBatchJobLifecycleStateEnumStringValues Enumerates the set of values in String for BatchJobLifecycleStateEnum

func GetBatchJobPoolLifecycleStateEnumStringValues

func GetBatchJobPoolLifecycleStateEnumStringValues() []string

GetBatchJobPoolLifecycleStateEnumStringValues Enumerates the set of values in String for BatchJobPoolLifecycleStateEnum

func GetBatchTaskEnvironmentLifecycleStateEnumStringValues

func GetBatchTaskEnvironmentLifecycleStateEnumStringValues() []string

GetBatchTaskEnvironmentLifecycleStateEnumStringValues Enumerates the set of values in String for BatchTaskEnvironmentLifecycleStateEnum

func GetBatchTaskEnvironmentVolumeTypeEnumStringValues

func GetBatchTaskEnvironmentVolumeTypeEnumStringValues() []string

GetBatchTaskEnvironmentVolumeTypeEnumStringValues Enumerates the set of values in String for BatchTaskEnvironmentVolumeTypeEnum

func GetBatchTaskExecutionDetailsTypeEnumStringValues added in v65.114.0

func GetBatchTaskExecutionDetailsTypeEnumStringValues() []string

GetBatchTaskExecutionDetailsTypeEnumStringValues Enumerates the set of values in String for BatchTaskExecutionDetailsTypeEnum

func GetBatchTaskHierarchyViewEnumStringValues added in v65.114.0

func GetBatchTaskHierarchyViewEnumStringValues() []string

GetBatchTaskHierarchyViewEnumStringValues Enumerates the set of values in String for BatchTaskHierarchyViewEnum

func GetBatchTaskLifecycleStateEnumStringValues

func GetBatchTaskLifecycleStateEnumStringValues() []string

GetBatchTaskLifecycleStateEnumStringValues Enumerates the set of values in String for BatchTaskLifecycleStateEnum

func GetBatchTaskProfileExtendedInformationTypeEnumStringValues added in v65.114.0

func GetBatchTaskProfileExtendedInformationTypeEnumStringValues() []string

GetBatchTaskProfileExtendedInformationTypeEnumStringValues Enumerates the set of values in String for BatchTaskProfileExtendedInformationTypeEnum

func GetBatchTaskProfileLifecycleStateEnumStringValues

func GetBatchTaskProfileLifecycleStateEnumStringValues() []string

GetBatchTaskProfileLifecycleStateEnumStringValues Enumerates the set of values in String for BatchTaskProfileLifecycleStateEnum

func GetBatchTaskSortByEnumStringValues

func GetBatchTaskSortByEnumStringValues() []string

GetBatchTaskSortByEnumStringValues Enumerates the set of values in String for BatchTaskSortByEnum

func GetBatchTaskTypeEnumStringValues

func GetBatchTaskTypeEnumStringValues() []string

GetBatchTaskTypeEnumStringValues Enumerates the set of values in String for BatchTaskTypeEnum

func GetCpuArchitectureTaskProfileExtendedInformationArchitectureEnumStringValues added in v65.114.0

func GetCpuArchitectureTaskProfileExtendedInformationArchitectureEnumStringValues() []string

GetCpuArchitectureTaskProfileExtendedInformationArchitectureEnumStringValues Enumerates the set of values in String for CpuArchitectureTaskProfileExtendedInformationArchitectureEnum

func GetCreateBatchTaskDetailsTypeEnumStringValues

func GetCreateBatchTaskDetailsTypeEnumStringValues() []string

GetCreateBatchTaskDetailsTypeEnumStringValues Enumerates the set of values in String for CreateBatchTaskDetailsTypeEnum

func GetCreateBatchTaskProfileExtendedInformationDetailsTypeEnumStringValues added in v65.114.0

func GetCreateBatchTaskProfileExtendedInformationDetailsTypeEnumStringValues() []string

GetCreateBatchTaskProfileExtendedInformationDetailsTypeEnumStringValues Enumerates the set of values in String for CreateBatchTaskProfileExtendedInformationDetailsTypeEnum

func GetCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnumStringValues added in v65.114.0

func GetCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnumStringValues() []string

GetCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnumStringValues Enumerates the set of values in String for CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum

func GetCreateFleetDetailsTypeEnumStringValues

func GetCreateFleetDetailsTypeEnumStringValues() []string

GetCreateFleetDetailsTypeEnumStringValues Enumerates the set of values in String for CreateFleetDetailsTypeEnum

func GetCreateGpuFleetShapeDetailsTypeEnumStringValues added in v65.114.0

func GetCreateGpuFleetShapeDetailsTypeEnumStringValues() []string

GetCreateGpuFleetShapeDetailsTypeEnumStringValues Enumerates the set of values in String for CreateGpuFleetShapeDetailsTypeEnum

func GetFleetAssignmentPolicyTypeEnumStringValues

func GetFleetAssignmentPolicyTypeEnumStringValues() []string

GetFleetAssignmentPolicyTypeEnumStringValues Enumerates the set of values in String for FleetAssignmentPolicyTypeEnum

func GetFleetShapeExecutionDetailsTypeEnumStringValues added in v65.114.0

func GetFleetShapeExecutionDetailsTypeEnumStringValues() []string

GetFleetShapeExecutionDetailsTypeEnumStringValues Enumerates the set of values in String for FleetShapeExecutionDetailsTypeEnum

func GetFleetTypeEnumStringValues

func GetFleetTypeEnumStringValues() []string

GetFleetTypeEnumStringValues Enumerates the set of values in String for FleetTypeEnum

func GetGpuFleetShapeTypeEnumStringValues added in v65.114.0

func GetGpuFleetShapeTypeEnumStringValues() []string

GetGpuFleetShapeTypeEnumStringValues Enumerates the set of values in String for GpuFleetShapeTypeEnum

func GetListBatchContextShapesShapeTypeEnumStringValues added in v65.114.0

func GetListBatchContextShapesShapeTypeEnumStringValues() []string

GetListBatchContextShapesShapeTypeEnumStringValues Enumerates the set of values in String for ListBatchContextShapesShapeTypeEnum

func GetListBatchContextsSortByEnumStringValues

func GetListBatchContextsSortByEnumStringValues() []string

GetListBatchContextsSortByEnumStringValues Enumerates the set of values in String for ListBatchContextsSortByEnum

func GetListBatchContextsSortOrderEnumStringValues

func GetListBatchContextsSortOrderEnumStringValues() []string

GetListBatchContextsSortOrderEnumStringValues Enumerates the set of values in String for ListBatchContextsSortOrderEnum

func GetListBatchJobPoolsSortByEnumStringValues

func GetListBatchJobPoolsSortByEnumStringValues() []string

GetListBatchJobPoolsSortByEnumStringValues Enumerates the set of values in String for ListBatchJobPoolsSortByEnum

func GetListBatchJobPoolsSortOrderEnumStringValues

func GetListBatchJobPoolsSortOrderEnumStringValues() []string

GetListBatchJobPoolsSortOrderEnumStringValues Enumerates the set of values in String for ListBatchJobPoolsSortOrderEnum

func GetListBatchJobTasksHierarchyViewEnumStringValues added in v65.114.0

func GetListBatchJobTasksHierarchyViewEnumStringValues() []string

GetListBatchJobTasksHierarchyViewEnumStringValues Enumerates the set of values in String for ListBatchJobTasksHierarchyViewEnum

func GetListBatchJobTasksSortByEnumStringValues

func GetListBatchJobTasksSortByEnumStringValues() []string

GetListBatchJobTasksSortByEnumStringValues Enumerates the set of values in String for ListBatchJobTasksSortByEnum

func GetListBatchJobTasksSortOrderEnumStringValues

func GetListBatchJobTasksSortOrderEnumStringValues() []string

GetListBatchJobTasksSortOrderEnumStringValues Enumerates the set of values in String for ListBatchJobTasksSortOrderEnum

func GetListBatchJobsSortByEnumStringValues

func GetListBatchJobsSortByEnumStringValues() []string

GetListBatchJobsSortByEnumStringValues Enumerates the set of values in String for ListBatchJobsSortByEnum

func GetListBatchJobsSortOrderEnumStringValues

func GetListBatchJobsSortOrderEnumStringValues() []string

GetListBatchJobsSortOrderEnumStringValues Enumerates the set of values in String for ListBatchJobsSortOrderEnum

func GetListBatchTaskEnvironmentsSortByEnumStringValues

func GetListBatchTaskEnvironmentsSortByEnumStringValues() []string

GetListBatchTaskEnvironmentsSortByEnumStringValues Enumerates the set of values in String for ListBatchTaskEnvironmentsSortByEnum

func GetListBatchTaskEnvironmentsSortOrderEnumStringValues

func GetListBatchTaskEnvironmentsSortOrderEnumStringValues() []string

GetListBatchTaskEnvironmentsSortOrderEnumStringValues Enumerates the set of values in String for ListBatchTaskEnvironmentsSortOrderEnum

func GetListBatchTaskProfilesSortByEnumStringValues

func GetListBatchTaskProfilesSortByEnumStringValues() []string

GetListBatchTaskProfilesSortByEnumStringValues Enumerates the set of values in String for ListBatchTaskProfilesSortByEnum

func GetListBatchTaskProfilesSortOrderEnumStringValues

func GetListBatchTaskProfilesSortOrderEnumStringValues() []string

GetListBatchTaskProfilesSortOrderEnumStringValues Enumerates the set of values in String for ListBatchTaskProfilesSortOrderEnum

func GetListBatchTasksSortByEnumStringValues

func GetListBatchTasksSortByEnumStringValues() []string

GetListBatchTasksSortByEnumStringValues Enumerates the set of values in String for ListBatchTasksSortByEnum

func GetListBatchTasksSortOrderEnumStringValues

func GetListBatchTasksSortOrderEnumStringValues() []string

GetListBatchTasksSortOrderEnumStringValues Enumerates the set of values in String for ListBatchTasksSortOrderEnum

func GetListWorkRequestErrorsSortByEnumStringValues

func GetListWorkRequestErrorsSortByEnumStringValues() []string

GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortOrderEnumStringValues

func GetListWorkRequestErrorsSortOrderEnumStringValues() []string

GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestLogsSortByEnumStringValues

func GetListWorkRequestLogsSortByEnumStringValues() []string

GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortOrderEnumStringValues

func GetListWorkRequestLogsSortOrderEnumStringValues() []string

GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestsSortByEnumStringValues

func GetListWorkRequestsSortByEnumStringValues() []string

GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortOrderEnumStringValues

func GetListWorkRequestsSortOrderEnumStringValues() []string

GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsStatusEnumStringValues

func GetListWorkRequestsStatusEnumStringValues() []string

GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum

func GetLoggingConfigurationTypeEnumStringValues

func GetLoggingConfigurationTypeEnumStringValues() []string

GetLoggingConfigurationTypeEnumStringValues Enumerates the set of values in String for LoggingConfigurationTypeEnum

func GetOperationStatusEnumStringValues

func GetOperationStatusEnumStringValues() []string

GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum

func GetOperationTypeEnumStringValues

func GetOperationTypeEnumStringValues() []string

GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum

func GetShapeTypeEnumStringValues added in v65.114.0

func GetShapeTypeEnumStringValues() []string

GetShapeTypeEnumStringValues Enumerates the set of values in String for ShapeTypeEnum

func GetSortByEnumStringValues

func GetSortByEnumStringValues() []string

GetSortByEnumStringValues Enumerates the set of values in String for SortByEnum

func GetSortOrderEnumStringValues

func GetSortOrderEnumStringValues() []string

GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum

func GetUpdateLoggingConfigurationDetailsTypeEnumStringValues added in v65.114.0

func GetUpdateLoggingConfigurationDetailsTypeEnumStringValues() []string

GetUpdateLoggingConfigurationDetailsTypeEnumStringValues Enumerates the set of values in String for UpdateLoggingConfigurationDetailsTypeEnum

func GetWorkRequestLogAndErrorSortByEnumStringValues

func GetWorkRequestLogAndErrorSortByEnumStringValues() []string

GetWorkRequestLogAndErrorSortByEnumStringValues Enumerates the set of values in String for WorkRequestLogAndErrorSortByEnum

func GetWorkRequestResourceMetadataKeyEnumStringValues

func GetWorkRequestResourceMetadataKeyEnumStringValues() []string

GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum

func GetWorkRequestSortByEnumStringValues

func GetWorkRequestSortByEnumStringValues() []string

GetWorkRequestSortByEnumStringValues Enumerates the set of values in String for WorkRequestSortByEnum

Types

type ActionTypeEnum

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string

const (
	ActionTypeCreated    ActionTypeEnum = "CREATED"
	ActionTypeUpdated    ActionTypeEnum = "UPDATED"
	ActionTypeDeleted    ActionTypeEnum = "DELETED"
	ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
	ActionTypeRelated    ActionTypeEnum = "RELATED"
	ActionTypeFailed     ActionTypeEnum = "FAILED"
)

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

func GetMappingActionTypeEnum

func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)

GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchComputingClient

type BatchComputingClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

BatchComputingClient a client for BatchComputing

func NewBatchComputingClientWithConfigurationProvider

func NewBatchComputingClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client BatchComputingClient, err error)

NewBatchComputingClientWithConfigurationProvider Creates a new default BatchComputing client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewBatchComputingClientWithOboToken

func NewBatchComputingClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client BatchComputingClient, err error)

NewBatchComputingClientWithOboToken Creates a new default BatchComputing client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer

as well as reading the region

func (BatchComputingClient) CancelBatchJob

func (client BatchComputingClient) CancelBatchJob(ctx context.Context, request CancelBatchJobRequest) (response CancelBatchJobResponse, err error)

CancelBatchJob Cancels a batch job.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CancelBatchJob.go.html to see an example of how to use CancelBatchJob API. A default retry strategy applies to this operation CancelBatchJob()

func (BatchComputingClient) ChangeBatchContextCompartment

func (client BatchComputingClient) ChangeBatchContextCompartment(ctx context.Context, request ChangeBatchContextCompartmentRequest) (response ChangeBatchContextCompartmentResponse, err error)

ChangeBatchContextCompartment Moves a batch context into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchContextCompartment.go.html to see an example of how to use ChangeBatchContextCompartment API. A default retry strategy applies to this operation ChangeBatchContextCompartment()

func (BatchComputingClient) ChangeBatchJobCompartment

func (client BatchComputingClient) ChangeBatchJobCompartment(ctx context.Context, request ChangeBatchJobCompartmentRequest) (response ChangeBatchJobCompartmentResponse, err error)

ChangeBatchJobCompartment Moves a batch job into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchJobCompartment.go.html to see an example of how to use ChangeBatchJobCompartment API. A default retry strategy applies to this operation ChangeBatchJobCompartment()

func (BatchComputingClient) ChangeBatchJobPoolCompartment

func (client BatchComputingClient) ChangeBatchJobPoolCompartment(ctx context.Context, request ChangeBatchJobPoolCompartmentRequest) (response ChangeBatchJobPoolCompartmentResponse, err error)

ChangeBatchJobPoolCompartment Moves a batch job pool into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchJobPoolCompartment.go.html to see an example of how to use ChangeBatchJobPoolCompartment API. A default retry strategy applies to this operation ChangeBatchJobPoolCompartment()

func (BatchComputingClient) ChangeBatchTaskEnvironmentCompartment

func (client BatchComputingClient) ChangeBatchTaskEnvironmentCompartment(ctx context.Context, request ChangeBatchTaskEnvironmentCompartmentRequest) (response ChangeBatchTaskEnvironmentCompartmentResponse, err error)

ChangeBatchTaskEnvironmentCompartment Moves a batch task environment into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchTaskEnvironmentCompartment.go.html to see an example of how to use ChangeBatchTaskEnvironmentCompartment API. A default retry strategy applies to this operation ChangeBatchTaskEnvironmentCompartment()

func (BatchComputingClient) ChangeBatchTaskProfileCompartment

func (client BatchComputingClient) ChangeBatchTaskProfileCompartment(ctx context.Context, request ChangeBatchTaskProfileCompartmentRequest) (response ChangeBatchTaskProfileCompartmentResponse, err error)

ChangeBatchTaskProfileCompartment Moves a batch task profile into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment (https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchTaskProfileCompartment.go.html to see an example of how to use ChangeBatchTaskProfileCompartment API. A default retry strategy applies to this operation ChangeBatchTaskProfileCompartment()

func (*BatchComputingClient) ConfigurationProvider

func (client *BatchComputingClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (BatchComputingClient) CreateBatchContext

func (client BatchComputingClient) CreateBatchContext(ctx context.Context, request CreateBatchContextRequest) (response CreateBatchContextResponse, err error)

CreateBatchContext Creates a batch context.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchContext.go.html to see an example of how to use CreateBatchContext API. A default retry strategy applies to this operation CreateBatchContext()

func (BatchComputingClient) CreateBatchJob

func (client BatchComputingClient) CreateBatchJob(ctx context.Context, request CreateBatchJobRequest) (response CreateBatchJobResponse, err error)

CreateBatchJob Creates a batch job.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchJob.go.html to see an example of how to use CreateBatchJob API. A default retry strategy applies to this operation CreateBatchJob()

func (BatchComputingClient) CreateBatchJobPool

func (client BatchComputingClient) CreateBatchJobPool(ctx context.Context, request CreateBatchJobPoolRequest) (response CreateBatchJobPoolResponse, err error)

CreateBatchJobPool Creates a batch job pool.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchJobPool.go.html to see an example of how to use CreateBatchJobPool API. A default retry strategy applies to this operation CreateBatchJobPool()

func (BatchComputingClient) CreateBatchTaskEnvironment

func (client BatchComputingClient) CreateBatchTaskEnvironment(ctx context.Context, request CreateBatchTaskEnvironmentRequest) (response CreateBatchTaskEnvironmentResponse, err error)

CreateBatchTaskEnvironment Creates a batch task environment.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchTaskEnvironment.go.html to see an example of how to use CreateBatchTaskEnvironment API. A default retry strategy applies to this operation CreateBatchTaskEnvironment()

func (BatchComputingClient) CreateBatchTaskProfile

func (client BatchComputingClient) CreateBatchTaskProfile(ctx context.Context, request CreateBatchTaskProfileRequest) (response CreateBatchTaskProfileResponse, err error)

CreateBatchTaskProfile Creates a batch task profile.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchTaskProfile.go.html to see an example of how to use CreateBatchTaskProfile API. A default retry strategy applies to this operation CreateBatchTaskProfile()

func (BatchComputingClient) DeleteBatchContext

func (client BatchComputingClient) DeleteBatchContext(ctx context.Context, request DeleteBatchContextRequest) (response DeleteBatchContextResponse, err error)

DeleteBatchContext Deletes a batch context. All batch job pools associated with the batch context must be deleted beforehand.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/DeleteBatchContext.go.html to see an example of how to use DeleteBatchContext API. A default retry strategy applies to this operation DeleteBatchContext()

func (BatchComputingClient) DeleteBatchJobPool

func (client BatchComputingClient) DeleteBatchJobPool(ctx context.Context, request DeleteBatchJobPoolRequest) (response DeleteBatchJobPoolResponse, err error)

DeleteBatchJobPool Deletes a batch job pool. All batch jobs associated with the batch job pool must be canceled beforehand.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/DeleteBatchJobPool.go.html to see an example of how to use DeleteBatchJobPool API. A default retry strategy applies to this operation DeleteBatchJobPool()

func (BatchComputingClient) DeleteBatchTaskEnvironment

func (client BatchComputingClient) DeleteBatchTaskEnvironment(ctx context.Context, request DeleteBatchTaskEnvironmentRequest) (response DeleteBatchTaskEnvironmentResponse, err error)

DeleteBatchTaskEnvironment Deletes a batch task environment. All batch tasks associated with the batch task environment must be canceled beforehand.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/DeleteBatchTaskEnvironment.go.html to see an example of how to use DeleteBatchTaskEnvironment API. A default retry strategy applies to this operation DeleteBatchTaskEnvironment()

func (BatchComputingClient) DeleteBatchTaskProfile

func (client BatchComputingClient) DeleteBatchTaskProfile(ctx context.Context, request DeleteBatchTaskProfileRequest) (response DeleteBatchTaskProfileResponse, err error)

DeleteBatchTaskProfile Deletes a batch task profile. All batch tasks associated with the batch task profile must be canceled beforehand.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/DeleteBatchTaskProfile.go.html to see an example of how to use DeleteBatchTaskProfile API. A default retry strategy applies to this operation DeleteBatchTaskProfile()

func (BatchComputingClient) GetBatchContext

func (client BatchComputingClient) GetBatchContext(ctx context.Context, request GetBatchContextRequest) (response GetBatchContextResponse, err error)

GetBatchContext Gets information about a batch context.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchContext.go.html to see an example of how to use GetBatchContext API. A default retry strategy applies to this operation GetBatchContext()

func (BatchComputingClient) GetBatchJob

func (client BatchComputingClient) GetBatchJob(ctx context.Context, request GetBatchJobRequest) (response GetBatchJobResponse, err error)

GetBatchJob Gets information about a batch job.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchJob.go.html to see an example of how to use GetBatchJob API. A default retry strategy applies to this operation GetBatchJob()

func (BatchComputingClient) GetBatchJobPool

func (client BatchComputingClient) GetBatchJobPool(ctx context.Context, request GetBatchJobPoolRequest) (response GetBatchJobPoolResponse, err error)

GetBatchJobPool Gets information about a batch job pool.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchJobPool.go.html to see an example of how to use GetBatchJobPool API. A default retry strategy applies to this operation GetBatchJobPool()

func (BatchComputingClient) GetBatchTask

func (client BatchComputingClient) GetBatchTask(ctx context.Context, request GetBatchTaskRequest) (response GetBatchTaskResponse, err error)

GetBatchTask Gets a specific batch task associated with a batch job by its name.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchTask.go.html to see an example of how to use GetBatchTask API. A default retry strategy applies to this operation GetBatchTask()

func (BatchComputingClient) GetBatchTaskEnvironment

func (client BatchComputingClient) GetBatchTaskEnvironment(ctx context.Context, request GetBatchTaskEnvironmentRequest) (response GetBatchTaskEnvironmentResponse, err error)

GetBatchTaskEnvironment Gets information about a batch task environment.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchTaskEnvironment.go.html to see an example of how to use GetBatchTaskEnvironment API. A default retry strategy applies to this operation GetBatchTaskEnvironment()

func (BatchComputingClient) GetBatchTaskProfile

func (client BatchComputingClient) GetBatchTaskProfile(ctx context.Context, request GetBatchTaskProfileRequest) (response GetBatchTaskProfileResponse, err error)

GetBatchTaskProfile Gets information about a batch task profile.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchTaskProfile.go.html to see an example of how to use GetBatchTaskProfile API. A default retry strategy applies to this operation GetBatchTaskProfile()

func (BatchComputingClient) GetWorkRequest

func (client BatchComputingClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)

GetWorkRequest Gets the details of a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()

func (BatchComputingClient) ListBatchContextShapes

func (client BatchComputingClient) ListBatchContextShapes(ctx context.Context, request ListBatchContextShapesRequest) (response ListBatchContextShapesResponse, err error)

ListBatchContextShapes Lists the shapes allowed to be specified during batch context creation. Ordered by the shape name.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchContextShapes.go.html to see an example of how to use ListBatchContextShapes API. A default retry strategy applies to this operation ListBatchContextShapes()

func (BatchComputingClient) ListBatchContexts

func (client BatchComputingClient) ListBatchContexts(ctx context.Context, request ListBatchContextsRequest) (response ListBatchContextsResponse, err error)

ListBatchContexts Lists the batch contexts by compartment or context OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchContext to get the full details on a specific context

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchContexts.go.html to see an example of how to use ListBatchContexts API. A default retry strategy applies to this operation ListBatchContexts()

func (BatchComputingClient) ListBatchJobPools

func (client BatchComputingClient) ListBatchJobPools(ctx context.Context, request ListBatchJobPoolsRequest) (response ListBatchJobPoolsResponse, err error)

ListBatchJobPools Lists the batch job pools by compartment or job pool OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJobPool to get the full details on a specific context

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchJobPools.go.html to see an example of how to use ListBatchJobPools API. A default retry strategy applies to this operation ListBatchJobPools()

func (BatchComputingClient) ListBatchJobTasks

func (client BatchComputingClient) ListBatchJobTasks(ctx context.Context, request ListBatchJobTasksRequest) (response ListBatchJobTasksResponse, err error)

ListBatchJobTasks Lists the batch tasks by batch job OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTask to get the full details on a specific context List is incomplete until jobs lifecycle is in_progress

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchJobTasks.go.html to see an example of how to use ListBatchJobTasks API. A default retry strategy applies to this operation ListBatchJobTasks()

func (BatchComputingClient) ListBatchJobs

func (client BatchComputingClient) ListBatchJobs(ctx context.Context, request ListBatchJobsRequest) (response ListBatchJobsResponse, err error)

ListBatchJobs Lists the batch jobs by compartment or job OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchJob to get the full details on a specific context

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchJobs.go.html to see an example of how to use ListBatchJobs API. A default retry strategy applies to this operation ListBatchJobs()

func (BatchComputingClient) ListBatchTaskEnvironments

func (client BatchComputingClient) ListBatchTaskEnvironments(ctx context.Context, request ListBatchTaskEnvironmentsRequest) (response ListBatchTaskEnvironmentsResponse, err error)

ListBatchTaskEnvironments Lists the task environments by compartment or environment OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, display name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskEnvironment to get the full details on a specific context

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchTaskEnvironments.go.html to see an example of how to use ListBatchTaskEnvironments API. A default retry strategy applies to this operation ListBatchTaskEnvironments()

func (BatchComputingClient) ListBatchTaskProfiles

func (client BatchComputingClient) ListBatchTaskProfiles(ctx context.Context, request ListBatchTaskProfilesRequest) (response ListBatchTaskProfilesResponse, err error)

ListBatchTaskProfiles Lists the task profiles by compartment or profile OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can filter and sort them by various properties like lifecycle state, name and also ocid. All properties require an exact match. List operation only provides a summary information, use GetBatchTaskProfile to get the full details on a specific context

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchTaskProfiles.go.html to see an example of how to use ListBatchTaskProfiles API. A default retry strategy applies to this operation ListBatchTaskProfiles()

func (BatchComputingClient) ListBatchTasks

func (client BatchComputingClient) ListBatchTasks(ctx context.Context, request ListBatchTasksRequest) (response ListBatchTasksResponse, err error)

ListBatchTasks Lists the batch tasks associated with batch jobs.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchTasks.go.html to see an example of how to use ListBatchTasks API. A default retry strategy applies to this operation ListBatchTasks()

func (BatchComputingClient) ListWorkRequestErrors

func (client BatchComputingClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)

ListWorkRequestErrors Lists the errors for a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()

func (BatchComputingClient) ListWorkRequestLogs

func (client BatchComputingClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)

ListWorkRequestLogs Lists the logs for a work request.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()

func (BatchComputingClient) ListWorkRequests

func (client BatchComputingClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()

func (BatchComputingClient) PauseBatchJob

func (client BatchComputingClient) PauseBatchJob(ctx context.Context, request PauseBatchJobRequest) (response PauseBatchJobResponse, err error)

PauseBatchJob Pauses the batch job and all its tasks.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/PauseBatchJob.go.html to see an example of how to use PauseBatchJob API. A default retry strategy applies to this operation PauseBatchJob()

func (*BatchComputingClient) SetRegion

func (client *BatchComputingClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (BatchComputingClient) StartBatchContext

func (client BatchComputingClient) StartBatchContext(ctx context.Context, request StartBatchContextRequest) (response StartBatchContextResponse, err error)

StartBatchContext Activates a batch context to accept new jobs.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/StartBatchContext.go.html to see an example of how to use StartBatchContext API. A default retry strategy applies to this operation StartBatchContext()

func (BatchComputingClient) StartBatchJobPool

func (client BatchComputingClient) StartBatchJobPool(ctx context.Context, request StartBatchJobPoolRequest) (response StartBatchJobPoolResponse, err error)

StartBatchJobPool Activates the batch job pool.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/StartBatchJobPool.go.html to see an example of how to use StartBatchJobPool API. A default retry strategy applies to this operation StartBatchJobPool()

func (BatchComputingClient) StopBatchContext

func (client BatchComputingClient) StopBatchContext(ctx context.Context, request StopBatchContextRequest) (response StopBatchContextResponse, err error)

StopBatchContext Stops a batch context from accepting new jobs.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/StopBatchContext.go.html to see an example of how to use StopBatchContext API. A default retry strategy applies to this operation StopBatchContext()

func (BatchComputingClient) StopBatchJobPool

func (client BatchComputingClient) StopBatchJobPool(ctx context.Context, request StopBatchJobPoolRequest) (response StopBatchJobPoolResponse, err error)

StopBatchJobPool Deactivates the batch job pool.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/StopBatchJobPool.go.html to see an example of how to use StopBatchJobPool API. A default retry strategy applies to this operation StopBatchJobPool()

func (BatchComputingClient) UnpauseBatchJob

func (client BatchComputingClient) UnpauseBatchJob(ctx context.Context, request UnpauseBatchJobRequest) (response UnpauseBatchJobResponse, err error)

UnpauseBatchJob Resumes the batch job and all its tasks.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UnpauseBatchJob.go.html to see an example of how to use UnpauseBatchJob API. A default retry strategy applies to this operation UnpauseBatchJob()

func (BatchComputingClient) UpdateBatchContext

func (client BatchComputingClient) UpdateBatchContext(ctx context.Context, request UpdateBatchContextRequest) (response UpdateBatchContextResponse, err error)

UpdateBatchContext Updates a batch context.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchContext.go.html to see an example of how to use UpdateBatchContext API. A default retry strategy applies to this operation UpdateBatchContext()

func (BatchComputingClient) UpdateBatchJob

func (client BatchComputingClient) UpdateBatchJob(ctx context.Context, request UpdateBatchJobRequest) (response UpdateBatchJobResponse, err error)

UpdateBatchJob Updates a batch job.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchJob.go.html to see an example of how to use UpdateBatchJob API. A default retry strategy applies to this operation UpdateBatchJob()

func (BatchComputingClient) UpdateBatchJobPool

func (client BatchComputingClient) UpdateBatchJobPool(ctx context.Context, request UpdateBatchJobPoolRequest) (response UpdateBatchJobPoolResponse, err error)

UpdateBatchJobPool Updates a batch job pool.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchJobPool.go.html to see an example of how to use UpdateBatchJobPool API. A default retry strategy applies to this operation UpdateBatchJobPool()

func (BatchComputingClient) UpdateBatchTaskEnvironment

func (client BatchComputingClient) UpdateBatchTaskEnvironment(ctx context.Context, request UpdateBatchTaskEnvironmentRequest) (response UpdateBatchTaskEnvironmentResponse, err error)

UpdateBatchTaskEnvironment Updates a batch task environment.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchTaskEnvironment.go.html to see an example of how to use UpdateBatchTaskEnvironment API. A default retry strategy applies to this operation UpdateBatchTaskEnvironment()

func (BatchComputingClient) UpdateBatchTaskProfile

func (client BatchComputingClient) UpdateBatchTaskProfile(ctx context.Context, request UpdateBatchTaskProfileRequest) (response UpdateBatchTaskProfileResponse, err error)

UpdateBatchTaskProfile Updates a batch task profile.

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchTaskProfile.go.html to see an example of how to use UpdateBatchTaskProfile API. A default retry strategy applies to this operation UpdateBatchTaskProfile()

type BatchContext

type BatchContext struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The date and time the batch context was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the batch context.
	LifecycleState BatchContextLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// List of job priority configurations related to the batch context.
	JobPriorityConfigurations []JobPriorityConfiguration `mandatory:"true" json:"jobPriorityConfigurations"`

	Network *Network `mandatory:"true" json:"network"`

	// List of fleet configurations related to the batch context.
	Fleets []Fleet `mandatory:"true" json:"fleets"`

	// Mapping of concurrent/shared resources used in job tasks to their limits.
	Entitlements map[string]int `mandatory:"true" json:"entitlements"`

	// Summarized information about the batch context.
	Description *string `mandatory:"false" json:"description"`

	// The date and time the batch context was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message that describes the current state in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	LoggingConfiguration LoggingConfiguration `mandatory:"false" json:"loggingConfiguration"`
}

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 (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

func (BatchContext) String

func (m BatchContext) String() string

func (*BatchContext) UnmarshalJSON

func (m *BatchContext) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (BatchContext) ValidateEnumValue

func (m BatchContext) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchContextCollection

type BatchContextCollection struct {

	// List of batch contexts.
	Items []BatchContextSummary `mandatory:"true" json:"items"`
}

BatchContextCollection Results of a batch context search. Contains both batch context summary items and other information, such as metadata.

func (BatchContextCollection) String

func (m BatchContextCollection) String() string

func (BatchContextCollection) ValidateEnumValue

func (m BatchContextCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchContextLifecycleStateEnum

type BatchContextLifecycleStateEnum string

BatchContextLifecycleStateEnum Enum with underlying type: string

const (
	BatchContextLifecycleStateCreating       BatchContextLifecycleStateEnum = "CREATING"
	BatchContextLifecycleStateActive         BatchContextLifecycleStateEnum = "ACTIVE"
	BatchContextLifecycleStateInactive       BatchContextLifecycleStateEnum = "INACTIVE"
	BatchContextLifecycleStateUpdating       BatchContextLifecycleStateEnum = "UPDATING"
	BatchContextLifecycleStateNeedsAttention BatchContextLifecycleStateEnum = "NEEDS_ATTENTION"
	BatchContextLifecycleStateDeleting       BatchContextLifecycleStateEnum = "DELETING"
	BatchContextLifecycleStateDeleted        BatchContextLifecycleStateEnum = "DELETED"
	BatchContextLifecycleStateFailed         BatchContextLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for BatchContextLifecycleStateEnum

func GetBatchContextLifecycleStateEnumValues

func GetBatchContextLifecycleStateEnumValues() []BatchContextLifecycleStateEnum

GetBatchContextLifecycleStateEnumValues Enumerates the set of values for BatchContextLifecycleStateEnum

func GetMappingBatchContextLifecycleStateEnum

func GetMappingBatchContextLifecycleStateEnum(val string) (BatchContextLifecycleStateEnum, bool)

GetMappingBatchContextLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchContextShapeCollection

type BatchContextShapeCollection struct {

	// List of shapes.
	Items []BatchContextShapeSummary `mandatory:"true" json:"items"`
}

BatchContextShapeCollection A collection of container instance shapes.

func (BatchContextShapeCollection) String

func (BatchContextShapeCollection) ValidateEnumValue

func (m BatchContextShapeCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchContextShapeSummary

type BatchContextShapeSummary struct {

	// The name identifying the shape.
	Name *string `mandatory:"true" json:"name"`

	// A short description of the container instance's processor (CPU).
	ProcessorDescription *string `mandatory:"true" json:"processorDescription"`

	MemoryOptions *ShapeMemoryOptions `mandatory:"false" json:"memoryOptions"`

	NetworkingBandwidthOptions *ShapeNetworkingBandwidthOptions `mandatory:"false" json:"networkingBandwidthOptions"`

	OcpuOptions *ShapeOcpuOptions `mandatory:"false" json:"ocpuOptions"`
}

BatchContextShapeSummary Details about a shape for a container instance.

func (BatchContextShapeSummary) String

func (m BatchContextShapeSummary) String() string

func (BatchContextShapeSummary) ValidateEnumValue

func (m BatchContextShapeSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchContextSummary

type BatchContextSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The date and time the batch context was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the batch context.
	LifecycleState BatchContextLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// Summarized information about the batch context.
	Description *string `mandatory:"false" json:"description"`

	// The date and time the batch context was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message that describes the current state in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}

BatchContextSummary Summary information about a batch context.

func (BatchContextSummary) String

func (m BatchContextSummary) String() string

func (BatchContextSummary) ValidateEnumValue

func (m BatchContextSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchJob

type BatchJob struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent batch job pool.
	BatchJobPoolId *string `mandatory:"true" json:"batchJobPoolId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent batch context of the parent job pool.
	BatchContextId *string `mandatory:"true" json:"batchContextId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The date and time the batch job was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the batch job.
	LifecycleState BatchJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// A value calculated by the system based on the priority tags.
	Priority *int `mandatory:"false" json:"priority"`

	// A percentage value (0..100) of the job completion.
	ProgressPercentage *int `mandatory:"false" json:"progressPercentage"`

	// A more detailed textual representation of the job completion.
	ProgressDetails *string `mandatory:"false" json:"progressDetails"`

	// An environment variables to use for the job's tasks (can be overridden by task's environment variables).
	EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`

	// The date and time the batch job was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message that describes the current state of the batch job in more detail. For example,
	// can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}

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 (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

func (BatchJob) String

func (m BatchJob) String() string

func (BatchJob) ValidateEnumValue

func (m BatchJob) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchJobCollection

type BatchJobCollection struct {

	// List of batch jobs.
	Items []BatchJobSummary `mandatory:"true" json:"items"`
}

BatchJobCollection Results of a batch job search. Contains both batch job summary items and other information, such as metadata.

func (BatchJobCollection) String

func (m BatchJobCollection) String() string

func (BatchJobCollection) ValidateEnumValue

func (m BatchJobCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchJobLifecycleStateEnum

type BatchJobLifecycleStateEnum string

BatchJobLifecycleStateEnum Enum with underlying type: string

const (
	BatchJobLifecycleStateAccepted       BatchJobLifecycleStateEnum = "ACCEPTED"
	BatchJobLifecycleStateWaiting        BatchJobLifecycleStateEnum = "WAITING"
	BatchJobLifecycleStateInProgress     BatchJobLifecycleStateEnum = "IN_PROGRESS"
	BatchJobLifecycleStateSucceeded      BatchJobLifecycleStateEnum = "SUCCEEDED"
	BatchJobLifecycleStateNeedsAttention BatchJobLifecycleStateEnum = "NEEDS_ATTENTION"
	BatchJobLifecycleStateFailed         BatchJobLifecycleStateEnum = "FAILED"
	BatchJobLifecycleStateCanceling      BatchJobLifecycleStateEnum = "CANCELING"
	BatchJobLifecycleStateCanceled       BatchJobLifecycleStateEnum = "CANCELED"
)

Set of constants representing the allowable values for BatchJobLifecycleStateEnum

func GetBatchJobLifecycleStateEnumValues

func GetBatchJobLifecycleStateEnumValues() []BatchJobLifecycleStateEnum

GetBatchJobLifecycleStateEnumValues Enumerates the set of values for BatchJobLifecycleStateEnum

func GetMappingBatchJobLifecycleStateEnum

func GetMappingBatchJobLifecycleStateEnum(val string) (BatchJobLifecycleStateEnum, bool)

GetMappingBatchJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchJobPool

type BatchJobPool struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of batch context.
	BatchContextId *string `mandatory:"true" json:"batchContextId"`

	// The date and time the batch job pool was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the batch job pool.
	LifecycleState BatchJobPoolLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// Summarized information about the batch job pool.
	Description *string `mandatory:"false" json:"description"`

	// The date and time the batch job pool was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

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 (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

func (BatchJobPool) String

func (m BatchJobPool) String() string

func (BatchJobPool) ValidateEnumValue

func (m BatchJobPool) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchJobPoolCollection

type BatchJobPoolCollection struct {

	// List of batch job pools.
	Items []BatchJobPoolSummary `mandatory:"true" json:"items"`
}

BatchJobPoolCollection Results of a batch job pool search. Contains both batch job pool summary items and other information, such as metadata.

func (BatchJobPoolCollection) String

func (m BatchJobPoolCollection) String() string

func (BatchJobPoolCollection) ValidateEnumValue

func (m BatchJobPoolCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchJobPoolLifecycleStateEnum

type BatchJobPoolLifecycleStateEnum string

BatchJobPoolLifecycleStateEnum Enum with underlying type: string

const (
	BatchJobPoolLifecycleStateActive         BatchJobPoolLifecycleStateEnum = "ACTIVE"
	BatchJobPoolLifecycleStateInactive       BatchJobPoolLifecycleStateEnum = "INACTIVE"
	BatchJobPoolLifecycleStateUpdating       BatchJobPoolLifecycleStateEnum = "UPDATING"
	BatchJobPoolLifecycleStateNeedsAttention BatchJobPoolLifecycleStateEnum = "NEEDS_ATTENTION"
	BatchJobPoolLifecycleStateDeleted        BatchJobPoolLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for BatchJobPoolLifecycleStateEnum

func GetBatchJobPoolLifecycleStateEnumValues

func GetBatchJobPoolLifecycleStateEnumValues() []BatchJobPoolLifecycleStateEnum

GetBatchJobPoolLifecycleStateEnumValues Enumerates the set of values for BatchJobPoolLifecycleStateEnum

func GetMappingBatchJobPoolLifecycleStateEnum

func GetMappingBatchJobPoolLifecycleStateEnum(val string) (BatchJobPoolLifecycleStateEnum, bool)

GetMappingBatchJobPoolLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchJobPoolSummary

type BatchJobPoolSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	Id *string `mandatory:"true" json:"id"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of batch context.
	BatchContextId *string `mandatory:"true" json:"batchContextId"`

	// The date and time the batch job pool was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the batch job pool.
	LifecycleState BatchJobPoolLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// Summarized information about the batch job pool.
	Description *string `mandatory:"false" json:"description"`

	// The date and time the batch job pool was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

BatchJobPoolSummary Summary information about a batch job pool.

func (BatchJobPoolSummary) String

func (m BatchJobPoolSummary) String() string

func (BatchJobPoolSummary) ValidateEnumValue

func (m BatchJobPoolSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchJobSummary

type BatchJobSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent batch job pool.
	BatchJobPoolId *string `mandatory:"true" json:"batchJobPoolId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent batch context of the parent job pool.
	BatchContextId *string `mandatory:"true" json:"batchContextId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The date and time the batch job was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The current state of the batch job.
	LifecycleState BatchJobLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// A value calculated by the system based on the priority tags.
	Priority *int `mandatory:"false" json:"priority"`

	// A percentage value (0..100) of the job completion.
	ProgressPercentage *int `mandatory:"false" json:"progressPercentage"`

	// A more detailed textual representation of the job completion.
	ProgressDetails *string `mandatory:"false" json:"progressDetails"`

	// The date and time the batch job was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`

	// A message that describes the current state of the batch job in more detail. For example,
	// can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}

BatchJobSummary Summary information about a batch job.

func (BatchJobSummary) String

func (m BatchJobSummary) String() string

func (BatchJobSummary) ValidateEnumValue

func (m BatchJobSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchTask

type BatchTask interface {

	// The UUID of batch task.
	GetId() *string

	// The name of the batch task. It must be unique within its parent batch job.
	GetName() *string

	// A list of resources (for example licences) this task needs for its execution.
	GetEntitlementClaims() []string

	// A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task.
	GetDependencies() []string

	// Environment variables to use for the task execution.
	GetEnvironmentVariables() []EnvironmentVariable

	// The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName
	GetHierarchicalName() *string

	// The hierarchical name of the group task. Null for top-level tasks.
	GetGroupTaskName() *string

	// An optional description that provides additional context next to the displayName.
	GetDescription() *string

	// The current state of the batch task.
	GetLifecycleState() BatchTaskLifecycleStateEnum

	// A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
	GetLifecycleDetails() *string
}

BatchTask A batch task contains common properties for all types of job tasks.

type BatchTaskCollection

type BatchTaskCollection struct {

	// List of batch task summaries.
	Items []BatchTaskSummary `mandatory:"true" json:"items"`
}

BatchTaskCollection Results of a batch task search. Contains both batch task summary items and other information, such as metadata.

func (BatchTaskCollection) String

func (m BatchTaskCollection) String() string

func (*BatchTaskCollection) UnmarshalJSON

func (m *BatchTaskCollection) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (BatchTaskCollection) ValidateEnumValue

func (m BatchTaskCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchTaskEnvironment

type BatchTaskEnvironment struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// If not specified or provided as null or empty string, it be generated as "<resourceType><timeCreated>", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The URL of the ocir image.
	ImageUrl *string `mandatory:"true" json:"imageUrl"`

	// List of volumes attached to the image.
	// The use cases of the volumes are but not limited to: read the input of the task and write the output.
	Volumes []BatchTaskEnvironmentVolume `mandatory:"true" json:"volumes"`

	// The current state of the batch task environment.
	LifecycleState BatchTaskEnvironmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the batch task environment was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// The batch task environment description.
	Description *string `mandatory:"false" json:"description"`

	SecurityContext *SecurityContext `mandatory:"false" json:"securityContext"`

	// Container's working directory.
	WorkingDirectory *string `mandatory:"false" json:"workingDirectory"`

	// The date and time the batch task environment was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

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 (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

func (BatchTaskEnvironment) String

func (m BatchTaskEnvironment) String() string

func (*BatchTaskEnvironment) UnmarshalJSON

func (m *BatchTaskEnvironment) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (BatchTaskEnvironment) ValidateEnumValue

func (m BatchTaskEnvironment) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchTaskEnvironmentCollection

type BatchTaskEnvironmentCollection struct {

	// List of batch task environments.
	Items []BatchTaskEnvironmentSummary `mandatory:"true" json:"items"`
}

BatchTaskEnvironmentCollection Results of a batch task environment search. Contains both batch task environment summary items and other information, such as metadata.

func (BatchTaskEnvironmentCollection) String

func (BatchTaskEnvironmentCollection) ValidateEnumValue

func (m BatchTaskEnvironmentCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchTaskEnvironmentLifecycleStateEnum

type BatchTaskEnvironmentLifecycleStateEnum string

BatchTaskEnvironmentLifecycleStateEnum Enum with underlying type: string

const (
	BatchTaskEnvironmentLifecycleStateActive  BatchTaskEnvironmentLifecycleStateEnum = "ACTIVE"
	BatchTaskEnvironmentLifecycleStateDeleted BatchTaskEnvironmentLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for BatchTaskEnvironmentLifecycleStateEnum

func GetBatchTaskEnvironmentLifecycleStateEnumValues

func GetBatchTaskEnvironmentLifecycleStateEnumValues() []BatchTaskEnvironmentLifecycleStateEnum

GetBatchTaskEnvironmentLifecycleStateEnumValues Enumerates the set of values for BatchTaskEnvironmentLifecycleStateEnum

func GetMappingBatchTaskEnvironmentLifecycleStateEnum

func GetMappingBatchTaskEnvironmentLifecycleStateEnum(val string) (BatchTaskEnvironmentLifecycleStateEnum, bool)

GetMappingBatchTaskEnvironmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchTaskEnvironmentSummary

type BatchTaskEnvironmentSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// If not specified or provided as null or empty string, it be generated as "<resourceType><timeCreated>", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The URL of the ocir image.
	ImageUrl *string `mandatory:"true" json:"imageUrl"`

	// The current state of the batch task environment.
	LifecycleState BatchTaskEnvironmentLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the batch task environment was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// The batch task environment description.
	Description *string `mandatory:"false" json:"description"`

	SecurityContext *SecurityContext `mandatory:"false" json:"securityContext"`

	// Container's working directory.
	WorkingDirectory *string `mandatory:"false" json:"workingDirectory"`

	// The date and time the batch task environment was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

BatchTaskEnvironmentSummary Summary information about a batch task environment.

func (BatchTaskEnvironmentSummary) String

func (BatchTaskEnvironmentSummary) ValidateEnumValue

func (m BatchTaskEnvironmentSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchTaskEnvironmentVolume

type BatchTaskEnvironmentVolume interface {
}

BatchTaskEnvironmentVolume A base type for volume for batch task environment.

type BatchTaskEnvironmentVolumeTypeEnum

type BatchTaskEnvironmentVolumeTypeEnum string

BatchTaskEnvironmentVolumeTypeEnum Enum with underlying type: string

const (
	BatchTaskEnvironmentVolumeTypeNfs BatchTaskEnvironmentVolumeTypeEnum = "NFS"
)

Set of constants representing the allowable values for BatchTaskEnvironmentVolumeTypeEnum

func GetBatchTaskEnvironmentVolumeTypeEnumValues

func GetBatchTaskEnvironmentVolumeTypeEnumValues() []BatchTaskEnvironmentVolumeTypeEnum

GetBatchTaskEnvironmentVolumeTypeEnumValues Enumerates the set of values for BatchTaskEnvironmentVolumeTypeEnum

func GetMappingBatchTaskEnvironmentVolumeTypeEnum

func GetMappingBatchTaskEnvironmentVolumeTypeEnum(val string) (BatchTaskEnvironmentVolumeTypeEnum, bool)

GetMappingBatchTaskEnvironmentVolumeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchTaskExecutionDetails added in v65.114.0

type BatchTaskExecutionDetails interface {
}

BatchTaskExecutionDetails Execution details for a batch task.

type BatchTaskExecutionDetailsTypeEnum added in v65.114.0

type BatchTaskExecutionDetailsTypeEnum string

BatchTaskExecutionDetailsTypeEnum Enum with underlying type: string

const (
	BatchTaskExecutionDetailsTypeComputeTaskExecutionDetails BatchTaskExecutionDetailsTypeEnum = "COMPUTE_TASK_EXECUTION_DETAILS"
)

Set of constants representing the allowable values for BatchTaskExecutionDetailsTypeEnum

func GetBatchTaskExecutionDetailsTypeEnumValues added in v65.114.0

func GetBatchTaskExecutionDetailsTypeEnumValues() []BatchTaskExecutionDetailsTypeEnum

GetBatchTaskExecutionDetailsTypeEnumValues Enumerates the set of values for BatchTaskExecutionDetailsTypeEnum

func GetMappingBatchTaskExecutionDetailsTypeEnum added in v65.114.0

func GetMappingBatchTaskExecutionDetailsTypeEnum(val string) (BatchTaskExecutionDetailsTypeEnum, bool)

GetMappingBatchTaskExecutionDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchTaskHierarchyViewEnum added in v65.114.0

type BatchTaskHierarchyViewEnum string

BatchTaskHierarchyViewEnum Enum with underlying type: string

const (
	BatchTaskHierarchyViewShallow BatchTaskHierarchyViewEnum = "SHALLOW"
	BatchTaskHierarchyViewDeep    BatchTaskHierarchyViewEnum = "DEEP"
)

Set of constants representing the allowable values for BatchTaskHierarchyViewEnum

func GetBatchTaskHierarchyViewEnumValues added in v65.114.0

func GetBatchTaskHierarchyViewEnumValues() []BatchTaskHierarchyViewEnum

GetBatchTaskHierarchyViewEnumValues Enumerates the set of values for BatchTaskHierarchyViewEnum

func GetMappingBatchTaskHierarchyViewEnum added in v65.114.0

func GetMappingBatchTaskHierarchyViewEnum(val string) (BatchTaskHierarchyViewEnum, bool)

GetMappingBatchTaskHierarchyViewEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchTaskLifecycleStateEnum

type BatchTaskLifecycleStateEnum string

BatchTaskLifecycleStateEnum Enum with underlying type: string

const (
	BatchTaskLifecycleStateAccepted   BatchTaskLifecycleStateEnum = "ACCEPTED"
	BatchTaskLifecycleStateWaiting    BatchTaskLifecycleStateEnum = "WAITING"
	BatchTaskLifecycleStateInProgress BatchTaskLifecycleStateEnum = "IN_PROGRESS"
	BatchTaskLifecycleStateSucceeded  BatchTaskLifecycleStateEnum = "SUCCEEDED"
	BatchTaskLifecycleStateFailed     BatchTaskLifecycleStateEnum = "FAILED"
	BatchTaskLifecycleStateCanceling  BatchTaskLifecycleStateEnum = "CANCELING"
	BatchTaskLifecycleStateCanceled   BatchTaskLifecycleStateEnum = "CANCELED"
)

Set of constants representing the allowable values for BatchTaskLifecycleStateEnum

func GetBatchTaskLifecycleStateEnumValues

func GetBatchTaskLifecycleStateEnumValues() []BatchTaskLifecycleStateEnum

GetBatchTaskLifecycleStateEnumValues Enumerates the set of values for BatchTaskLifecycleStateEnum

func GetMappingBatchTaskLifecycleStateEnum

func GetMappingBatchTaskLifecycleStateEnum(val string) (BatchTaskLifecycleStateEnum, bool)

GetMappingBatchTaskLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchTaskProfile

type BatchTaskProfile struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The minimum required OCPUs.
	MinOcpus *int `mandatory:"true" json:"minOcpus"`

	// The minimum required memory.
	MinMemoryInGBs *int `mandatory:"true" json:"minMemoryInGBs"`

	// The current state of the batch task profile.
	LifecycleState BatchTaskProfileLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the batch task profile was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// The batch task profile description.
	Description *string `mandatory:"false" json:"description"`

	// The minimum required size of disk space in GBs.
	MinDiskSizeInGBs *int `mandatory:"false" json:"minDiskSizeInGBs"`

	ExtendedInformation BatchTaskProfileExtendedInformation `mandatory:"false" json:"extendedInformation"`

	// The date and time the batch task profile was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

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 (https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

func (BatchTaskProfile) String

func (m BatchTaskProfile) String() string

func (*BatchTaskProfile) UnmarshalJSON added in v65.114.0

func (m *BatchTaskProfile) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (BatchTaskProfile) ValidateEnumValue

func (m BatchTaskProfile) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchTaskProfileCollection

type BatchTaskProfileCollection struct {

	// List of batch task profiles.
	Items []BatchTaskProfileSummary `mandatory:"true" json:"items"`
}

BatchTaskProfileCollection Results of a batch task profile search. Contains both batch task profile summary items and other information, such as metadata.

func (BatchTaskProfileCollection) String

func (BatchTaskProfileCollection) ValidateEnumValue

func (m BatchTaskProfileCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchTaskProfileExtendedInformation added in v65.114.0

type BatchTaskProfileExtendedInformation interface {
}

BatchTaskProfileExtendedInformation Extended information for the task profile.

type BatchTaskProfileExtendedInformationTypeEnum added in v65.114.0

type BatchTaskProfileExtendedInformationTypeEnum string

BatchTaskProfileExtendedInformationTypeEnum Enum with underlying type: string

const (
	BatchTaskProfileExtendedInformationTypeCpuArchitectureTaskProfileExtendedInformation BatchTaskProfileExtendedInformationTypeEnum = "CPU_ARCHITECTURE_TASK_PROFILE_EXTENDED_INFORMATION"
	BatchTaskProfileExtendedInformationTypeCpuShapeTaskProfileExtendedInformation        BatchTaskProfileExtendedInformationTypeEnum = "CPU_SHAPE_TASK_PROFILE_EXTENDED_INFORMATION"
	BatchTaskProfileExtendedInformationTypeGpuShapeTaskProfileExtendedInformation        BatchTaskProfileExtendedInformationTypeEnum = "GPU_SHAPE_TASK_PROFILE_EXTENDED_INFORMATION"
)

Set of constants representing the allowable values for BatchTaskProfileExtendedInformationTypeEnum

func GetBatchTaskProfileExtendedInformationTypeEnumValues added in v65.114.0

func GetBatchTaskProfileExtendedInformationTypeEnumValues() []BatchTaskProfileExtendedInformationTypeEnum

GetBatchTaskProfileExtendedInformationTypeEnumValues Enumerates the set of values for BatchTaskProfileExtendedInformationTypeEnum

func GetMappingBatchTaskProfileExtendedInformationTypeEnum added in v65.114.0

func GetMappingBatchTaskProfileExtendedInformationTypeEnum(val string) (BatchTaskProfileExtendedInformationTypeEnum, bool)

GetMappingBatchTaskProfileExtendedInformationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchTaskProfileLifecycleStateEnum

type BatchTaskProfileLifecycleStateEnum string

BatchTaskProfileLifecycleStateEnum Enum with underlying type: string

const (
	BatchTaskProfileLifecycleStateActive  BatchTaskProfileLifecycleStateEnum = "ACTIVE"
	BatchTaskProfileLifecycleStateDeleted BatchTaskProfileLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for BatchTaskProfileLifecycleStateEnum

func GetBatchTaskProfileLifecycleStateEnumValues

func GetBatchTaskProfileLifecycleStateEnumValues() []BatchTaskProfileLifecycleStateEnum

GetBatchTaskProfileLifecycleStateEnumValues Enumerates the set of values for BatchTaskProfileLifecycleStateEnum

func GetMappingBatchTaskProfileLifecycleStateEnum

func GetMappingBatchTaskProfileLifecycleStateEnum(val string) (BatchTaskProfileLifecycleStateEnum, bool)

GetMappingBatchTaskProfileLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchTaskProfileSummary

type BatchTaskProfileSummary struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	DisplayName *string `mandatory:"true" json:"displayName"`

	// The current state of the batch task profile.
	LifecycleState BatchTaskProfileLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

	// The date and time the batch task profile was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"true" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"true" json:"freeformTags"`

	// System tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"true" json:"systemTags"`

	// The batch task profile description.
	Description *string `mandatory:"false" json:"description"`

	// The minimum required OCPUs.
	MinOcpus *int `mandatory:"false" json:"minOcpus"`

	// The minimum required memory.
	MinMemoryInGBs *int `mandatory:"false" json:"minMemoryInGBs"`

	// The minimum required size of disk space in GBs.
	MinDiskSizeInGBs *int `mandatory:"false" json:"minDiskSizeInGBs"`

	ExtendedInformation BatchTaskProfileExtendedInformation `mandatory:"false" json:"extendedInformation"`

	// The date and time the batch task profile was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

BatchTaskProfileSummary Summary information about a batch task profile.

func (BatchTaskProfileSummary) String

func (m BatchTaskProfileSummary) String() string

func (*BatchTaskProfileSummary) UnmarshalJSON added in v65.114.0

func (m *BatchTaskProfileSummary) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (BatchTaskProfileSummary) ValidateEnumValue

func (m BatchTaskProfileSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type BatchTaskSortByEnum

type BatchTaskSortByEnum string

BatchTaskSortByEnum Enum with underlying type: string

const (
	BatchTaskSortByName BatchTaskSortByEnum = "name"
)

Set of constants representing the allowable values for BatchTaskSortByEnum

func GetBatchTaskSortByEnumValues

func GetBatchTaskSortByEnumValues() []BatchTaskSortByEnum

GetBatchTaskSortByEnumValues Enumerates the set of values for BatchTaskSortByEnum

func GetMappingBatchTaskSortByEnum

func GetMappingBatchTaskSortByEnum(val string) (BatchTaskSortByEnum, bool)

GetMappingBatchTaskSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type BatchTaskSummary

type BatchTaskSummary interface {

	// The UUID of batch task.
	GetId() *string

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job to which this task belongs.
	GetJobId() *string

	// The name of the batch task. It must be unique within its parent batch job.
	GetName() *string

	// The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName
	GetHierarchicalName() *string

	// The hierarchical name of the group task. Null for top-level tasks.
	GetGroupTaskName() *string

	// An optional description that provides additional context next to the displayName.
	GetDescription() *string

	// The current state of the batch task.
	GetLifecycleState() BatchTaskLifecycleStateEnum

	// A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
	GetLifecycleDetails() *string
}

BatchTaskSummary Summary information about a batch task.

type BatchTaskTypeEnum

type BatchTaskTypeEnum string

BatchTaskTypeEnum Enum with underlying type: string

const (
	BatchTaskTypeCompute BatchTaskTypeEnum = "COMPUTE"
	BatchTaskTypeGroup   BatchTaskTypeEnum = "GROUP"
)

Set of constants representing the allowable values for BatchTaskTypeEnum

func GetBatchTaskTypeEnumValues

func GetBatchTaskTypeEnumValues() []BatchTaskTypeEnum

GetBatchTaskTypeEnumValues Enumerates the set of values for BatchTaskTypeEnum

func GetMappingBatchTaskTypeEnum

func GetMappingBatchTaskTypeEnum(val string) (BatchTaskTypeEnum, bool)

GetMappingBatchTaskTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type BestFitFleetAssignmentPolicy

type BestFitFleetAssignmentPolicy struct {
}

BestFitFleetAssignmentPolicy The system will assign a task to the smallest sufficient fleet, with no flexibility for using larger fleets.

func (BestFitFleetAssignmentPolicy) MarshalJSON

func (m BestFitFleetAssignmentPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (BestFitFleetAssignmentPolicy) String

func (BestFitFleetAssignmentPolicy) ValidateEnumValue

func (m BestFitFleetAssignmentPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CancelBatchJobRequest

type CancelBatchJobRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"true" contributesTo:"path" name:"batchJobId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CancelBatchJobRequest wrapper for the CancelBatchJob operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CancelBatchJob.go.html to see an example of how to use CancelBatchJobRequest.

func (CancelBatchJobRequest) BinaryRequestBody

func (request CancelBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CancelBatchJobRequest) HTTPRequest

func (request CancelBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CancelBatchJobRequest) RetryPolicy

func (request CancelBatchJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CancelBatchJobRequest) String

func (request CancelBatchJobRequest) String() string

func (CancelBatchJobRequest) ValidateEnumValue

func (request CancelBatchJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CancelBatchJobResponse

type CancelBatchJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CancelBatchJobResponse wrapper for the CancelBatchJob operation

func (CancelBatchJobResponse) HTTPResponse

func (response CancelBatchJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CancelBatchJobResponse) String

func (response CancelBatchJobResponse) String() string

type ChangeBatchContextCompartmentDetails

type ChangeBatchContextCompartmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the batch context to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeBatchContextCompartmentDetails The configuration details for the move operation.

func (ChangeBatchContextCompartmentDetails) String

func (ChangeBatchContextCompartmentDetails) ValidateEnumValue

func (m ChangeBatchContextCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchContextCompartmentRequest

type ChangeBatchContextCompartmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	BatchContextId *string `mandatory:"true" contributesTo:"path" name:"batchContextId"`

	// The information to be updated.
	ChangeBatchContextCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeBatchContextCompartmentRequest wrapper for the ChangeBatchContextCompartment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchContextCompartment.go.html to see an example of how to use ChangeBatchContextCompartmentRequest.

func (ChangeBatchContextCompartmentRequest) BinaryRequestBody

func (request ChangeBatchContextCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeBatchContextCompartmentRequest) HTTPRequest

func (request ChangeBatchContextCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeBatchContextCompartmentRequest) RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeBatchContextCompartmentRequest) String

func (ChangeBatchContextCompartmentRequest) ValidateEnumValue

func (request ChangeBatchContextCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchContextCompartmentResponse

type ChangeBatchContextCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeBatchContextCompartmentResponse wrapper for the ChangeBatchContextCompartment operation

func (ChangeBatchContextCompartmentResponse) HTTPResponse

func (response ChangeBatchContextCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeBatchContextCompartmentResponse) String

type ChangeBatchJobCompartmentDetails

type ChangeBatchJobCompartmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeBatchJobCompartmentDetails The configuration details for the move operation.

func (ChangeBatchJobCompartmentDetails) String

func (ChangeBatchJobCompartmentDetails) ValidateEnumValue

func (m ChangeBatchJobCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchJobCompartmentRequest

type ChangeBatchJobCompartmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"true" contributesTo:"path" name:"batchJobId"`

	// The information to be updated.
	ChangeBatchJobCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeBatchJobCompartmentRequest wrapper for the ChangeBatchJobCompartment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchJobCompartment.go.html to see an example of how to use ChangeBatchJobCompartmentRequest.

func (ChangeBatchJobCompartmentRequest) BinaryRequestBody

func (request ChangeBatchJobCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeBatchJobCompartmentRequest) HTTPRequest

func (request ChangeBatchJobCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeBatchJobCompartmentRequest) RetryPolicy

func (request ChangeBatchJobCompartmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeBatchJobCompartmentRequest) String

func (request ChangeBatchJobCompartmentRequest) String() string

func (ChangeBatchJobCompartmentRequest) ValidateEnumValue

func (request ChangeBatchJobCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchJobCompartmentResponse

type ChangeBatchJobCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeBatchJobCompartmentResponse wrapper for the ChangeBatchJobCompartment operation

func (ChangeBatchJobCompartmentResponse) HTTPResponse

func (response ChangeBatchJobCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeBatchJobCompartmentResponse) String

func (response ChangeBatchJobCompartmentResponse) String() string

type ChangeBatchJobPoolCompartmentDetails

type ChangeBatchJobPoolCompartmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeBatchJobPoolCompartmentDetails The configuration details for the move operation.

func (ChangeBatchJobPoolCompartmentDetails) String

func (ChangeBatchJobPoolCompartmentDetails) ValidateEnumValue

func (m ChangeBatchJobPoolCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchJobPoolCompartmentRequest

type ChangeBatchJobPoolCompartmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	BatchJobPoolId *string `mandatory:"true" contributesTo:"path" name:"batchJobPoolId"`

	// The information to be updated.
	ChangeBatchJobPoolCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeBatchJobPoolCompartmentRequest wrapper for the ChangeBatchJobPoolCompartment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchJobPoolCompartment.go.html to see an example of how to use ChangeBatchJobPoolCompartmentRequest.

func (ChangeBatchJobPoolCompartmentRequest) BinaryRequestBody

func (request ChangeBatchJobPoolCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ChangeBatchJobPoolCompartmentRequest) HTTPRequest

func (request ChangeBatchJobPoolCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeBatchJobPoolCompartmentRequest) RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeBatchJobPoolCompartmentRequest) String

func (ChangeBatchJobPoolCompartmentRequest) ValidateEnumValue

func (request ChangeBatchJobPoolCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchJobPoolCompartmentResponse

type ChangeBatchJobPoolCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeBatchJobPoolCompartmentResponse wrapper for the ChangeBatchJobPoolCompartment operation

func (ChangeBatchJobPoolCompartmentResponse) HTTPResponse

func (response ChangeBatchJobPoolCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeBatchJobPoolCompartmentResponse) String

type ChangeBatchTaskEnvironmentCompartmentDetails

type ChangeBatchTaskEnvironmentCompartmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the batch task environment to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeBatchTaskEnvironmentCompartmentDetails The configuration details for the move operation.

func (ChangeBatchTaskEnvironmentCompartmentDetails) String

func (ChangeBatchTaskEnvironmentCompartmentDetails) ValidateEnumValue

func (m ChangeBatchTaskEnvironmentCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchTaskEnvironmentCompartmentRequest

type ChangeBatchTaskEnvironmentCompartmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment.
	BatchTaskEnvironmentId *string `mandatory:"true" contributesTo:"path" name:"batchTaskEnvironmentId"`

	// The information to be updated.
	ChangeBatchTaskEnvironmentCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeBatchTaskEnvironmentCompartmentRequest wrapper for the ChangeBatchTaskEnvironmentCompartment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchTaskEnvironmentCompartment.go.html to see an example of how to use ChangeBatchTaskEnvironmentCompartmentRequest.

func (ChangeBatchTaskEnvironmentCompartmentRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ChangeBatchTaskEnvironmentCompartmentRequest) HTTPRequest

func (request ChangeBatchTaskEnvironmentCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeBatchTaskEnvironmentCompartmentRequest) RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeBatchTaskEnvironmentCompartmentRequest) String

func (ChangeBatchTaskEnvironmentCompartmentRequest) ValidateEnumValue

func (request ChangeBatchTaskEnvironmentCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchTaskEnvironmentCompartmentResponse

type ChangeBatchTaskEnvironmentCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeBatchTaskEnvironmentCompartmentResponse wrapper for the ChangeBatchTaskEnvironmentCompartment operation

func (ChangeBatchTaskEnvironmentCompartmentResponse) HTTPResponse

HTTPResponse implements the OCIResponse interface

func (ChangeBatchTaskEnvironmentCompartmentResponse) String

type ChangeBatchTaskProfileCompartmentDetails

type ChangeBatchTaskProfileCompartmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the batch task profile to.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeBatchTaskProfileCompartmentDetails The configuration details for the move operation.

func (ChangeBatchTaskProfileCompartmentDetails) String

func (ChangeBatchTaskProfileCompartmentDetails) ValidateEnumValue

func (m ChangeBatchTaskProfileCompartmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchTaskProfileCompartmentRequest

type ChangeBatchTaskProfileCompartmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile.
	BatchTaskProfileId *string `mandatory:"true" contributesTo:"path" name:"batchTaskProfileId"`

	// The information to be updated.
	ChangeBatchTaskProfileCompartmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ChangeBatchTaskProfileCompartmentRequest wrapper for the ChangeBatchTaskProfileCompartment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ChangeBatchTaskProfileCompartment.go.html to see an example of how to use ChangeBatchTaskProfileCompartmentRequest.

func (ChangeBatchTaskProfileCompartmentRequest) BinaryRequestBody

BinaryRequestBody implements the OCIRequest interface

func (ChangeBatchTaskProfileCompartmentRequest) HTTPRequest

func (request ChangeBatchTaskProfileCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ChangeBatchTaskProfileCompartmentRequest) RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ChangeBatchTaskProfileCompartmentRequest) String

func (ChangeBatchTaskProfileCompartmentRequest) ValidateEnumValue

func (request ChangeBatchTaskProfileCompartmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ChangeBatchTaskProfileCompartmentResponse

type ChangeBatchTaskProfileCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ChangeBatchTaskProfileCompartmentResponse wrapper for the ChangeBatchTaskProfileCompartment operation

func (ChangeBatchTaskProfileCompartmentResponse) HTTPResponse

func (response ChangeBatchTaskProfileCompartmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ChangeBatchTaskProfileCompartmentResponse) String

type ComputeTask

type ComputeTask struct {

	// The UUID of batch task.
	Id *string `mandatory:"true" json:"id"`

	// The name of the batch task. It must be unique within its parent batch job.
	Name *string `mandatory:"true" json:"name"`

	// A list of resources (for example licences) this task needs for its execution.
	EntitlementClaims []string `mandatory:"true" json:"entitlementClaims"`

	// A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task.
	Dependencies []string `mandatory:"true" json:"dependencies"`

	// Environment variables to use for the task execution.
	EnvironmentVariables []EnvironmentVariable `mandatory:"true" json:"environmentVariables"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the BatchTaskEnvironment.
	BatchTaskEnvironmentId *string `mandatory:"true" json:"batchTaskEnvironmentId"`

	// The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName
	HierarchicalName *string `mandatory:"false" json:"hierarchicalName"`

	// The hierarchical name of the group task. Null for top-level tasks.
	GroupTaskName *string `mandatory:"false" json:"groupTaskName"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile used for this task.
	BatchTaskProfileId *string `mandatory:"false" json:"batchTaskProfileId"`

	// An executable command to start the processing of this task.
	Command []string `mandatory:"false" json:"command"`

	// Task arguments.
	Arguments []string `mandatory:"false" json:"arguments"`

	FleetAssignmentPolicy FleetAssignmentPolicy `mandatory:"false" json:"fleetAssignmentPolicy"`

	// List of up to 30 most recent execution history entries, from newest to oldest. Be aware that the maximum number of items returned may change in the future.
	MostRecentExecutionHistory []BatchTaskExecutionDetails `mandatory:"false" json:"mostRecentExecutionHistory"`

	// The current state of the batch task.
	LifecycleState BatchTaskLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

ComputeTask compute task represents a single executable command together with its dependencies and resources.

func (ComputeTask) GetDependencies

func (m ComputeTask) GetDependencies() []string

GetDependencies returns Dependencies

func (ComputeTask) GetDescription

func (m ComputeTask) GetDescription() *string

GetDescription returns Description

func (ComputeTask) GetEntitlementClaims

func (m ComputeTask) GetEntitlementClaims() []string

GetEntitlementClaims returns EntitlementClaims

func (ComputeTask) GetEnvironmentVariables

func (m ComputeTask) GetEnvironmentVariables() []EnvironmentVariable

GetEnvironmentVariables returns EnvironmentVariables

func (ComputeTask) GetGroupTaskName added in v65.114.0

func (m ComputeTask) GetGroupTaskName() *string

GetGroupTaskName returns GroupTaskName

func (ComputeTask) GetHierarchicalName added in v65.114.0

func (m ComputeTask) GetHierarchicalName() *string

GetHierarchicalName returns HierarchicalName

func (ComputeTask) GetId

func (m ComputeTask) GetId() *string

GetId returns Id

func (ComputeTask) GetLifecycleDetails

func (m ComputeTask) GetLifecycleDetails() *string

GetLifecycleDetails returns LifecycleDetails

func (ComputeTask) GetLifecycleState

func (m ComputeTask) GetLifecycleState() BatchTaskLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (ComputeTask) GetName

func (m ComputeTask) GetName() *string

GetName returns Name

func (ComputeTask) MarshalJSON

func (m ComputeTask) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ComputeTask) String

func (m ComputeTask) String() string

func (*ComputeTask) UnmarshalJSON

func (m *ComputeTask) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ComputeTask) ValidateEnumValue

func (m ComputeTask) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ComputeTaskExecutionDetails added in v65.114.0

type ComputeTaskExecutionDetails struct {

	// A unique identifier for the task execution. Created as "taskId:taskVersion:runNumber".
	ExecutionId *string `mandatory:"false" json:"executionId"`

	// The date and time when the lifecycleState was changed to Waiting, and it is waiting for its dependencies to run, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeTransitionedToWaitingDependencies *common.SDKTime `mandatory:"false" json:"timeTransitionedToWaitingDependencies"`

	// The date and time when the lifecycleState was changed to Waiting, and it is queued to be executed, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeTransitionedToWaitingQueued *common.SDKTime `mandatory:"false" json:"timeTransitionedToWaitingQueued"`

	// The date and time when the lifecycleState was changed to In_Progress, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time when the lifecycleState changed to Succeeded, or Failed, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339).
	// Example: `2016-08-25T21:10:29.600Z`
	TimeCompleted *common.SDKTime `mandatory:"false" json:"timeCompleted"`

	FleetShape FleetShapeExecutionDetails `mandatory:"false" json:"fleetShape"`

	// List of error messages related to this task execution. Be aware that the maximum number of items returned may change in the future.
	Errors []string `mandatory:"false" json:"errors"`

	// The terminal lifecycle state of the task for this execution. Valid values are: SUCCEEDED, NEEDS_ATTENTION, CANCELED, or FAILED.
	CompletionLifecycleState BatchTaskLifecycleStateEnum `mandatory:"false" json:"completionLifecycleState,omitempty"`
}

ComputeTaskExecutionDetails Execution details for a compute task.

func (ComputeTaskExecutionDetails) MarshalJSON added in v65.114.0

func (m ComputeTaskExecutionDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ComputeTaskExecutionDetails) String added in v65.114.0

func (*ComputeTaskExecutionDetails) UnmarshalJSON added in v65.114.0

func (m *ComputeTaskExecutionDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ComputeTaskExecutionDetails) ValidateEnumValue added in v65.114.0

func (m ComputeTaskExecutionDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ComputeTaskSummary

type ComputeTaskSummary struct {

	// The UUID of batch task.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job to which this task belongs.
	JobId *string `mandatory:"true" json:"jobId"`

	// The name of the batch task. It must be unique within its parent batch job.
	Name *string `mandatory:"true" json:"name"`

	// The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName
	HierarchicalName *string `mandatory:"false" json:"hierarchicalName"`

	// The hierarchical name of the group task. Null for top-level tasks.
	GroupTaskName *string `mandatory:"false" json:"groupTaskName"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// The current state of the batch task.
	LifecycleState BatchTaskLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

ComputeTaskSummary Summary information about a compute task.

func (ComputeTaskSummary) GetDescription

func (m ComputeTaskSummary) GetDescription() *string

GetDescription returns Description

func (ComputeTaskSummary) GetGroupTaskName added in v65.114.0

func (m ComputeTaskSummary) GetGroupTaskName() *string

GetGroupTaskName returns GroupTaskName

func (ComputeTaskSummary) GetHierarchicalName added in v65.114.0

func (m ComputeTaskSummary) GetHierarchicalName() *string

GetHierarchicalName returns HierarchicalName

func (ComputeTaskSummary) GetId

func (m ComputeTaskSummary) GetId() *string

GetId returns Id

func (ComputeTaskSummary) GetJobId

func (m ComputeTaskSummary) GetJobId() *string

GetJobId returns JobId

func (ComputeTaskSummary) GetLifecycleDetails

func (m ComputeTaskSummary) GetLifecycleDetails() *string

GetLifecycleDetails returns LifecycleDetails

func (ComputeTaskSummary) GetLifecycleState

func (m ComputeTaskSummary) GetLifecycleState() BatchTaskLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (ComputeTaskSummary) GetName

func (m ComputeTaskSummary) GetName() *string

GetName returns Name

func (ComputeTaskSummary) MarshalJSON

func (m ComputeTaskSummary) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ComputeTaskSummary) String

func (m ComputeTaskSummary) String() string

func (ComputeTaskSummary) ValidateEnumValue

func (m ComputeTaskSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CpuArchitectureTaskProfileExtendedInformation added in v65.114.0

type CpuArchitectureTaskProfileExtendedInformation struct {

	// Type of CPU architecture.
	Architecture CpuArchitectureTaskProfileExtendedInformationArchitectureEnum `mandatory:"true" json:"architecture"`
}

CpuArchitectureTaskProfileExtendedInformation Extended information about CPU architecture for the task profile.

func (CpuArchitectureTaskProfileExtendedInformation) MarshalJSON added in v65.114.0

func (m CpuArchitectureTaskProfileExtendedInformation) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CpuArchitectureTaskProfileExtendedInformation) String added in v65.114.0

func (CpuArchitectureTaskProfileExtendedInformation) ValidateEnumValue added in v65.114.0

func (m CpuArchitectureTaskProfileExtendedInformation) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CpuArchitectureTaskProfileExtendedInformationArchitectureEnum added in v65.114.0

type CpuArchitectureTaskProfileExtendedInformationArchitectureEnum string

CpuArchitectureTaskProfileExtendedInformationArchitectureEnum Enum with underlying type: string

const (
	CpuArchitectureTaskProfileExtendedInformationArchitectureX86 CpuArchitectureTaskProfileExtendedInformationArchitectureEnum = "GENERIC_X86"
	CpuArchitectureTaskProfileExtendedInformationArchitectureArm CpuArchitectureTaskProfileExtendedInformationArchitectureEnum = "GENERIC_ARM"
)

Set of constants representing the allowable values for CpuArchitectureTaskProfileExtendedInformationArchitectureEnum

func GetCpuArchitectureTaskProfileExtendedInformationArchitectureEnumValues added in v65.114.0

func GetCpuArchitectureTaskProfileExtendedInformationArchitectureEnumValues() []CpuArchitectureTaskProfileExtendedInformationArchitectureEnum

GetCpuArchitectureTaskProfileExtendedInformationArchitectureEnumValues Enumerates the set of values for CpuArchitectureTaskProfileExtendedInformationArchitectureEnum

func GetMappingCpuArchitectureTaskProfileExtendedInformationArchitectureEnum added in v65.114.0

func GetMappingCpuArchitectureTaskProfileExtendedInformationArchitectureEnum(val string) (CpuArchitectureTaskProfileExtendedInformationArchitectureEnum, bool)

GetMappingCpuArchitectureTaskProfileExtendedInformationArchitectureEnum performs case Insensitive comparison on enum value and return the desired enum

type CpuFleetShapeExecutionDetails added in v65.114.0

type CpuFleetShapeExecutionDetails struct {

	// Name of the shape.
	ShapeName *string `mandatory:"false" json:"shapeName"`

	// Number of OCPUs provided by the shape.
	Ocpus *int `mandatory:"false" json:"ocpus"`

	// Amount of memory in GBs provided by the shape.
	MemoryInGBs *int `mandatory:"false" json:"memoryInGBs"`

	// Amount of disk space provided by the shape.
	DiskSizeInGBs *int `mandatory:"false" json:"diskSizeInGBs"`
}

CpuFleetShapeExecutionDetails Details about the CPU shape which was used for the task execution.

func (CpuFleetShapeExecutionDetails) MarshalJSON added in v65.114.0

func (m CpuFleetShapeExecutionDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CpuFleetShapeExecutionDetails) String added in v65.114.0

func (CpuFleetShapeExecutionDetails) ValidateEnumValue added in v65.114.0

func (m CpuFleetShapeExecutionDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CpuShapeTaskProfileExtendedInformation added in v65.114.0

type CpuShapeTaskProfileExtendedInformation struct {

	// A name of the CPU shape.
	ShapeName *string `mandatory:"true" json:"shapeName"`
}

CpuShapeTaskProfileExtendedInformation Extended information for the CPU-specific task profile.

func (CpuShapeTaskProfileExtendedInformation) MarshalJSON added in v65.114.0

func (m CpuShapeTaskProfileExtendedInformation) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CpuShapeTaskProfileExtendedInformation) String added in v65.114.0

func (CpuShapeTaskProfileExtendedInformation) ValidateEnumValue added in v65.114.0

func (m CpuShapeTaskProfileExtendedInformation) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchContextDetails

type CreateBatchContextDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	Network *CreateNetworkDetails `mandatory:"true" json:"network"`

	// List of fleet configurations related to the batch context.
	Fleets []CreateFleetDetails `mandatory:"true" json:"fleets"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// If not specified or provided as null or empty string, it will be generated as "<resourceType><timeCreated>", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchcontext20250914115623.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Summarized information about the batch context.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// List of job priority configurations related to the batch context.
	JobPriorityConfigurations []JobPriorityConfiguration `mandatory:"false" json:"jobPriorityConfigurations"`

	// Mapping of concurrent/shared resources used in job tasks to their limits.
	Entitlements map[string]int `mandatory:"false" json:"entitlements"`

	LoggingConfiguration LoggingConfiguration `mandatory:"false" json:"loggingConfiguration"`
}

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.

func (CreateBatchContextDetails) String

func (m CreateBatchContextDetails) String() string

func (*CreateBatchContextDetails) UnmarshalJSON

func (m *CreateBatchContextDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateBatchContextDetails) ValidateEnumValue

func (m CreateBatchContextDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchContextRequest

type CreateBatchContextRequest struct {

	// Details for the new batch context.
	CreateBatchContextDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of running that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and removed from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateBatchContextRequest wrapper for the CreateBatchContext operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchContext.go.html to see an example of how to use CreateBatchContextRequest.

func (CreateBatchContextRequest) BinaryRequestBody

func (request CreateBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateBatchContextRequest) HTTPRequest

func (request CreateBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBatchContextRequest) RetryPolicy

func (request CreateBatchContextRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBatchContextRequest) String

func (request CreateBatchContextRequest) String() string

func (CreateBatchContextRequest) ValidateEnumValue

func (request CreateBatchContextRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchContextResponse

type CreateBatchContextResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchContext instance
	BatchContext `presentIn:"body"`

	// URL for the created batch context. The batch context OCID is generated after this request is sent.
	Location *string `presentIn:"header" name:"location"`

	// Same as location.
	ContentLocation *string `presentIn:"header" name:"content-location"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateBatchContextResponse wrapper for the CreateBatchContext operation

func (CreateBatchContextResponse) HTTPResponse

func (response CreateBatchContextResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBatchContextResponse) String

func (response CreateBatchContextResponse) String() string

type CreateBatchJobDetails

type CreateBatchJobDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent batch job pool.
	BatchJobPoolId *string `mandatory:"true" json:"batchJobPoolId"`

	// A list of tasks to be executed within this job.
	// Maximum number of tasks a job can have in total, across all nested levels, is 1000.
	Tasks []CreateBatchTaskDetails `mandatory:"true" json:"tasks"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// If not specified or provided as null or empty string, it will be generated as "<resourceType><timeCreated>", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchjob20250914115623.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// An environment variables to use for the job's tasks (can be overridden by task's environment variables).
	EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (CreateBatchJobDetails) String

func (m CreateBatchJobDetails) String() string

func (*CreateBatchJobDetails) UnmarshalJSON

func (m *CreateBatchJobDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateBatchJobDetails) ValidateEnumValue

func (m CreateBatchJobDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchJobPoolDetails

type CreateBatchJobPoolDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The OCID of batch context.
	BatchContextId *string `mandatory:"true" json:"batchContextId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// If not specified or provided as null or empty string, it be generated as "<resourceType><timeCreated>", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchjobpool20250914115623.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Summarized information about the batch job pool.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (CreateBatchJobPoolDetails) String

func (m CreateBatchJobPoolDetails) String() string

func (CreateBatchJobPoolDetails) ValidateEnumValue

func (m CreateBatchJobPoolDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchJobPoolRequest

type CreateBatchJobPoolRequest struct {

	// Details for the new batch job pool.
	CreateBatchJobPoolDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of running that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and removed from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateBatchJobPoolRequest wrapper for the CreateBatchJobPool operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchJobPool.go.html to see an example of how to use CreateBatchJobPoolRequest.

func (CreateBatchJobPoolRequest) BinaryRequestBody

func (request CreateBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateBatchJobPoolRequest) HTTPRequest

func (request CreateBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBatchJobPoolRequest) RetryPolicy

func (request CreateBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBatchJobPoolRequest) String

func (request CreateBatchJobPoolRequest) String() string

func (CreateBatchJobPoolRequest) ValidateEnumValue

func (request CreateBatchJobPoolRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchJobPoolResponse

type CreateBatchJobPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchJobPool instance
	BatchJobPool `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateBatchJobPoolResponse wrapper for the CreateBatchJobPool operation

func (CreateBatchJobPoolResponse) HTTPResponse

func (response CreateBatchJobPoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBatchJobPoolResponse) String

func (response CreateBatchJobPoolResponse) String() string

type CreateBatchJobRequest

type CreateBatchJobRequest struct {

	// Details for the new batch job.
	CreateBatchJobDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of running that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and removed from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateBatchJobRequest wrapper for the CreateBatchJob operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchJob.go.html to see an example of how to use CreateBatchJobRequest.

func (CreateBatchJobRequest) BinaryRequestBody

func (request CreateBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateBatchJobRequest) HTTPRequest

func (request CreateBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBatchJobRequest) RetryPolicy

func (request CreateBatchJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBatchJobRequest) String

func (request CreateBatchJobRequest) String() string

func (CreateBatchJobRequest) ValidateEnumValue

func (request CreateBatchJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchJobResponse

type CreateBatchJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchJob instance
	BatchJob `presentIn:"body"`

	// URL for the created batch job. The batch job OCID is generated after this request is sent.
	Location *string `presentIn:"header" name:"location"`

	// Same as location.
	ContentLocation *string `presentIn:"header" name:"content-location"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateBatchJobResponse wrapper for the CreateBatchJob operation

func (CreateBatchJobResponse) HTTPResponse

func (response CreateBatchJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBatchJobResponse) String

func (response CreateBatchJobResponse) String() string

type CreateBatchTaskDetails

type CreateBatchTaskDetails interface {

	// The name of the batch task. It must be unique within its parent batch job.
	GetName() *string

	// An optional description that provides additional context next to the displayName.
	GetDescription() *string

	// A list of resources (for example licences) this task needs for its execution.
	GetEntitlementClaims() []string

	// A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task.
	GetDependencies() []string

	// Environment variables to use for the task execution.
	GetEnvironmentVariables() []EnvironmentVariable
}

CreateBatchTaskDetails A batch task contains common properties for all types of job tasks.

type CreateBatchTaskDetailsTypeEnum

type CreateBatchTaskDetailsTypeEnum string

CreateBatchTaskDetailsTypeEnum Enum with underlying type: string

const (
	CreateBatchTaskDetailsTypeCompute CreateBatchTaskDetailsTypeEnum = "COMPUTE"
	CreateBatchTaskDetailsTypeGroup   CreateBatchTaskDetailsTypeEnum = "GROUP"
)

Set of constants representing the allowable values for CreateBatchTaskDetailsTypeEnum

func GetCreateBatchTaskDetailsTypeEnumValues

func GetCreateBatchTaskDetailsTypeEnumValues() []CreateBatchTaskDetailsTypeEnum

GetCreateBatchTaskDetailsTypeEnumValues Enumerates the set of values for CreateBatchTaskDetailsTypeEnum

func GetMappingCreateBatchTaskDetailsTypeEnum

func GetMappingCreateBatchTaskDetailsTypeEnum(val string) (CreateBatchTaskDetailsTypeEnum, bool)

GetMappingCreateBatchTaskDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateBatchTaskEnvironmentDetails

type CreateBatchTaskEnvironmentDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The URL of the ocir image.
	ImageUrl *string `mandatory:"true" json:"imageUrl"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// If not specified or provided as null or empty string, it be generated as "<resourceType><timeCreated>", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The batch task environment description.
	Description *string `mandatory:"false" json:"description"`

	SecurityContext *SecurityContext `mandatory:"false" json:"securityContext"`

	// Container's working directory.
	WorkingDirectory *string `mandatory:"false" json:"workingDirectory"`

	// List of volumes attached to the image.
	// The use cases of the volumes are but not limited to: read the input of the task and write the output.
	Volumes []BatchTaskEnvironmentVolume `mandatory:"false" json:"volumes"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

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.

func (CreateBatchTaskEnvironmentDetails) String

func (*CreateBatchTaskEnvironmentDetails) UnmarshalJSON

func (m *CreateBatchTaskEnvironmentDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateBatchTaskEnvironmentDetails) ValidateEnumValue

func (m CreateBatchTaskEnvironmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchTaskEnvironmentRequest

type CreateBatchTaskEnvironmentRequest struct {

	// Details for the new batch task environment.
	CreateBatchTaskEnvironmentDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of running that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and removed from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateBatchTaskEnvironmentRequest wrapper for the CreateBatchTaskEnvironment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchTaskEnvironment.go.html to see an example of how to use CreateBatchTaskEnvironmentRequest.

func (CreateBatchTaskEnvironmentRequest) BinaryRequestBody

func (request CreateBatchTaskEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateBatchTaskEnvironmentRequest) HTTPRequest

func (request CreateBatchTaskEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBatchTaskEnvironmentRequest) RetryPolicy

func (request CreateBatchTaskEnvironmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBatchTaskEnvironmentRequest) String

func (request CreateBatchTaskEnvironmentRequest) String() string

func (CreateBatchTaskEnvironmentRequest) ValidateEnumValue

func (request CreateBatchTaskEnvironmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchTaskEnvironmentResponse

type CreateBatchTaskEnvironmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchTaskEnvironment instance
	BatchTaskEnvironment `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateBatchTaskEnvironmentResponse wrapper for the CreateBatchTaskEnvironment operation

func (CreateBatchTaskEnvironmentResponse) HTTPResponse

func (response CreateBatchTaskEnvironmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBatchTaskEnvironmentResponse) String

func (response CreateBatchTaskEnvironmentResponse) String() string

type CreateBatchTaskProfileDetails

type CreateBatchTaskProfileDetails struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// If not specified or provided as null or empty string, it be generated as "<resourceType><timeCreated>", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskprofile20250914115623.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The batch task profile description.
	Description *string `mandatory:"false" json:"description"`

	// The minimum required OCPUs.
	MinOcpus *int `mandatory:"false" json:"minOcpus"`

	// The minimum required memory.
	MinMemoryInGBs *int `mandatory:"false" json:"minMemoryInGBs"`

	// The minimum required size of disk space in GBs.
	MinDiskSizeInGBs *int `mandatory:"false" json:"minDiskSizeInGBs"`

	ExtendedInformation CreateBatchTaskProfileExtendedInformationDetails `mandatory:"false" json:"extendedInformation"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
}

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.

func (CreateBatchTaskProfileDetails) String

func (*CreateBatchTaskProfileDetails) UnmarshalJSON added in v65.114.0

func (m *CreateBatchTaskProfileDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateBatchTaskProfileDetails) ValidateEnumValue

func (m CreateBatchTaskProfileDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchTaskProfileExtendedInformationDetails added in v65.114.0

type CreateBatchTaskProfileExtendedInformationDetails interface {
}

CreateBatchTaskProfileExtendedInformationDetails Extended information for the task profile.

type CreateBatchTaskProfileExtendedInformationDetailsTypeEnum added in v65.114.0

type CreateBatchTaskProfileExtendedInformationDetailsTypeEnum string

CreateBatchTaskProfileExtendedInformationDetailsTypeEnum Enum with underlying type: string

const (
	CreateBatchTaskProfileExtendedInformationDetailsTypeCpuArchitectureTaskProfileExtendedInformation CreateBatchTaskProfileExtendedInformationDetailsTypeEnum = "CPU_ARCHITECTURE_TASK_PROFILE_EXTENDED_INFORMATION"
	CreateBatchTaskProfileExtendedInformationDetailsTypeCpuShapeTaskProfileExtendedInformation        CreateBatchTaskProfileExtendedInformationDetailsTypeEnum = "CPU_SHAPE_TASK_PROFILE_EXTENDED_INFORMATION"
	CreateBatchTaskProfileExtendedInformationDetailsTypeGpuShapeTaskProfileExtendedInformation        CreateBatchTaskProfileExtendedInformationDetailsTypeEnum = "GPU_SHAPE_TASK_PROFILE_EXTENDED_INFORMATION"
)

Set of constants representing the allowable values for CreateBatchTaskProfileExtendedInformationDetailsTypeEnum

func GetCreateBatchTaskProfileExtendedInformationDetailsTypeEnumValues added in v65.114.0

func GetCreateBatchTaskProfileExtendedInformationDetailsTypeEnumValues() []CreateBatchTaskProfileExtendedInformationDetailsTypeEnum

GetCreateBatchTaskProfileExtendedInformationDetailsTypeEnumValues Enumerates the set of values for CreateBatchTaskProfileExtendedInformationDetailsTypeEnum

func GetMappingCreateBatchTaskProfileExtendedInformationDetailsTypeEnum added in v65.114.0

func GetMappingCreateBatchTaskProfileExtendedInformationDetailsTypeEnum(val string) (CreateBatchTaskProfileExtendedInformationDetailsTypeEnum, bool)

GetMappingCreateBatchTaskProfileExtendedInformationDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateBatchTaskProfileRequest

type CreateBatchTaskProfileRequest struct {

	// Details for the new batch task profile.
	CreateBatchTaskProfileDetails `contributesTo:"body"`

	// A token that uniquely identifies a request so it can be retried in case of a timeout or
	// server error without risk of running that same action again. Retry tokens expire after 24
	// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
	// has been deleted and removed from the system, then a retry of the original creation request
	// might be rejected.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

CreateBatchTaskProfileRequest wrapper for the CreateBatchTaskProfile operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/CreateBatchTaskProfile.go.html to see an example of how to use CreateBatchTaskProfileRequest.

func (CreateBatchTaskProfileRequest) BinaryRequestBody

func (request CreateBatchTaskProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (CreateBatchTaskProfileRequest) HTTPRequest

func (request CreateBatchTaskProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (CreateBatchTaskProfileRequest) RetryPolicy

func (request CreateBatchTaskProfileRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (CreateBatchTaskProfileRequest) String

func (request CreateBatchTaskProfileRequest) String() string

func (CreateBatchTaskProfileRequest) ValidateEnumValue

func (request CreateBatchTaskProfileRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateBatchTaskProfileResponse

type CreateBatchTaskProfileResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchTaskProfile instance
	BatchTaskProfile `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

CreateBatchTaskProfileResponse wrapper for the CreateBatchTaskProfile operation

func (CreateBatchTaskProfileResponse) HTTPResponse

func (response CreateBatchTaskProfileResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (CreateBatchTaskProfileResponse) String

func (response CreateBatchTaskProfileResponse) String() string

type CreateComputeTaskDetails

type CreateComputeTaskDetails struct {

	// The name of the batch task. It must be unique within its parent batch job.
	Name *string `mandatory:"true" json:"name"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the BatchTaskEnvironment.
	BatchTaskEnvironmentId *string `mandatory:"true" json:"batchTaskEnvironmentId"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// A list of resources (for example licences) this task needs for its execution.
	EntitlementClaims []string `mandatory:"false" json:"entitlementClaims"`

	// A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task.
	Dependencies []string `mandatory:"false" json:"dependencies"`

	// Environment variables to use for the task execution.
	EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile used for this task.
	BatchTaskProfileId *string `mandatory:"false" json:"batchTaskProfileId"`

	// An executable command to start the processing of this task.
	Command []string `mandatory:"false" json:"command"`

	// Task arguments.
	Arguments []string `mandatory:"false" json:"arguments"`

	FleetAssignmentPolicy FleetAssignmentPolicy `mandatory:"false" json:"fleetAssignmentPolicy"`
}

CreateComputeTaskDetails compute task represents a single executable command together with its dependencies and resources.

func (CreateComputeTaskDetails) GetDependencies

func (m CreateComputeTaskDetails) GetDependencies() []string

GetDependencies returns Dependencies

func (CreateComputeTaskDetails) GetDescription

func (m CreateComputeTaskDetails) GetDescription() *string

GetDescription returns Description

func (CreateComputeTaskDetails) GetEntitlementClaims

func (m CreateComputeTaskDetails) GetEntitlementClaims() []string

GetEntitlementClaims returns EntitlementClaims

func (CreateComputeTaskDetails) GetEnvironmentVariables

func (m CreateComputeTaskDetails) GetEnvironmentVariables() []EnvironmentVariable

GetEnvironmentVariables returns EnvironmentVariables

func (CreateComputeTaskDetails) GetName

func (m CreateComputeTaskDetails) GetName() *string

GetName returns Name

func (CreateComputeTaskDetails) MarshalJSON

func (m CreateComputeTaskDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateComputeTaskDetails) String

func (m CreateComputeTaskDetails) String() string

func (*CreateComputeTaskDetails) UnmarshalJSON

func (m *CreateComputeTaskDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateComputeTaskDetails) ValidateEnumValue

func (m CreateComputeTaskDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateCpuArchitectureTaskProfileExtendedInformationDetails added in v65.114.0

type CreateCpuArchitectureTaskProfileExtendedInformationDetails struct {

	// Type of CPU architecture.
	Architecture CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum `mandatory:"true" json:"architecture"`
}

CreateCpuArchitectureTaskProfileExtendedInformationDetails Extended information about CPU architecture for the task profile.

func (CreateCpuArchitectureTaskProfileExtendedInformationDetails) MarshalJSON added in v65.114.0

MarshalJSON marshals to json representation

func (CreateCpuArchitectureTaskProfileExtendedInformationDetails) String added in v65.114.0

func (CreateCpuArchitectureTaskProfileExtendedInformationDetails) ValidateEnumValue added in v65.114.0

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum added in v65.114.0

type CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum string

CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum Enum with underlying type: string

const (
	CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureX86 CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum = "GENERIC_X86"
	CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureArm CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum = "GENERIC_ARM"
)

Set of constants representing the allowable values for CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum

func GetCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnumValues added in v65.114.0

func GetCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnumValues() []CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum

GetCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnumValues Enumerates the set of values for CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum

func GetMappingCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum added in v65.114.0

func GetMappingCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum(val string) (CreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum, bool)

GetMappingCreateCpuArchitectureTaskProfileExtendedInformationDetailsArchitectureEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateCpuShapeTaskProfileExtendedInformationDetails added in v65.114.0

type CreateCpuShapeTaskProfileExtendedInformationDetails struct {

	// A name of the CPU shape.
	ShapeName *string `mandatory:"true" json:"shapeName"`
}

CreateCpuShapeTaskProfileExtendedInformationDetails Extended information for the CPU-specific task profile.

func (CreateCpuShapeTaskProfileExtendedInformationDetails) MarshalJSON added in v65.114.0

MarshalJSON marshals to json representation

func (CreateCpuShapeTaskProfileExtendedInformationDetails) String added in v65.114.0

func (CreateCpuShapeTaskProfileExtendedInformationDetails) ValidateEnumValue added in v65.114.0

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateFixedGpuFleetShapeDetails added in v65.114.0

type CreateFixedGpuFleetShapeDetails struct {

	// The name of the fixed GPU fleet shape.
	ShapeName *string `mandatory:"true" json:"shapeName"`

	// Amount of disk space in GBs required for the shape.
	DiskSizeInGBs *int `mandatory:"false" json:"diskSizeInGBs"`
}

CreateFixedGpuFleetShapeDetails Fixed shape of the GPU fleet. Describes hardware resources of each node in the fleet.

func (CreateFixedGpuFleetShapeDetails) MarshalJSON added in v65.114.0

func (m CreateFixedGpuFleetShapeDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateFixedGpuFleetShapeDetails) String added in v65.114.0

func (CreateFixedGpuFleetShapeDetails) ValidateEnumValue added in v65.114.0

func (m CreateFixedGpuFleetShapeDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateFleetDetails

type CreateFleetDetails interface {
}

CreateFleetDetails Fleet configuration of the batch context.

type CreateFleetDetailsTypeEnum

type CreateFleetDetailsTypeEnum string

CreateFleetDetailsTypeEnum Enum with underlying type: string

const (
	CreateFleetDetailsTypeFleet    CreateFleetDetailsTypeEnum = "SERVICE_MANAGED_FLEET"
	CreateFleetDetailsTypeGpuFleet CreateFleetDetailsTypeEnum = "SERVICE_MANAGED_GPU_FLEET"
)

Set of constants representing the allowable values for CreateFleetDetailsTypeEnum

func GetCreateFleetDetailsTypeEnumValues

func GetCreateFleetDetailsTypeEnumValues() []CreateFleetDetailsTypeEnum

GetCreateFleetDetailsTypeEnumValues Enumerates the set of values for CreateFleetDetailsTypeEnum

func GetMappingCreateFleetDetailsTypeEnum

func GetMappingCreateFleetDetailsTypeEnum(val string) (CreateFleetDetailsTypeEnum, bool)

GetMappingCreateFleetDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateGpuFleetShapeDetails added in v65.114.0

type CreateGpuFleetShapeDetails interface {
}

CreateGpuFleetShapeDetails Shape of the GPU fleet. Describes hardware resources of each node in the fleet.

type CreateGpuFleetShapeDetailsTypeEnum added in v65.114.0

type CreateGpuFleetShapeDetailsTypeEnum string

CreateGpuFleetShapeDetailsTypeEnum Enum with underlying type: string

const (
	CreateGpuFleetShapeDetailsTypeFixedGpuFleetShape CreateGpuFleetShapeDetailsTypeEnum = "FIXED_GPU_FLEET_SHAPE"
)

Set of constants representing the allowable values for CreateGpuFleetShapeDetailsTypeEnum

func GetCreateGpuFleetShapeDetailsTypeEnumValues added in v65.114.0

func GetCreateGpuFleetShapeDetailsTypeEnumValues() []CreateGpuFleetShapeDetailsTypeEnum

GetCreateGpuFleetShapeDetailsTypeEnumValues Enumerates the set of values for CreateGpuFleetShapeDetailsTypeEnum

func GetMappingCreateGpuFleetShapeDetailsTypeEnum added in v65.114.0

func GetMappingCreateGpuFleetShapeDetailsTypeEnum(val string) (CreateGpuFleetShapeDetailsTypeEnum, bool)

GetMappingCreateGpuFleetShapeDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type CreateGpuShapeTaskProfileExtendedInformationDetails added in v65.114.0

type CreateGpuShapeTaskProfileExtendedInformationDetails struct {

	// A name of the GPU shape.
	ShapeName *string `mandatory:"true" json:"shapeName"`
}

CreateGpuShapeTaskProfileExtendedInformationDetails Extended information for the GPU-specific task profile.

func (CreateGpuShapeTaskProfileExtendedInformationDetails) MarshalJSON added in v65.114.0

MarshalJSON marshals to json representation

func (CreateGpuShapeTaskProfileExtendedInformationDetails) String added in v65.114.0

func (CreateGpuShapeTaskProfileExtendedInformationDetails) ValidateEnumValue added in v65.114.0

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateGroupTaskDetails added in v65.114.0

type CreateGroupTaskDetails struct {

	// The name of the batch task. It must be unique within its parent batch job.
	Name *string `mandatory:"true" json:"name"`

	// A list of tasks to be executed within this group task.
	Tasks []CreateBatchTaskDetails `mandatory:"true" json:"tasks"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// A list of resources (for example licences) this task needs for its execution.
	EntitlementClaims []string `mandatory:"false" json:"entitlementClaims"`

	// A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task.
	Dependencies []string `mandatory:"false" json:"dependencies"`

	// Environment variables to use for the task execution.
	EnvironmentVariables []EnvironmentVariable `mandatory:"false" json:"environmentVariables"`
}

CreateGroupTaskDetails Group task is a construct that represents a container of tasks for execution.

func (CreateGroupTaskDetails) GetDependencies added in v65.114.0

func (m CreateGroupTaskDetails) GetDependencies() []string

GetDependencies returns Dependencies

func (CreateGroupTaskDetails) GetDescription added in v65.114.0

func (m CreateGroupTaskDetails) GetDescription() *string

GetDescription returns Description

func (CreateGroupTaskDetails) GetEntitlementClaims added in v65.114.0

func (m CreateGroupTaskDetails) GetEntitlementClaims() []string

GetEntitlementClaims returns EntitlementClaims

func (CreateGroupTaskDetails) GetEnvironmentVariables added in v65.114.0

func (m CreateGroupTaskDetails) GetEnvironmentVariables() []EnvironmentVariable

GetEnvironmentVariables returns EnvironmentVariables

func (CreateGroupTaskDetails) GetName added in v65.114.0

func (m CreateGroupTaskDetails) GetName() *string

GetName returns Name

func (CreateGroupTaskDetails) MarshalJSON added in v65.114.0

func (m CreateGroupTaskDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateGroupTaskDetails) String added in v65.114.0

func (m CreateGroupTaskDetails) String() string

func (*CreateGroupTaskDetails) UnmarshalJSON added in v65.114.0

func (m *CreateGroupTaskDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateGroupTaskDetails) ValidateEnumValue added in v65.114.0

func (m CreateGroupTaskDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateNetworkDetails

type CreateNetworkDetails struct {

	// OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// A list of OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated network security groups.
	NsgIds []string `mandatory:"false" json:"nsgIds"`
}

CreateNetworkDetails Network configuration of the batch context.

func (CreateNetworkDetails) String

func (m CreateNetworkDetails) String() string

func (CreateNetworkDetails) ValidateEnumValue

func (m CreateNetworkDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateServiceManagedFleetDetails

type CreateServiceManagedFleetDetails struct {

	// Name of the service managed fleet.
	Name *string `mandatory:"true" json:"name"`

	Shape *FleetShape `mandatory:"true" json:"shape"`

	// Maximum number of concurrent tasks for the service managed fleet.
	MaxConcurrentTasks *int `mandatory:"true" json:"maxConcurrentTasks"`
}

CreateServiceManagedFleetDetails Service managed Fleet configuration of the batch context.

func (CreateServiceManagedFleetDetails) MarshalJSON

func (m CreateServiceManagedFleetDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateServiceManagedFleetDetails) String

func (CreateServiceManagedFleetDetails) ValidateEnumValue

func (m CreateServiceManagedFleetDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type CreateServiceManagedGpuFleetDetails added in v65.114.0

type CreateServiceManagedGpuFleetDetails struct {

	// Name of the service managed GPU fleet.
	Name *string `mandatory:"true" json:"name"`

	Shape CreateGpuFleetShapeDetails `mandatory:"true" json:"shape"`

	// Maximum number of concurrent tasks for the service managed GPU fleet.
	MaxConcurrentTasks *int `mandatory:"true" json:"maxConcurrentTasks"`
}

CreateServiceManagedGpuFleetDetails Service managed GPU Fleet configuration of the batch context.

func (CreateServiceManagedGpuFleetDetails) MarshalJSON added in v65.114.0

func (m CreateServiceManagedGpuFleetDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreateServiceManagedGpuFleetDetails) String added in v65.114.0

func (*CreateServiceManagedGpuFleetDetails) UnmarshalJSON added in v65.114.0

func (m *CreateServiceManagedGpuFleetDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (CreateServiceManagedGpuFleetDetails) ValidateEnumValue added in v65.114.0

func (m CreateServiceManagedGpuFleetDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteBatchContextRequest

type DeleteBatchContextRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	BatchContextId *string `mandatory:"true" contributesTo:"path" name:"batchContextId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteBatchContextRequest wrapper for the DeleteBatchContext operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/DeleteBatchContext.go.html to see an example of how to use DeleteBatchContextRequest.

func (DeleteBatchContextRequest) BinaryRequestBody

func (request DeleteBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteBatchContextRequest) HTTPRequest

func (request DeleteBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBatchContextRequest) RetryPolicy

func (request DeleteBatchContextRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBatchContextRequest) String

func (request DeleteBatchContextRequest) String() string

func (DeleteBatchContextRequest) ValidateEnumValue

func (request DeleteBatchContextRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteBatchContextResponse

type DeleteBatchContextResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteBatchContextResponse wrapper for the DeleteBatchContext operation

func (DeleteBatchContextResponse) HTTPResponse

func (response DeleteBatchContextResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBatchContextResponse) String

func (response DeleteBatchContextResponse) String() string

type DeleteBatchJobPoolRequest

type DeleteBatchJobPoolRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	BatchJobPoolId *string `mandatory:"true" contributesTo:"path" name:"batchJobPoolId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteBatchJobPoolRequest wrapper for the DeleteBatchJobPool operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/DeleteBatchJobPool.go.html to see an example of how to use DeleteBatchJobPoolRequest.

func (DeleteBatchJobPoolRequest) BinaryRequestBody

func (request DeleteBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteBatchJobPoolRequest) HTTPRequest

func (request DeleteBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBatchJobPoolRequest) RetryPolicy

func (request DeleteBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBatchJobPoolRequest) String

func (request DeleteBatchJobPoolRequest) String() string

func (DeleteBatchJobPoolRequest) ValidateEnumValue

func (request DeleteBatchJobPoolRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteBatchJobPoolResponse

type DeleteBatchJobPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteBatchJobPoolResponse wrapper for the DeleteBatchJobPool operation

func (DeleteBatchJobPoolResponse) HTTPResponse

func (response DeleteBatchJobPoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBatchJobPoolResponse) String

func (response DeleteBatchJobPoolResponse) String() string

type DeleteBatchTaskEnvironmentRequest

type DeleteBatchTaskEnvironmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment.
	BatchTaskEnvironmentId *string `mandatory:"true" contributesTo:"path" name:"batchTaskEnvironmentId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteBatchTaskEnvironmentRequest wrapper for the DeleteBatchTaskEnvironment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/DeleteBatchTaskEnvironment.go.html to see an example of how to use DeleteBatchTaskEnvironmentRequest.

func (DeleteBatchTaskEnvironmentRequest) BinaryRequestBody

func (request DeleteBatchTaskEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteBatchTaskEnvironmentRequest) HTTPRequest

func (request DeleteBatchTaskEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBatchTaskEnvironmentRequest) RetryPolicy

func (request DeleteBatchTaskEnvironmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBatchTaskEnvironmentRequest) String

func (request DeleteBatchTaskEnvironmentRequest) String() string

func (DeleteBatchTaskEnvironmentRequest) ValidateEnumValue

func (request DeleteBatchTaskEnvironmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteBatchTaskEnvironmentResponse

type DeleteBatchTaskEnvironmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteBatchTaskEnvironmentResponse wrapper for the DeleteBatchTaskEnvironment operation

func (DeleteBatchTaskEnvironmentResponse) HTTPResponse

func (response DeleteBatchTaskEnvironmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBatchTaskEnvironmentResponse) String

func (response DeleteBatchTaskEnvironmentResponse) String() string

type DeleteBatchTaskProfileRequest

type DeleteBatchTaskProfileRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile.
	BatchTaskProfileId *string `mandatory:"true" contributesTo:"path" name:"batchTaskProfileId"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

DeleteBatchTaskProfileRequest wrapper for the DeleteBatchTaskProfile operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/DeleteBatchTaskProfile.go.html to see an example of how to use DeleteBatchTaskProfileRequest.

func (DeleteBatchTaskProfileRequest) BinaryRequestBody

func (request DeleteBatchTaskProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (DeleteBatchTaskProfileRequest) HTTPRequest

func (request DeleteBatchTaskProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (DeleteBatchTaskProfileRequest) RetryPolicy

func (request DeleteBatchTaskProfileRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (DeleteBatchTaskProfileRequest) String

func (request DeleteBatchTaskProfileRequest) String() string

func (DeleteBatchTaskProfileRequest) ValidateEnumValue

func (request DeleteBatchTaskProfileRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type DeleteBatchTaskProfileResponse

type DeleteBatchTaskProfileResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

DeleteBatchTaskProfileResponse wrapper for the DeleteBatchTaskProfile operation

func (DeleteBatchTaskProfileResponse) HTTPResponse

func (response DeleteBatchTaskProfileResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (DeleteBatchTaskProfileResponse) String

func (response DeleteBatchTaskProfileResponse) String() string

type EnvironmentVariable

type EnvironmentVariable struct {

	// The name of the environment variable.
	Name *string `mandatory:"true" json:"name"`

	// The value of the environment variable.
	Value *string `mandatory:"true" json:"value"`
}

EnvironmentVariable OS environment variable.

func (EnvironmentVariable) String

func (m EnvironmentVariable) String() string

func (EnvironmentVariable) ValidateEnumValue

func (m EnvironmentVariable) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FixedGpuFleetShape added in v65.114.0

type FixedGpuFleetShape struct {

	// The name of the fixed GPU fleet shape.
	ShapeName *string `mandatory:"true" json:"shapeName"`

	// Amount of disk space in GBs required for the shape.
	DiskSizeInGBs *int `mandatory:"false" json:"diskSizeInGBs"`
}

FixedGpuFleetShape Fixed shape of the GPU fleet. Describes hardware resources of each node in the fleet.

func (FixedGpuFleetShape) MarshalJSON added in v65.114.0

func (m FixedGpuFleetShape) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (FixedGpuFleetShape) String added in v65.114.0

func (m FixedGpuFleetShape) String() string

func (FixedGpuFleetShape) ValidateEnumValue added in v65.114.0

func (m FixedGpuFleetShape) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Fleet

type Fleet interface {
}

Fleet Fleet configuration of the batch context.

type FleetAssignmentPolicy

type FleetAssignmentPolicy interface {
}

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.

type FleetAssignmentPolicyTypeEnum

type FleetAssignmentPolicyTypeEnum string

FleetAssignmentPolicyTypeEnum Enum with underlying type: string

const (
	FleetAssignmentPolicyTypeBestFit FleetAssignmentPolicyTypeEnum = "BEST_FIT"
	FleetAssignmentPolicyTypeFlexFit FleetAssignmentPolicyTypeEnum = "FLEX_FIT"
)

Set of constants representing the allowable values for FleetAssignmentPolicyTypeEnum

func GetFleetAssignmentPolicyTypeEnumValues

func GetFleetAssignmentPolicyTypeEnumValues() []FleetAssignmentPolicyTypeEnum

GetFleetAssignmentPolicyTypeEnumValues Enumerates the set of values for FleetAssignmentPolicyTypeEnum

func GetMappingFleetAssignmentPolicyTypeEnum

func GetMappingFleetAssignmentPolicyTypeEnum(val string) (FleetAssignmentPolicyTypeEnum, bool)

GetMappingFleetAssignmentPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type FleetShape

type FleetShape struct {

	// The name of the shape.
	ShapeName *string `mandatory:"true" json:"shapeName"`

	// Number of OCPUs required for the shape.
	Ocpus *int `mandatory:"true" json:"ocpus"`

	// Amount of memory in GBs required for the shape.
	MemoryInGBs *int `mandatory:"true" json:"memoryInGBs"`

	// Amount of disk space in GBs required for the shape.
	DiskSizeInGBs *int `mandatory:"false" json:"diskSizeInGBs"`
}

FleetShape Shape of the fleet. Describes hardware resources of each node in the fleet.

func (FleetShape) String

func (m FleetShape) String() string

func (FleetShape) ValidateEnumValue

func (m FleetShape) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type FleetShapeExecutionDetails added in v65.114.0

type FleetShapeExecutionDetails interface {
}

FleetShapeExecutionDetails Details about the shape which was used for the task execution.

type FleetShapeExecutionDetailsTypeEnum added in v65.114.0

type FleetShapeExecutionDetailsTypeEnum string

FleetShapeExecutionDetailsTypeEnum Enum with underlying type: string

const (
	FleetShapeExecutionDetailsTypeCpuFleetShapeExecutionDetails FleetShapeExecutionDetailsTypeEnum = "CPU_FLEET_SHAPE_EXECUTION_DETAILS"
	FleetShapeExecutionDetailsTypeGpuFleetShapeExecutionDetails FleetShapeExecutionDetailsTypeEnum = "GPU_FLEET_SHAPE_EXECUTION_DETAILS"
)

Set of constants representing the allowable values for FleetShapeExecutionDetailsTypeEnum

func GetFleetShapeExecutionDetailsTypeEnumValues added in v65.114.0

func GetFleetShapeExecutionDetailsTypeEnumValues() []FleetShapeExecutionDetailsTypeEnum

GetFleetShapeExecutionDetailsTypeEnumValues Enumerates the set of values for FleetShapeExecutionDetailsTypeEnum

func GetMappingFleetShapeExecutionDetailsTypeEnum added in v65.114.0

func GetMappingFleetShapeExecutionDetailsTypeEnum(val string) (FleetShapeExecutionDetailsTypeEnum, bool)

GetMappingFleetShapeExecutionDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type FleetTypeEnum

type FleetTypeEnum string

FleetTypeEnum Enum with underlying type: string

const (
	FleetTypeFleet    FleetTypeEnum = "SERVICE_MANAGED_FLEET"
	FleetTypeGpuFleet FleetTypeEnum = "SERVICE_MANAGED_GPU_FLEET"
)

Set of constants representing the allowable values for FleetTypeEnum

func GetFleetTypeEnumValues

func GetFleetTypeEnumValues() []FleetTypeEnum

GetFleetTypeEnumValues Enumerates the set of values for FleetTypeEnum

func GetMappingFleetTypeEnum

func GetMappingFleetTypeEnum(val string) (FleetTypeEnum, bool)

GetMappingFleetTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type FlexFitFleetAssignmentPolicy

type FlexFitFleetAssignmentPolicy struct {

	// Specifies how much larger a fleet's nodes (shape) can be to still be considered for a task.
	// If threshold is not supplied the task will use any sufficient node available regards to minimum hardware requirements.
	Threshold *float32 `mandatory:"false" json:"threshold"`
}

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.

func (FlexFitFleetAssignmentPolicy) MarshalJSON

func (m FlexFitFleetAssignmentPolicy) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (FlexFitFleetAssignmentPolicy) String

func (FlexFitFleetAssignmentPolicy) ValidateEnumValue

func (m FlexFitFleetAssignmentPolicy) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetBatchContextRequest

type GetBatchContextRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	BatchContextId *string `mandatory:"true" contributesTo:"path" name:"batchContextId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetBatchContextRequest wrapper for the GetBatchContext operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchContext.go.html to see an example of how to use GetBatchContextRequest.

func (GetBatchContextRequest) BinaryRequestBody

func (request GetBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetBatchContextRequest) HTTPRequest

func (request GetBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBatchContextRequest) RetryPolicy

func (request GetBatchContextRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBatchContextRequest) String

func (request GetBatchContextRequest) String() string

func (GetBatchContextRequest) ValidateEnumValue

func (request GetBatchContextRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetBatchContextResponse

type GetBatchContextResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchContext instance
	BatchContext `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBatchContextResponse wrapper for the GetBatchContext operation

func (GetBatchContextResponse) HTTPResponse

func (response GetBatchContextResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBatchContextResponse) String

func (response GetBatchContextResponse) String() string

type GetBatchJobPoolRequest

type GetBatchJobPoolRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	BatchJobPoolId *string `mandatory:"true" contributesTo:"path" name:"batchJobPoolId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetBatchJobPoolRequest wrapper for the GetBatchJobPool operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchJobPool.go.html to see an example of how to use GetBatchJobPoolRequest.

func (GetBatchJobPoolRequest) BinaryRequestBody

func (request GetBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetBatchJobPoolRequest) HTTPRequest

func (request GetBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBatchJobPoolRequest) RetryPolicy

func (request GetBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBatchJobPoolRequest) String

func (request GetBatchJobPoolRequest) String() string

func (GetBatchJobPoolRequest) ValidateEnumValue

func (request GetBatchJobPoolRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetBatchJobPoolResponse

type GetBatchJobPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchJobPool instance
	BatchJobPool `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBatchJobPoolResponse wrapper for the GetBatchJobPool operation

func (GetBatchJobPoolResponse) HTTPResponse

func (response GetBatchJobPoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBatchJobPoolResponse) String

func (response GetBatchJobPoolResponse) String() string

type GetBatchJobRequest

type GetBatchJobRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"true" contributesTo:"path" name:"batchJobId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetBatchJobRequest wrapper for the GetBatchJob operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchJob.go.html to see an example of how to use GetBatchJobRequest.

func (GetBatchJobRequest) BinaryRequestBody

func (request GetBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetBatchJobRequest) HTTPRequest

func (request GetBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBatchJobRequest) RetryPolicy

func (request GetBatchJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBatchJobRequest) String

func (request GetBatchJobRequest) String() string

func (GetBatchJobRequest) ValidateEnumValue

func (request GetBatchJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetBatchJobResponse

type GetBatchJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchJob instance
	BatchJob `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBatchJobResponse wrapper for the GetBatchJob operation

func (GetBatchJobResponse) HTTPResponse

func (response GetBatchJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBatchJobResponse) String

func (response GetBatchJobResponse) String() string

type GetBatchTaskEnvironmentRequest

type GetBatchTaskEnvironmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment.
	BatchTaskEnvironmentId *string `mandatory:"true" contributesTo:"path" name:"batchTaskEnvironmentId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetBatchTaskEnvironmentRequest wrapper for the GetBatchTaskEnvironment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchTaskEnvironment.go.html to see an example of how to use GetBatchTaskEnvironmentRequest.

func (GetBatchTaskEnvironmentRequest) BinaryRequestBody

func (request GetBatchTaskEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetBatchTaskEnvironmentRequest) HTTPRequest

func (request GetBatchTaskEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBatchTaskEnvironmentRequest) RetryPolicy

func (request GetBatchTaskEnvironmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBatchTaskEnvironmentRequest) String

func (request GetBatchTaskEnvironmentRequest) String() string

func (GetBatchTaskEnvironmentRequest) ValidateEnumValue

func (request GetBatchTaskEnvironmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetBatchTaskEnvironmentResponse

type GetBatchTaskEnvironmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchTaskEnvironment instance
	BatchTaskEnvironment `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBatchTaskEnvironmentResponse wrapper for the GetBatchTaskEnvironment operation

func (GetBatchTaskEnvironmentResponse) HTTPResponse

func (response GetBatchTaskEnvironmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBatchTaskEnvironmentResponse) String

func (response GetBatchTaskEnvironmentResponse) String() string

type GetBatchTaskProfileRequest

type GetBatchTaskProfileRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile.
	BatchTaskProfileId *string `mandatory:"true" contributesTo:"path" name:"batchTaskProfileId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetBatchTaskProfileRequest wrapper for the GetBatchTaskProfile operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchTaskProfile.go.html to see an example of how to use GetBatchTaskProfileRequest.

func (GetBatchTaskProfileRequest) BinaryRequestBody

func (request GetBatchTaskProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetBatchTaskProfileRequest) HTTPRequest

func (request GetBatchTaskProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBatchTaskProfileRequest) RetryPolicy

func (request GetBatchTaskProfileRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBatchTaskProfileRequest) String

func (request GetBatchTaskProfileRequest) String() string

func (GetBatchTaskProfileRequest) ValidateEnumValue

func (request GetBatchTaskProfileRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetBatchTaskProfileResponse

type GetBatchTaskProfileResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchTaskProfile instance
	BatchTaskProfile `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBatchTaskProfileResponse wrapper for the GetBatchTaskProfile operation

func (GetBatchTaskProfileResponse) HTTPResponse

func (response GetBatchTaskProfileResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBatchTaskProfileResponse) String

func (response GetBatchTaskProfileResponse) String() string

type GetBatchTaskRequest

type GetBatchTaskRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"true" contributesTo:"path" name:"batchJobId"`

	// The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can't pass both.
	TaskName *string `mandatory:"true" contributesTo:"path" name:"taskName"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetBatchTaskRequest wrapper for the GetBatchTask operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetBatchTask.go.html to see an example of how to use GetBatchTaskRequest.

func (GetBatchTaskRequest) BinaryRequestBody

func (request GetBatchTaskRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetBatchTaskRequest) HTTPRequest

func (request GetBatchTaskRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetBatchTaskRequest) RetryPolicy

func (request GetBatchTaskRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetBatchTaskRequest) String

func (request GetBatchTaskRequest) String() string

func (GetBatchTaskRequest) ValidateEnumValue

func (request GetBatchTaskRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetBatchTaskResponse

type GetBatchTaskResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchTask instance
	BatchTask `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

GetBatchTaskResponse wrapper for the GetBatchTask operation

func (GetBatchTaskResponse) HTTPResponse

func (response GetBatchTaskResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetBatchTaskResponse) String

func (response GetBatchTaskResponse) String() string

type GetWorkRequestRequest

type GetWorkRequestRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody

func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest

func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy

func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (GetWorkRequestRequest) String

func (request GetWorkRequestRequest) String() string

func (GetWorkRequestRequest) ValidateEnumValue

func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GetWorkRequestResponse

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The WorkRequest instance
	WorkRequest `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse

func (response GetWorkRequestResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String

func (response GetWorkRequestResponse) String() string

type GpuFleetShape added in v65.114.0

type GpuFleetShape interface {
}

GpuFleetShape Shape of the GPU fleet. Describes hardware resources of each node in the fleet.

type GpuFleetShapeExecutionDetails added in v65.114.0

type GpuFleetShapeExecutionDetails struct {

	// Name of the shape.
	ShapeName *string `mandatory:"false" json:"shapeName"`

	// Number of OCPUs provided by the shape.
	Ocpus *int `mandatory:"false" json:"ocpus"`

	// Amount of memory in GBs provided by the shape.
	MemoryInGBs *int `mandatory:"false" json:"memoryInGBs"`

	// Amount of disk space provided by the shape.
	DiskSizeInGBs *int `mandatory:"false" json:"diskSizeInGBs"`

	// The number of GPUs provided by the shape.
	Gpus *int `mandatory:"false" json:"gpus"`
}

GpuFleetShapeExecutionDetails Details about the GPU shape which was used for the task execution.

func (GpuFleetShapeExecutionDetails) MarshalJSON added in v65.114.0

func (m GpuFleetShapeExecutionDetails) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (GpuFleetShapeExecutionDetails) String added in v65.114.0

func (GpuFleetShapeExecutionDetails) ValidateEnumValue added in v65.114.0

func (m GpuFleetShapeExecutionDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GpuFleetShapeTypeEnum added in v65.114.0

type GpuFleetShapeTypeEnum string

GpuFleetShapeTypeEnum Enum with underlying type: string

const (
	GpuFleetShapeTypeFixedGpuFleetShape GpuFleetShapeTypeEnum = "FIXED_GPU_FLEET_SHAPE"
)

Set of constants representing the allowable values for GpuFleetShapeTypeEnum

func GetGpuFleetShapeTypeEnumValues added in v65.114.0

func GetGpuFleetShapeTypeEnumValues() []GpuFleetShapeTypeEnum

GetGpuFleetShapeTypeEnumValues Enumerates the set of values for GpuFleetShapeTypeEnum

func GetMappingGpuFleetShapeTypeEnum added in v65.114.0

func GetMappingGpuFleetShapeTypeEnum(val string) (GpuFleetShapeTypeEnum, bool)

GetMappingGpuFleetShapeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type GpuShapeTaskProfileExtendedInformation added in v65.114.0

type GpuShapeTaskProfileExtendedInformation struct {

	// A name of the GPU shape.
	ShapeName *string `mandatory:"true" json:"shapeName"`
}

GpuShapeTaskProfileExtendedInformation Extended information for the GPU-specific task profile.

func (GpuShapeTaskProfileExtendedInformation) MarshalJSON added in v65.114.0

func (m GpuShapeTaskProfileExtendedInformation) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (GpuShapeTaskProfileExtendedInformation) String added in v65.114.0

func (GpuShapeTaskProfileExtendedInformation) ValidateEnumValue added in v65.114.0

func (m GpuShapeTaskProfileExtendedInformation) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GroupTask added in v65.114.0

type GroupTask struct {

	// The UUID of batch task.
	Id *string `mandatory:"true" json:"id"`

	// The name of the batch task. It must be unique within its parent batch job.
	Name *string `mandatory:"true" json:"name"`

	// A list of resources (for example licences) this task needs for its execution.
	EntitlementClaims []string `mandatory:"true" json:"entitlementClaims"`

	// A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task.
	Dependencies []string `mandatory:"true" json:"dependencies"`

	// Environment variables to use for the task execution.
	EnvironmentVariables []EnvironmentVariable `mandatory:"true" json:"environmentVariables"`

	// The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName
	HierarchicalName *string `mandatory:"false" json:"hierarchicalName"`

	// The hierarchical name of the group task. Null for top-level tasks.
	GroupTaskName *string `mandatory:"false" json:"groupTaskName"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// The names of tasks contained directly (non-recursively) within this group task.
	Tasks []string `mandatory:"false" json:"tasks"`

	// The current state of the batch task.
	LifecycleState BatchTaskLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

GroupTask Group task is a construct that represents a container of tasks for execution.

func (GroupTask) GetDependencies added in v65.114.0

func (m GroupTask) GetDependencies() []string

GetDependencies returns Dependencies

func (GroupTask) GetDescription added in v65.114.0

func (m GroupTask) GetDescription() *string

GetDescription returns Description

func (GroupTask) GetEntitlementClaims added in v65.114.0

func (m GroupTask) GetEntitlementClaims() []string

GetEntitlementClaims returns EntitlementClaims

func (GroupTask) GetEnvironmentVariables added in v65.114.0

func (m GroupTask) GetEnvironmentVariables() []EnvironmentVariable

GetEnvironmentVariables returns EnvironmentVariables

func (GroupTask) GetGroupTaskName added in v65.114.0

func (m GroupTask) GetGroupTaskName() *string

GetGroupTaskName returns GroupTaskName

func (GroupTask) GetHierarchicalName added in v65.114.0

func (m GroupTask) GetHierarchicalName() *string

GetHierarchicalName returns HierarchicalName

func (GroupTask) GetId added in v65.114.0

func (m GroupTask) GetId() *string

GetId returns Id

func (GroupTask) GetLifecycleDetails added in v65.114.0

func (m GroupTask) GetLifecycleDetails() *string

GetLifecycleDetails returns LifecycleDetails

func (GroupTask) GetLifecycleState added in v65.114.0

func (m GroupTask) GetLifecycleState() BatchTaskLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (GroupTask) GetName added in v65.114.0

func (m GroupTask) GetName() *string

GetName returns Name

func (GroupTask) MarshalJSON added in v65.114.0

func (m GroupTask) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (GroupTask) String added in v65.114.0

func (m GroupTask) String() string

func (GroupTask) ValidateEnumValue added in v65.114.0

func (m GroupTask) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type GroupTaskSummary added in v65.114.0

type GroupTaskSummary struct {

	// The UUID of batch task.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job to which this task belongs.
	JobId *string `mandatory:"true" json:"jobId"`

	// The name of the batch task. It must be unique within its parent batch job.
	Name *string `mandatory:"true" json:"name"`

	// The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName
	HierarchicalName *string `mandatory:"false" json:"hierarchicalName"`

	// The hierarchical name of the group task. Null for top-level tasks.
	GroupTaskName *string `mandatory:"false" json:"groupTaskName"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// A message that describes the current state of the batch task in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
	LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`

	// The count of tasks contained directly (non-recursively) within this group task.
	TaskCount *int `mandatory:"false" json:"taskCount"`

	// The current state of the batch task.
	LifecycleState BatchTaskLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

GroupTaskSummary Summary information about a group task.

func (GroupTaskSummary) GetDescription added in v65.114.0

func (m GroupTaskSummary) GetDescription() *string

GetDescription returns Description

func (GroupTaskSummary) GetGroupTaskName added in v65.114.0

func (m GroupTaskSummary) GetGroupTaskName() *string

GetGroupTaskName returns GroupTaskName

func (GroupTaskSummary) GetHierarchicalName added in v65.114.0

func (m GroupTaskSummary) GetHierarchicalName() *string

GetHierarchicalName returns HierarchicalName

func (GroupTaskSummary) GetId added in v65.114.0

func (m GroupTaskSummary) GetId() *string

GetId returns Id

func (GroupTaskSummary) GetJobId added in v65.114.0

func (m GroupTaskSummary) GetJobId() *string

GetJobId returns JobId

func (GroupTaskSummary) GetLifecycleDetails added in v65.114.0

func (m GroupTaskSummary) GetLifecycleDetails() *string

GetLifecycleDetails returns LifecycleDetails

func (GroupTaskSummary) GetLifecycleState added in v65.114.0

func (m GroupTaskSummary) GetLifecycleState() BatchTaskLifecycleStateEnum

GetLifecycleState returns LifecycleState

func (GroupTaskSummary) GetName added in v65.114.0

func (m GroupTaskSummary) GetName() *string

GetName returns Name

func (GroupTaskSummary) MarshalJSON added in v65.114.0

func (m GroupTaskSummary) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (GroupTaskSummary) String added in v65.114.0

func (m GroupTaskSummary) String() string

func (GroupTaskSummary) ValidateEnumValue added in v65.114.0

func (m GroupTaskSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type JobPriorityConfiguration

type JobPriorityConfiguration struct {

	// Name of the corresponding tag namespace.
	TagNamespace *string `mandatory:"true" json:"tagNamespace"`

	// Name of the tag key.
	TagKey *string `mandatory:"true" json:"tagKey"`

	// Weight associated with the tag key. Percentage point is the unit of measurement.
	Weight *int `mandatory:"true" json:"weight"`

	// Mapping of tag value to its priority.
	Values map[string]int `mandatory:"true" json:"values"`
}

JobPriorityConfiguration Job priority configuration to instruct the service on how to use priority tags.

func (JobPriorityConfiguration) String

func (m JobPriorityConfiguration) String() string

func (JobPriorityConfiguration) ValidateEnumValue

func (m JobPriorityConfiguration) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchContextShapesRequest

type ListBatchContextShapesRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The name of the availability domain.
	AvailabilityDomain *string `mandatory:"false" contributesTo:"query" name:"availabilityDomain"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The type of a shape.
	ShapeType ListBatchContextShapesShapeTypeEnum `mandatory:"false" contributesTo:"query" name:"shapeType" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBatchContextShapesRequest wrapper for the ListBatchContextShapes operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchContextShapes.go.html to see an example of how to use ListBatchContextShapesRequest.

func (ListBatchContextShapesRequest) BinaryRequestBody

func (request ListBatchContextShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBatchContextShapesRequest) HTTPRequest

func (request ListBatchContextShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBatchContextShapesRequest) RetryPolicy

func (request ListBatchContextShapesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBatchContextShapesRequest) String

func (request ListBatchContextShapesRequest) String() string

func (ListBatchContextShapesRequest) ValidateEnumValue

func (request ListBatchContextShapesRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchContextShapesResponse

type ListBatchContextShapesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchContextShapeCollection instances
	BatchContextShapeCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBatchContextShapesResponse wrapper for the ListBatchContextShapes operation

func (ListBatchContextShapesResponse) HTTPResponse

func (response ListBatchContextShapesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBatchContextShapesResponse) String

func (response ListBatchContextShapesResponse) String() string

type ListBatchContextShapesShapeTypeEnum added in v65.114.0

type ListBatchContextShapesShapeTypeEnum string

ListBatchContextShapesShapeTypeEnum Enum with underlying type: string

const (
	ListBatchContextShapesShapeTypeCpu ListBatchContextShapesShapeTypeEnum = "CPU"
	ListBatchContextShapesShapeTypeGpu ListBatchContextShapesShapeTypeEnum = "GPU"
)

Set of constants representing the allowable values for ListBatchContextShapesShapeTypeEnum

func GetListBatchContextShapesShapeTypeEnumValues added in v65.114.0

func GetListBatchContextShapesShapeTypeEnumValues() []ListBatchContextShapesShapeTypeEnum

GetListBatchContextShapesShapeTypeEnumValues Enumerates the set of values for ListBatchContextShapesShapeTypeEnum

func GetMappingListBatchContextShapesShapeTypeEnum added in v65.114.0

func GetMappingListBatchContextShapesShapeTypeEnum(val string) (ListBatchContextShapesShapeTypeEnum, bool)

GetMappingListBatchContextShapesShapeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchContextsRequest

type ListBatchContextsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState BatchContextLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListBatchContextsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListBatchContextsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBatchContextsRequest wrapper for the ListBatchContexts operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchContexts.go.html to see an example of how to use ListBatchContextsRequest.

func (ListBatchContextsRequest) BinaryRequestBody

func (request ListBatchContextsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBatchContextsRequest) HTTPRequest

func (request ListBatchContextsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBatchContextsRequest) RetryPolicy

func (request ListBatchContextsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBatchContextsRequest) String

func (request ListBatchContextsRequest) String() string

func (ListBatchContextsRequest) ValidateEnumValue

func (request ListBatchContextsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchContextsResponse

type ListBatchContextsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchContextCollection instances
	BatchContextCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBatchContextsResponse wrapper for the ListBatchContexts operation

func (ListBatchContextsResponse) HTTPResponse

func (response ListBatchContextsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBatchContextsResponse) String

func (response ListBatchContextsResponse) String() string

type ListBatchContextsSortByEnum

type ListBatchContextsSortByEnum string

ListBatchContextsSortByEnum Enum with underlying type: string

const (
	ListBatchContextsSortByTimecreated ListBatchContextsSortByEnum = "timeCreated"
	ListBatchContextsSortByDisplayname ListBatchContextsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBatchContextsSortByEnum

func GetListBatchContextsSortByEnumValues

func GetListBatchContextsSortByEnumValues() []ListBatchContextsSortByEnum

GetListBatchContextsSortByEnumValues Enumerates the set of values for ListBatchContextsSortByEnum

func GetMappingListBatchContextsSortByEnum

func GetMappingListBatchContextsSortByEnum(val string) (ListBatchContextsSortByEnum, bool)

GetMappingListBatchContextsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchContextsSortOrderEnum

type ListBatchContextsSortOrderEnum string

ListBatchContextsSortOrderEnum Enum with underlying type: string

const (
	ListBatchContextsSortOrderAsc  ListBatchContextsSortOrderEnum = "ASC"
	ListBatchContextsSortOrderDesc ListBatchContextsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBatchContextsSortOrderEnum

func GetListBatchContextsSortOrderEnumValues

func GetListBatchContextsSortOrderEnumValues() []ListBatchContextsSortOrderEnum

GetListBatchContextsSortOrderEnumValues Enumerates the set of values for ListBatchContextsSortOrderEnum

func GetMappingListBatchContextsSortOrderEnum

func GetMappingListBatchContextsSortOrderEnum(val string) (ListBatchContextsSortOrderEnum, bool)

GetMappingListBatchContextsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchJobPoolsRequest

type ListBatchJobPoolsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState BatchJobPoolLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	BatchContextId *string `mandatory:"false" contributesTo:"query" name:"batchContextId"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListBatchJobPoolsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListBatchJobPoolsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBatchJobPoolsRequest wrapper for the ListBatchJobPools operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchJobPools.go.html to see an example of how to use ListBatchJobPoolsRequest.

func (ListBatchJobPoolsRequest) BinaryRequestBody

func (request ListBatchJobPoolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBatchJobPoolsRequest) HTTPRequest

func (request ListBatchJobPoolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBatchJobPoolsRequest) RetryPolicy

func (request ListBatchJobPoolsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBatchJobPoolsRequest) String

func (request ListBatchJobPoolsRequest) String() string

func (ListBatchJobPoolsRequest) ValidateEnumValue

func (request ListBatchJobPoolsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchJobPoolsResponse

type ListBatchJobPoolsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchJobPoolCollection instances
	BatchJobPoolCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBatchJobPoolsResponse wrapper for the ListBatchJobPools operation

func (ListBatchJobPoolsResponse) HTTPResponse

func (response ListBatchJobPoolsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBatchJobPoolsResponse) String

func (response ListBatchJobPoolsResponse) String() string

type ListBatchJobPoolsSortByEnum

type ListBatchJobPoolsSortByEnum string

ListBatchJobPoolsSortByEnum Enum with underlying type: string

const (
	ListBatchJobPoolsSortByTimecreated ListBatchJobPoolsSortByEnum = "timeCreated"
	ListBatchJobPoolsSortByDisplayname ListBatchJobPoolsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBatchJobPoolsSortByEnum

func GetListBatchJobPoolsSortByEnumValues

func GetListBatchJobPoolsSortByEnumValues() []ListBatchJobPoolsSortByEnum

GetListBatchJobPoolsSortByEnumValues Enumerates the set of values for ListBatchJobPoolsSortByEnum

func GetMappingListBatchJobPoolsSortByEnum

func GetMappingListBatchJobPoolsSortByEnum(val string) (ListBatchJobPoolsSortByEnum, bool)

GetMappingListBatchJobPoolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchJobPoolsSortOrderEnum

type ListBatchJobPoolsSortOrderEnum string

ListBatchJobPoolsSortOrderEnum Enum with underlying type: string

const (
	ListBatchJobPoolsSortOrderAsc  ListBatchJobPoolsSortOrderEnum = "ASC"
	ListBatchJobPoolsSortOrderDesc ListBatchJobPoolsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBatchJobPoolsSortOrderEnum

func GetListBatchJobPoolsSortOrderEnumValues

func GetListBatchJobPoolsSortOrderEnumValues() []ListBatchJobPoolsSortOrderEnum

GetListBatchJobPoolsSortOrderEnumValues Enumerates the set of values for ListBatchJobPoolsSortOrderEnum

func GetMappingListBatchJobPoolsSortOrderEnum

func GetMappingListBatchJobPoolsSortOrderEnum(val string) (ListBatchJobPoolsSortOrderEnum, bool)

GetMappingListBatchJobPoolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchJobTasksHierarchyViewEnum added in v65.114.0

type ListBatchJobTasksHierarchyViewEnum string

ListBatchJobTasksHierarchyViewEnum Enum with underlying type: string

const (
	ListBatchJobTasksHierarchyViewShallow ListBatchJobTasksHierarchyViewEnum = "SHALLOW"
	ListBatchJobTasksHierarchyViewDeep    ListBatchJobTasksHierarchyViewEnum = "DEEP"
)

Set of constants representing the allowable values for ListBatchJobTasksHierarchyViewEnum

func GetListBatchJobTasksHierarchyViewEnumValues added in v65.114.0

func GetListBatchJobTasksHierarchyViewEnumValues() []ListBatchJobTasksHierarchyViewEnum

GetListBatchJobTasksHierarchyViewEnumValues Enumerates the set of values for ListBatchJobTasksHierarchyViewEnum

func GetMappingListBatchJobTasksHierarchyViewEnum added in v65.114.0

func GetMappingListBatchJobTasksHierarchyViewEnum(val string) (ListBatchJobTasksHierarchyViewEnum, bool)

GetMappingListBatchJobTasksHierarchyViewEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchJobTasksRequest

type ListBatchJobTasksRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"true" contributesTo:"path" name:"batchJobId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState BatchTaskLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can't pass both.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The UUID of the batch task. Mutually exclusive with the task name and group task name query parameters: you can't pass both.
	TaskId *string `mandatory:"false" contributesTo:"query" name:"taskId"`

	// Hierarchical name of the group task. A filter to return only tasks contained within the selected group task. Omit to return top-level tasks only. Can be combined with task name query parameter, in which case task name becomes a hierarchical name relative to the selected group task, e.g. ?groupTaskName=A.B&taskName=C.D is equal to ?taskName=A.B.C.D. Mutually exclusive with the task id query parameter: you can't pass both.
	GroupTaskName *string `mandatory:"false" contributesTo:"query" name:"groupTaskName"`

	// Filter tasks by type. Valid values are: COMPUTE, GROUP.
	Type BatchTaskTypeEnum `mandatory:"false" contributesTo:"query" name:"type" omitEmpty:"true"`

	// 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.
	HierarchyView ListBatchJobTasksHierarchyViewEnum `mandatory:"false" contributesTo:"query" name:"hierarchyView" omitEmpty:"true"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListBatchJobTasksSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `name` is ascending.
	SortBy ListBatchJobTasksSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBatchJobTasksRequest wrapper for the ListBatchJobTasks operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchJobTasks.go.html to see an example of how to use ListBatchJobTasksRequest.

func (ListBatchJobTasksRequest) BinaryRequestBody

func (request ListBatchJobTasksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBatchJobTasksRequest) HTTPRequest

func (request ListBatchJobTasksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBatchJobTasksRequest) RetryPolicy

func (request ListBatchJobTasksRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBatchJobTasksRequest) String

func (request ListBatchJobTasksRequest) String() string

func (ListBatchJobTasksRequest) ValidateEnumValue

func (request ListBatchJobTasksRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchJobTasksResponse

type ListBatchJobTasksResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchTaskCollection instances
	BatchTaskCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBatchJobTasksResponse wrapper for the ListBatchJobTasks operation

func (ListBatchJobTasksResponse) HTTPResponse

func (response ListBatchJobTasksResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBatchJobTasksResponse) String

func (response ListBatchJobTasksResponse) String() string

type ListBatchJobTasksSortByEnum

type ListBatchJobTasksSortByEnum string

ListBatchJobTasksSortByEnum Enum with underlying type: string

const (
	ListBatchJobTasksSortByName ListBatchJobTasksSortByEnum = "name"
)

Set of constants representing the allowable values for ListBatchJobTasksSortByEnum

func GetListBatchJobTasksSortByEnumValues

func GetListBatchJobTasksSortByEnumValues() []ListBatchJobTasksSortByEnum

GetListBatchJobTasksSortByEnumValues Enumerates the set of values for ListBatchJobTasksSortByEnum

func GetMappingListBatchJobTasksSortByEnum

func GetMappingListBatchJobTasksSortByEnum(val string) (ListBatchJobTasksSortByEnum, bool)

GetMappingListBatchJobTasksSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchJobTasksSortOrderEnum

type ListBatchJobTasksSortOrderEnum string

ListBatchJobTasksSortOrderEnum Enum with underlying type: string

const (
	ListBatchJobTasksSortOrderAsc  ListBatchJobTasksSortOrderEnum = "ASC"
	ListBatchJobTasksSortOrderDesc ListBatchJobTasksSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBatchJobTasksSortOrderEnum

func GetListBatchJobTasksSortOrderEnumValues

func GetListBatchJobTasksSortOrderEnumValues() []ListBatchJobTasksSortOrderEnum

GetListBatchJobTasksSortOrderEnumValues Enumerates the set of values for ListBatchJobTasksSortOrderEnum

func GetMappingListBatchJobTasksSortOrderEnum

func GetMappingListBatchJobTasksSortOrderEnum(val string) (ListBatchJobTasksSortOrderEnum, bool)

GetMappingListBatchJobTasksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchJobsRequest

type ListBatchJobsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState BatchJobLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	BatchJobPoolId *string `mandatory:"false" contributesTo:"query" name:"batchJobPoolId"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListBatchJobsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListBatchJobsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBatchJobsRequest wrapper for the ListBatchJobs operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchJobs.go.html to see an example of how to use ListBatchJobsRequest.

func (ListBatchJobsRequest) BinaryRequestBody

func (request ListBatchJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBatchJobsRequest) HTTPRequest

func (request ListBatchJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBatchJobsRequest) RetryPolicy

func (request ListBatchJobsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBatchJobsRequest) String

func (request ListBatchJobsRequest) String() string

func (ListBatchJobsRequest) ValidateEnumValue

func (request ListBatchJobsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchJobsResponse

type ListBatchJobsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchJobCollection instances
	BatchJobCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBatchJobsResponse wrapper for the ListBatchJobs operation

func (ListBatchJobsResponse) HTTPResponse

func (response ListBatchJobsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBatchJobsResponse) String

func (response ListBatchJobsResponse) String() string

type ListBatchJobsSortByEnum

type ListBatchJobsSortByEnum string

ListBatchJobsSortByEnum Enum with underlying type: string

const (
	ListBatchJobsSortByTimecreated ListBatchJobsSortByEnum = "timeCreated"
	ListBatchJobsSortByDisplayname ListBatchJobsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBatchJobsSortByEnum

func GetListBatchJobsSortByEnumValues

func GetListBatchJobsSortByEnumValues() []ListBatchJobsSortByEnum

GetListBatchJobsSortByEnumValues Enumerates the set of values for ListBatchJobsSortByEnum

func GetMappingListBatchJobsSortByEnum

func GetMappingListBatchJobsSortByEnum(val string) (ListBatchJobsSortByEnum, bool)

GetMappingListBatchJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchJobsSortOrderEnum

type ListBatchJobsSortOrderEnum string

ListBatchJobsSortOrderEnum Enum with underlying type: string

const (
	ListBatchJobsSortOrderAsc  ListBatchJobsSortOrderEnum = "ASC"
	ListBatchJobsSortOrderDesc ListBatchJobsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBatchJobsSortOrderEnum

func GetListBatchJobsSortOrderEnumValues

func GetListBatchJobsSortOrderEnumValues() []ListBatchJobsSortOrderEnum

GetListBatchJobsSortOrderEnumValues Enumerates the set of values for ListBatchJobsSortOrderEnum

func GetMappingListBatchJobsSortOrderEnum

func GetMappingListBatchJobsSortOrderEnum(val string) (ListBatchJobsSortOrderEnum, bool)

GetMappingListBatchJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchTaskEnvironmentsRequest

type ListBatchTaskEnvironmentsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState BatchTaskEnvironmentLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListBatchTaskEnvironmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListBatchTaskEnvironmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBatchTaskEnvironmentsRequest wrapper for the ListBatchTaskEnvironments operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchTaskEnvironments.go.html to see an example of how to use ListBatchTaskEnvironmentsRequest.

func (ListBatchTaskEnvironmentsRequest) BinaryRequestBody

func (request ListBatchTaskEnvironmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBatchTaskEnvironmentsRequest) HTTPRequest

func (request ListBatchTaskEnvironmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBatchTaskEnvironmentsRequest) RetryPolicy

func (request ListBatchTaskEnvironmentsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBatchTaskEnvironmentsRequest) String

func (request ListBatchTaskEnvironmentsRequest) String() string

func (ListBatchTaskEnvironmentsRequest) ValidateEnumValue

func (request ListBatchTaskEnvironmentsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchTaskEnvironmentsResponse

type ListBatchTaskEnvironmentsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchTaskEnvironmentCollection instances
	BatchTaskEnvironmentCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBatchTaskEnvironmentsResponse wrapper for the ListBatchTaskEnvironments operation

func (ListBatchTaskEnvironmentsResponse) HTTPResponse

func (response ListBatchTaskEnvironmentsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBatchTaskEnvironmentsResponse) String

func (response ListBatchTaskEnvironmentsResponse) String() string

type ListBatchTaskEnvironmentsSortByEnum

type ListBatchTaskEnvironmentsSortByEnum string

ListBatchTaskEnvironmentsSortByEnum Enum with underlying type: string

const (
	ListBatchTaskEnvironmentsSortByTimecreated ListBatchTaskEnvironmentsSortByEnum = "timeCreated"
	ListBatchTaskEnvironmentsSortByDisplayname ListBatchTaskEnvironmentsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBatchTaskEnvironmentsSortByEnum

func GetListBatchTaskEnvironmentsSortByEnumValues

func GetListBatchTaskEnvironmentsSortByEnumValues() []ListBatchTaskEnvironmentsSortByEnum

GetListBatchTaskEnvironmentsSortByEnumValues Enumerates the set of values for ListBatchTaskEnvironmentsSortByEnum

func GetMappingListBatchTaskEnvironmentsSortByEnum

func GetMappingListBatchTaskEnvironmentsSortByEnum(val string) (ListBatchTaskEnvironmentsSortByEnum, bool)

GetMappingListBatchTaskEnvironmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchTaskEnvironmentsSortOrderEnum

type ListBatchTaskEnvironmentsSortOrderEnum string

ListBatchTaskEnvironmentsSortOrderEnum Enum with underlying type: string

const (
	ListBatchTaskEnvironmentsSortOrderAsc  ListBatchTaskEnvironmentsSortOrderEnum = "ASC"
	ListBatchTaskEnvironmentsSortOrderDesc ListBatchTaskEnvironmentsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBatchTaskEnvironmentsSortOrderEnum

func GetListBatchTaskEnvironmentsSortOrderEnumValues

func GetListBatchTaskEnvironmentsSortOrderEnumValues() []ListBatchTaskEnvironmentsSortOrderEnum

GetListBatchTaskEnvironmentsSortOrderEnumValues Enumerates the set of values for ListBatchTaskEnvironmentsSortOrderEnum

func GetMappingListBatchTaskEnvironmentsSortOrderEnum

func GetMappingListBatchTaskEnvironmentsSortOrderEnum(val string) (ListBatchTaskEnvironmentsSortOrderEnum, bool)

GetMappingListBatchTaskEnvironmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchTaskProfilesRequest

type ListBatchTaskProfilesRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState BatchTaskProfileLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// A filter to return only resources that match the given display name exactly.
	DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile.
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListBatchTaskProfilesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `timeCreated`
	// is descending. Default order for `displayName` is ascending.
	SortBy ListBatchTaskProfilesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBatchTaskProfilesRequest wrapper for the ListBatchTaskProfiles operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchTaskProfiles.go.html to see an example of how to use ListBatchTaskProfilesRequest.

func (ListBatchTaskProfilesRequest) BinaryRequestBody

func (request ListBatchTaskProfilesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBatchTaskProfilesRequest) HTTPRequest

func (request ListBatchTaskProfilesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBatchTaskProfilesRequest) RetryPolicy

func (request ListBatchTaskProfilesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBatchTaskProfilesRequest) String

func (request ListBatchTaskProfilesRequest) String() string

func (ListBatchTaskProfilesRequest) ValidateEnumValue

func (request ListBatchTaskProfilesRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchTaskProfilesResponse

type ListBatchTaskProfilesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchTaskProfileCollection instances
	BatchTaskProfileCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBatchTaskProfilesResponse wrapper for the ListBatchTaskProfiles operation

func (ListBatchTaskProfilesResponse) HTTPResponse

func (response ListBatchTaskProfilesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBatchTaskProfilesResponse) String

func (response ListBatchTaskProfilesResponse) String() string

type ListBatchTaskProfilesSortByEnum

type ListBatchTaskProfilesSortByEnum string

ListBatchTaskProfilesSortByEnum Enum with underlying type: string

const (
	ListBatchTaskProfilesSortByTimecreated ListBatchTaskProfilesSortByEnum = "timeCreated"
	ListBatchTaskProfilesSortByDisplayname ListBatchTaskProfilesSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListBatchTaskProfilesSortByEnum

func GetListBatchTaskProfilesSortByEnumValues

func GetListBatchTaskProfilesSortByEnumValues() []ListBatchTaskProfilesSortByEnum

GetListBatchTaskProfilesSortByEnumValues Enumerates the set of values for ListBatchTaskProfilesSortByEnum

func GetMappingListBatchTaskProfilesSortByEnum

func GetMappingListBatchTaskProfilesSortByEnum(val string) (ListBatchTaskProfilesSortByEnum, bool)

GetMappingListBatchTaskProfilesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchTaskProfilesSortOrderEnum

type ListBatchTaskProfilesSortOrderEnum string

ListBatchTaskProfilesSortOrderEnum Enum with underlying type: string

const (
	ListBatchTaskProfilesSortOrderAsc  ListBatchTaskProfilesSortOrderEnum = "ASC"
	ListBatchTaskProfilesSortOrderDesc ListBatchTaskProfilesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBatchTaskProfilesSortOrderEnum

func GetListBatchTaskProfilesSortOrderEnumValues

func GetListBatchTaskProfilesSortOrderEnumValues() []ListBatchTaskProfilesSortOrderEnum

GetListBatchTaskProfilesSortOrderEnumValues Enumerates the set of values for ListBatchTaskProfilesSortOrderEnum

func GetMappingListBatchTaskProfilesSortOrderEnum

func GetMappingListBatchTaskProfilesSortOrderEnum(val string) (ListBatchTaskProfilesSortOrderEnum, bool)

GetMappingListBatchTaskProfilesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchTasksRequest

type ListBatchTasksRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"false" contributesTo:"query" name:"batchJobId"`

	// A filter to return only resources that match the given lifecycle state. The
	// state value is case-insensitive.
	LifecycleState BatchTaskLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// The hierarchical name of the batch task. Mutually exclusive with the task id query parameter: you can't pass both.
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// The UUID of the batch task. Mutually exclusive with the task name and group task name query parameters: you can't pass both.
	TaskId *string `mandatory:"false" contributesTo:"query" name:"taskId"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListBatchTasksSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. You can provide only one sort order. Default order for `name` is ascending.
	SortBy ListBatchTasksSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListBatchTasksRequest wrapper for the ListBatchTasks operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListBatchTasks.go.html to see an example of how to use ListBatchTasksRequest.

func (ListBatchTasksRequest) BinaryRequestBody

func (request ListBatchTasksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBatchTasksRequest) HTTPRequest

func (request ListBatchTasksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBatchTasksRequest) RetryPolicy

func (request ListBatchTasksRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBatchTasksRequest) String

func (request ListBatchTasksRequest) String() string

func (ListBatchTasksRequest) ValidateEnumValue

func (request ListBatchTasksRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListBatchTasksResponse

type ListBatchTasksResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of BatchTaskCollection instances
	BatchTaskCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListBatchTasksResponse wrapper for the ListBatchTasks operation

func (ListBatchTasksResponse) HTTPResponse

func (response ListBatchTasksResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBatchTasksResponse) String

func (response ListBatchTasksResponse) String() string

type ListBatchTasksSortByEnum

type ListBatchTasksSortByEnum string

ListBatchTasksSortByEnum Enum with underlying type: string

const (
	ListBatchTasksSortByName ListBatchTasksSortByEnum = "name"
)

Set of constants representing the allowable values for ListBatchTasksSortByEnum

func GetListBatchTasksSortByEnumValues

func GetListBatchTasksSortByEnumValues() []ListBatchTasksSortByEnum

GetListBatchTasksSortByEnumValues Enumerates the set of values for ListBatchTasksSortByEnum

func GetMappingListBatchTasksSortByEnum

func GetMappingListBatchTasksSortByEnum(val string) (ListBatchTasksSortByEnum, bool)

GetMappingListBatchTasksSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBatchTasksSortOrderEnum

type ListBatchTasksSortOrderEnum string

ListBatchTasksSortOrderEnum Enum with underlying type: string

const (
	ListBatchTasksSortOrderAsc  ListBatchTasksSortOrderEnum = "ASC"
	ListBatchTasksSortOrderDesc ListBatchTasksSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBatchTasksSortOrderEnum

func GetListBatchTasksSortOrderEnumValues

func GetListBatchTasksSortOrderEnumValues() []ListBatchTasksSortOrderEnum

GetListBatchTasksSortOrderEnumValues Enumerates the set of values for ListBatchTasksSortOrderEnum

func GetMappingListBatchTasksSortOrderEnum

func GetMappingListBatchTasksSortOrderEnum(val string) (ListBatchTasksSortOrderEnum, bool)

GetMappingListBatchTasksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsRequest

type ListWorkRequestErrorsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.
	SortBy ListWorkRequestErrorsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListWorkRequestErrorsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody

func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest

func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy

func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestErrorsRequest) String

func (request ListWorkRequestErrorsRequest) String() string

func (ListWorkRequestErrorsRequest) ValidateEnumValue

func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestErrorsResponse

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestErrorCollection instances
	WorkRequestErrorCollection `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse

func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String

func (response ListWorkRequestErrorsResponse) String() string

type ListWorkRequestErrorsSortByEnum

type ListWorkRequestErrorsSortByEnum string

ListWorkRequestErrorsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum

func GetListWorkRequestErrorsSortByEnumValues

func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum

GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum

func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)

GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestErrorsSortOrderEnum

type ListWorkRequestErrorsSortOrderEnum string

ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestErrorsSortOrderAsc  ListWorkRequestErrorsSortOrderEnum = "ASC"
	ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum

func GetListWorkRequestErrorsSortOrderEnumValues

func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum

GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum

func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)

GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsRequest

type ListWorkRequestLogsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.
	SortBy ListWorkRequestLogsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListWorkRequestLogsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody

func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest

func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy

func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestLogsRequest) String

func (request ListWorkRequestLogsRequest) String() string

func (ListWorkRequestLogsRequest) ValidateEnumValue

func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestLogsResponse

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestLogEntryCollection instances
	WorkRequestLogEntryCollection `presentIn:"body"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse

func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String

func (response ListWorkRequestLogsResponse) String() string

type ListWorkRequestLogsSortByEnum

type ListWorkRequestLogsSortByEnum string

ListWorkRequestLogsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum

func GetListWorkRequestLogsSortByEnumValues

func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum

GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum

func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)

GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestLogsSortOrderEnum

type ListWorkRequestLogsSortOrderEnum string

ListWorkRequestLogsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestLogsSortOrderAsc  ListWorkRequestLogsSortOrderEnum = "ASC"
	ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum

func GetListWorkRequestLogsSortOrderEnumValues

func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum

GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum

func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)

GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsRequest

type ListWorkRequestsRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
	CompartmentId *string `mandatory:"false" contributesTo:"query" name:"compartmentId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`

	// A filter to return only the resources that match the given lifecycle state.
	Status ListWorkRequestsStatusEnum `mandatory:"false" contributesTo:"query" name:"status" omitEmpty:"true"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
	ResourceId *string `mandatory:"false" contributesTo:"query" name:"resourceId"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// For list pagination. The value of the opc-next-page response header from the previous
	// "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a
	// paginated "List" call. For important details about how pagination works, see
	// List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The sort order to use, either ascending (`ASC`) or descending (`DESC`).
	SortOrder ListWorkRequestsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.
	SortBy ListWorkRequestsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody

func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest

func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy

func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListWorkRequestsRequest) String

func (request ListWorkRequestsRequest) String() string

func (ListWorkRequestsRequest) ValidateEnumValue

func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ListWorkRequestsResponse

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestSummaryCollection instances
	WorkRequestSummaryCollection `presentIn:"body"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`

	// For list pagination. When this header appears in the response, additional pages of results remain. For
	// important details about how pagination works, see List Pagination (https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse

func (response ListWorkRequestsResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String

func (response ListWorkRequestsResponse) String() string

type ListWorkRequestsSortByEnum

type ListWorkRequestsSortByEnum string

ListWorkRequestsSortByEnum Enum with underlying type: string

const (
	ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for ListWorkRequestsSortByEnum

func GetListWorkRequestsSortByEnumValues

func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum

GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum

func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)

GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsSortOrderEnum

type ListWorkRequestsSortOrderEnum string

ListWorkRequestsSortOrderEnum Enum with underlying type: string

const (
	ListWorkRequestsSortOrderAsc  ListWorkRequestsSortOrderEnum = "ASC"
	ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum

func GetListWorkRequestsSortOrderEnumValues

func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum

GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum

func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)

GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type ListWorkRequestsStatusEnum

type ListWorkRequestsStatusEnum string

ListWorkRequestsStatusEnum Enum with underlying type: string

const (
	ListWorkRequestsStatusAccepted       ListWorkRequestsStatusEnum = "ACCEPTED"
	ListWorkRequestsStatusInProgress     ListWorkRequestsStatusEnum = "IN_PROGRESS"
	ListWorkRequestsStatusWaiting        ListWorkRequestsStatusEnum = "WAITING"
	ListWorkRequestsStatusNeedsAttention ListWorkRequestsStatusEnum = "NEEDS_ATTENTION"
	ListWorkRequestsStatusFailed         ListWorkRequestsStatusEnum = "FAILED"
	ListWorkRequestsStatusSucceeded      ListWorkRequestsStatusEnum = "SUCCEEDED"
	ListWorkRequestsStatusCanceling      ListWorkRequestsStatusEnum = "CANCELING"
	ListWorkRequestsStatusCanceled       ListWorkRequestsStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for ListWorkRequestsStatusEnum

func GetListWorkRequestsStatusEnumValues

func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum

GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum

func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)

GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type LoggingConfiguration

type LoggingConfiguration interface {
}

LoggingConfiguration Logging configuration of the batch context.

type LoggingConfigurationTypeEnum

type LoggingConfigurationTypeEnum string

LoggingConfigurationTypeEnum Enum with underlying type: string

const (
	LoggingConfigurationTypeOciLogging LoggingConfigurationTypeEnum = "OCI_LOGGING"
)

Set of constants representing the allowable values for LoggingConfigurationTypeEnum

func GetLoggingConfigurationTypeEnumValues

func GetLoggingConfigurationTypeEnumValues() []LoggingConfigurationTypeEnum

GetLoggingConfigurationTypeEnumValues Enumerates the set of values for LoggingConfigurationTypeEnum

func GetMappingLoggingConfigurationTypeEnum

func GetMappingLoggingConfigurationTypeEnum(val string) (LoggingConfigurationTypeEnum, bool)

GetMappingLoggingConfigurationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

type Network

type Network struct {

	// OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated subnet.
	SubnetId *string `mandatory:"true" json:"subnetId"`

	// A list of OCIDs (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of associated network security groups.
	NsgIds []string `mandatory:"true" json:"nsgIds"`

	// A list of private endpoint's VNICs.
	Vnics []Vnic `mandatory:"true" json:"vnics"`
}

Network Network configuration of the batch context.

func (Network) String

func (m Network) String() string

func (Network) ValidateEnumValue

func (m Network) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type NetworkSecurityGroup

type NetworkSecurityGroup struct {
}

NetworkSecurityGroup VirtualNetwork service NetworkSecurityGroup

func (NetworkSecurityGroup) String

func (m NetworkSecurityGroup) String() string

func (NetworkSecurityGroup) ValidateEnumValue

func (m NetworkSecurityGroup) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type NfsVolume

type NfsVolume struct {

	// The name of the NfsVolume.
	Name *string `mandatory:"true" json:"name"`

	// The FQDN of the NFS server to connect to.
	MountTargetFqdn *string `mandatory:"true" json:"mountTargetFqdn"`

	// The path to the directory on the NFS server to be mounted.
	MountTargetExportPath *string `mandatory:"true" json:"mountTargetExportPath"`

	// The local path to mount the NFS share to.
	LocalMountDirectoryPath *string `mandatory:"true" json:"localMountDirectoryPath"`
}

NfsVolume A description of a NFS type of batch task environment volume.

func (NfsVolume) MarshalJSON

func (m NfsVolume) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (NfsVolume) String

func (m NfsVolume) String() string

func (NfsVolume) ValidateEnumValue

func (m NfsVolume) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type OciLoggingConfiguration

type OciLoggingConfiguration struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log group.
	LogGroupId *string `mandatory:"true" json:"logGroupId"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the log.
	LogId *string `mandatory:"true" json:"logId"`

	// A switch to enable or disable propagation of job and task events to the customer's logs in OCI logging service.
	IsJobTaskEventsPropagationEnabled *bool `mandatory:"false" json:"isJobTaskEventsPropagationEnabled"`
}

OciLoggingConfiguration Logging configuration for OCI Logging service.

func (OciLoggingConfiguration) MarshalJSON

func (m OciLoggingConfiguration) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OciLoggingConfiguration) String

func (m OciLoggingConfiguration) String() string

func (OciLoggingConfiguration) ValidateEnumValue

func (m OciLoggingConfiguration) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type OperationStatusEnum

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string

const (
	OperationStatusAccepted       OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress     OperationStatusEnum = "IN_PROGRESS"
	OperationStatusWaiting        OperationStatusEnum = "WAITING"
	OperationStatusNeedsAttention OperationStatusEnum = "NEEDS_ATTENTION"
	OperationStatusFailed         OperationStatusEnum = "FAILED"
	OperationStatusSucceeded      OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling      OperationStatusEnum = "CANCELING"
	OperationStatusCanceled       OperationStatusEnum = "CANCELED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetMappingOperationStatusEnum

func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)

GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationStatusEnumValues

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string

const (
	OperationTypeCreateBatchContext       OperationTypeEnum = "CREATE_BATCH_CONTEXT"
	OperationTypeUpdateBatchContext       OperationTypeEnum = "UPDATE_BATCH_CONTEXT"
	OperationTypeDeleteBatchContext       OperationTypeEnum = "DELETE_BATCH_CONTEXT"
	OperationTypeStartBatchContext        OperationTypeEnum = "START_BATCH_CONTEXT"
	OperationTypeStopBatchContext         OperationTypeEnum = "STOP_BATCH_CONTEXT"
	OperationTypeMoveBatchContext         OperationTypeEnum = "MOVE_BATCH_CONTEXT"
	OperationTypeCreateBatchJob           OperationTypeEnum = "CREATE_BATCH_JOB"
	OperationTypeUpdateBatchJob           OperationTypeEnum = "UPDATE_BATCH_JOB"
	OperationTypeDeleteBatchJob           OperationTypeEnum = "DELETE_BATCH_JOB"
	OperationTypeMoveBatchJob             OperationTypeEnum = "MOVE_BATCH_JOB"
	OperationTypePauseBatchJob            OperationTypeEnum = "PAUSE_BATCH_JOB"
	OperationTypeUnpauseBatchJob          OperationTypeEnum = "UNPAUSE_BATCH_JOB"
	OperationTypeMoveBatchJobPool         OperationTypeEnum = "MOVE_BATCH_JOB_POOL"
	OperationTypeUpdateBatchJobPool       OperationTypeEnum = "UPDATE_BATCH_JOB_POOL"
	OperationTypeStartBatchJobPool        OperationTypeEnum = "START_BATCH_JOB_POOL"
	OperationTypeStopBatchJobPool         OperationTypeEnum = "STOP_BATCH_JOB_POOL"
	OperationTypeMoveBatchTaskEnvironment OperationTypeEnum = "MOVE_BATCH_TASK_ENVIRONMENT"
	OperationTypeMoveBatchTaskProfile     OperationTypeEnum = "MOVE_BATCH_TASK_PROFILE"
	OperationTypeInternal                 OperationTypeEnum = "INTERNAL"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetMappingOperationTypeEnum

func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)

GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetOperationTypeEnumValues

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type PauseBatchJobDetails

type PauseBatchJobDetails struct {
}

PauseBatchJobDetails Information needed to pause the batch job.

func (PauseBatchJobDetails) String

func (m PauseBatchJobDetails) String() string

func (PauseBatchJobDetails) ValidateEnumValue

func (m PauseBatchJobDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PauseBatchJobRequest

type PauseBatchJobRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"true" contributesTo:"path" name:"batchJobId"`

	// Information needed to pause the batch job.
	PauseBatchJobDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

PauseBatchJobRequest wrapper for the PauseBatchJob operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/PauseBatchJob.go.html to see an example of how to use PauseBatchJobRequest.

func (PauseBatchJobRequest) BinaryRequestBody

func (request PauseBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (PauseBatchJobRequest) HTTPRequest

func (request PauseBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (PauseBatchJobRequest) RetryPolicy

func (request PauseBatchJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (PauseBatchJobRequest) String

func (request PauseBatchJobRequest) String() string

func (PauseBatchJobRequest) ValidateEnumValue

func (request PauseBatchJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type PauseBatchJobResponse

type PauseBatchJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

PauseBatchJobResponse wrapper for the PauseBatchJob operation

func (PauseBatchJobResponse) HTTPResponse

func (response PauseBatchJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (PauseBatchJobResponse) String

func (response PauseBatchJobResponse) String() string

type PrivateIp

type PrivateIp struct {
}

PrivateIp VirtualNetwork service PrivateIp

func (PrivateIp) String

func (m PrivateIp) String() string

func (PrivateIp) ValidateEnumValue

func (m PrivateIp) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type SecurityContext

type SecurityContext struct {

	// User ID for running processes inside the container.
	RunAsUser *int `mandatory:"false" json:"runAsUser"`

	// Group ID for running processes inside the container.
	RunAsGroup *int `mandatory:"false" json:"runAsGroup"`

	// A special supplemental group ID that applies to all containers in a pod.
	FsGroup *int `mandatory:"false" json:"fsGroup"`
}

SecurityContext Security context for container runtime configuration. See also docs (https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/datatypes/LinuxSecurityContext).

func (SecurityContext) String

func (m SecurityContext) String() string

func (SecurityContext) ValidateEnumValue

func (m SecurityContext) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ServiceManagedFleet

type ServiceManagedFleet struct {

	// Name of the service managed fleet.
	Name *string `mandatory:"true" json:"name"`

	Shape *FleetShape `mandatory:"true" json:"shape"`

	// Maximum number of concurrent tasks for the service managed fleet.
	MaxConcurrentTasks *int `mandatory:"true" json:"maxConcurrentTasks"`

	// Current state of the service manage fleet configuration.
	State *string `mandatory:"false" json:"state"`

	// A message that describes the current state of the service managed fleet configuration in more detail.
	Details *string `mandatory:"false" json:"details"`
}

ServiceManagedFleet Service managed Fleet configuration of the batch context.

func (ServiceManagedFleet) MarshalJSON

func (m ServiceManagedFleet) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ServiceManagedFleet) String

func (m ServiceManagedFleet) String() string

func (ServiceManagedFleet) ValidateEnumValue

func (m ServiceManagedFleet) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ServiceManagedGpuFleet added in v65.114.0

type ServiceManagedGpuFleet struct {

	// Name of the service managed GPU fleet.
	Name *string `mandatory:"true" json:"name"`

	Shape GpuFleetShape `mandatory:"true" json:"shape"`

	// Maximum number of concurrent tasks for the service managed GPU fleet.
	MaxConcurrentTasks *int `mandatory:"true" json:"maxConcurrentTasks"`

	// Current state of the service managed GPU fleet configuration.
	State *string `mandatory:"false" json:"state"`

	// A message that describes the current state of the service managed GPU fleet configuration in more detail.
	Details *string `mandatory:"false" json:"details"`
}

ServiceManagedGpuFleet Service managed GPU Fleet configuration of the batch context.

func (ServiceManagedGpuFleet) MarshalJSON added in v65.114.0

func (m ServiceManagedGpuFleet) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (ServiceManagedGpuFleet) String added in v65.114.0

func (m ServiceManagedGpuFleet) String() string

func (*ServiceManagedGpuFleet) UnmarshalJSON added in v65.114.0

func (m *ServiceManagedGpuFleet) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (ServiceManagedGpuFleet) ValidateEnumValue added in v65.114.0

func (m ServiceManagedGpuFleet) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ShapeMemoryOptions

type ShapeMemoryOptions struct {

	// The default amount of memory per OCPU available for this shape (GB).
	DefaultPerOcpuInGBs *float32 `mandatory:"true" json:"defaultPerOcpuInGBs"`

	// The maximum amount of memory (GB).
	MaxInGBs *float32 `mandatory:"true" json:"maxInGBs"`

	// For a flexible shape, the maximum amount of memory per OCPU available for this shape (GB).
	MaxPerOcpuInGBs *float32 `mandatory:"true" json:"maxPerOcpuInGBs"`

	// The minimum amount of memory (GB).
	MinInGBs *float32 `mandatory:"true" json:"minInGBs"`

	// The minimum amount of memory per OCPU available for this shape (GB).
	MinPerOcpuInGBs *float32 `mandatory:"true" json:"minPerOcpuInGBs"`
}

ShapeMemoryOptions The amount of memory available for container instances that use this shape.

func (ShapeMemoryOptions) String

func (m ShapeMemoryOptions) String() string

func (ShapeMemoryOptions) ValidateEnumValue

func (m ShapeMemoryOptions) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ShapeNetworkingBandwidthOptions

type ShapeNetworkingBandwidthOptions struct {

	// The default amount of networking bandwidth per OCPU, in gigabits per second.
	DefaultPerOcpuInGbps *float32 `mandatory:"true" json:"defaultPerOcpuInGbps"`

	// The maximum amount of networking bandwidth, in gigabits per second.
	MaxInGbps *float32 `mandatory:"true" json:"maxInGbps"`

	// The minimum amount of networking bandwidth, in gigabits per second.
	MinInGbps *float32 `mandatory:"true" json:"minInGbps"`
}

ShapeNetworkingBandwidthOptions For a flexible shape, the amount of networking bandwidth available for container instances that use this shape.

func (ShapeNetworkingBandwidthOptions) String

func (ShapeNetworkingBandwidthOptions) ValidateEnumValue

func (m ShapeNetworkingBandwidthOptions) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ShapeOcpuOptions

type ShapeOcpuOptions struct {

	// The maximum number of OCPUs.
	MaxOcpus *float32 `mandatory:"true" json:"maxOcpus"`

	// The minimum number of OCPUs.
	MinOcpus *float32 `mandatory:"true" json:"minOcpus"`
}

ShapeOcpuOptions For a flexible shape, the number of OCPUs available for container instances that use this shape.

func (ShapeOcpuOptions) String

func (m ShapeOcpuOptions) String() string

func (ShapeOcpuOptions) ValidateEnumValue

func (m ShapeOcpuOptions) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type ShapeTypeEnum added in v65.114.0

type ShapeTypeEnum string

ShapeTypeEnum Enum with underlying type: string

const (
	ShapeTypeCpu ShapeTypeEnum = "CPU"
	ShapeTypeGpu ShapeTypeEnum = "GPU"
)

Set of constants representing the allowable values for ShapeTypeEnum

func GetMappingShapeTypeEnum added in v65.114.0

func GetMappingShapeTypeEnum(val string) (ShapeTypeEnum, bool)

GetMappingShapeTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetShapeTypeEnumValues added in v65.114.0

func GetShapeTypeEnumValues() []ShapeTypeEnum

GetShapeTypeEnumValues Enumerates the set of values for ShapeTypeEnum

type SortByEnum

type SortByEnum string

SortByEnum Enum with underlying type: string

const (
	SortByTimeCreated SortByEnum = "timeCreated"
	SortByDisplayName SortByEnum = "displayName"
)

Set of constants representing the allowable values for SortByEnum

func GetMappingSortByEnum

func GetMappingSortByEnum(val string) (SortByEnum, bool)

GetMappingSortByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortByEnumValues

func GetSortByEnumValues() []SortByEnum

GetSortByEnumValues Enumerates the set of values for SortByEnum

type SortOrderEnum

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetMappingSortOrderEnum

func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)

GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

func GetSortOrderEnumValues

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type StartBatchContextDetails

type StartBatchContextDetails struct {
}

StartBatchContextDetails Information needed to start the batch context.

func (StartBatchContextDetails) String

func (m StartBatchContextDetails) String() string

func (StartBatchContextDetails) ValidateEnumValue

func (m StartBatchContextDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StartBatchContextRequest

type StartBatchContextRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	BatchContextId *string `mandatory:"true" contributesTo:"path" name:"batchContextId"`

	// Information needed to start the batch context.
	StartBatchContextDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

StartBatchContextRequest wrapper for the StartBatchContext operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/StartBatchContext.go.html to see an example of how to use StartBatchContextRequest.

func (StartBatchContextRequest) BinaryRequestBody

func (request StartBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StartBatchContextRequest) HTTPRequest

func (request StartBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartBatchContextRequest) RetryPolicy

func (request StartBatchContextRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StartBatchContextRequest) String

func (request StartBatchContextRequest) String() string

func (StartBatchContextRequest) ValidateEnumValue

func (request StartBatchContextRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StartBatchContextResponse

type StartBatchContextResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

StartBatchContextResponse wrapper for the StartBatchContext operation

func (StartBatchContextResponse) HTTPResponse

func (response StartBatchContextResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StartBatchContextResponse) String

func (response StartBatchContextResponse) String() string

type StartBatchJobPoolDetails

type StartBatchJobPoolDetails struct {
}

StartBatchJobPoolDetails Information needed to start the batch job pool.

func (StartBatchJobPoolDetails) String

func (m StartBatchJobPoolDetails) String() string

func (StartBatchJobPoolDetails) ValidateEnumValue

func (m StartBatchJobPoolDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StartBatchJobPoolRequest

type StartBatchJobPoolRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	BatchJobPoolId *string `mandatory:"true" contributesTo:"path" name:"batchJobPoolId"`

	// Information needed to start the batch job pool.
	StartBatchJobPoolDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

StartBatchJobPoolRequest wrapper for the StartBatchJobPool operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/StartBatchJobPool.go.html to see an example of how to use StartBatchJobPoolRequest.

func (StartBatchJobPoolRequest) BinaryRequestBody

func (request StartBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StartBatchJobPoolRequest) HTTPRequest

func (request StartBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StartBatchJobPoolRequest) RetryPolicy

func (request StartBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StartBatchJobPoolRequest) String

func (request StartBatchJobPoolRequest) String() string

func (StartBatchJobPoolRequest) ValidateEnumValue

func (request StartBatchJobPoolRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StartBatchJobPoolResponse

type StartBatchJobPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

StartBatchJobPoolResponse wrapper for the StartBatchJobPool operation

func (StartBatchJobPoolResponse) HTTPResponse

func (response StartBatchJobPoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StartBatchJobPoolResponse) String

func (response StartBatchJobPoolResponse) String() string

type StopBatchContextDetails

type StopBatchContextDetails struct {
}

StopBatchContextDetails Information needed to stop the batch context.

func (StopBatchContextDetails) String

func (m StopBatchContextDetails) String() string

func (StopBatchContextDetails) ValidateEnumValue

func (m StopBatchContextDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StopBatchContextRequest

type StopBatchContextRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	BatchContextId *string `mandatory:"true" contributesTo:"path" name:"batchContextId"`

	// Information needed to stop the batch context.
	StopBatchContextDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

StopBatchContextRequest wrapper for the StopBatchContext operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/StopBatchContext.go.html to see an example of how to use StopBatchContextRequest.

func (StopBatchContextRequest) BinaryRequestBody

func (request StopBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StopBatchContextRequest) HTTPRequest

func (request StopBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopBatchContextRequest) RetryPolicy

func (request StopBatchContextRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StopBatchContextRequest) String

func (request StopBatchContextRequest) String() string

func (StopBatchContextRequest) ValidateEnumValue

func (request StopBatchContextRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StopBatchContextResponse

type StopBatchContextResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

StopBatchContextResponse wrapper for the StopBatchContext operation

func (StopBatchContextResponse) HTTPResponse

func (response StopBatchContextResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StopBatchContextResponse) String

func (response StopBatchContextResponse) String() string

type StopBatchJobPoolDetails

type StopBatchJobPoolDetails struct {
}

StopBatchJobPoolDetails Information needed to stop the batch job pool.

func (StopBatchJobPoolDetails) String

func (m StopBatchJobPoolDetails) String() string

func (StopBatchJobPoolDetails) ValidateEnumValue

func (m StopBatchJobPoolDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StopBatchJobPoolRequest

type StopBatchJobPoolRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	BatchJobPoolId *string `mandatory:"true" contributesTo:"path" name:"batchJobPoolId"`

	// Information needed to stop the batch job pool.
	StopBatchJobPoolDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

StopBatchJobPoolRequest wrapper for the StopBatchJobPool operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/StopBatchJobPool.go.html to see an example of how to use StopBatchJobPoolRequest.

func (StopBatchJobPoolRequest) BinaryRequestBody

func (request StopBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (StopBatchJobPoolRequest) HTTPRequest

func (request StopBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (StopBatchJobPoolRequest) RetryPolicy

func (request StopBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (StopBatchJobPoolRequest) String

func (request StopBatchJobPoolRequest) String() string

func (StopBatchJobPoolRequest) ValidateEnumValue

func (request StopBatchJobPoolRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type StopBatchJobPoolResponse

type StopBatchJobPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

StopBatchJobPoolResponse wrapper for the StopBatchJobPool operation

func (StopBatchJobPoolResponse) HTTPResponse

func (response StopBatchJobPoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (StopBatchJobPoolResponse) String

func (response StopBatchJobPoolResponse) String() string

type Subnet

type Subnet struct {
}

Subnet VirtualNetwork service Subnet

func (Subnet) String

func (m Subnet) String() string

func (Subnet) ValidateEnumValue

func (m Subnet) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UnpauseBatchJobDetails

type UnpauseBatchJobDetails struct {
}

UnpauseBatchJobDetails Information needed to unpause the batch job.

func (UnpauseBatchJobDetails) String

func (m UnpauseBatchJobDetails) String() string

func (UnpauseBatchJobDetails) ValidateEnumValue

func (m UnpauseBatchJobDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UnpauseBatchJobRequest

type UnpauseBatchJobRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"true" contributesTo:"path" name:"batchJobId"`

	// Information needed to unpause the batch job.
	UnpauseBatchJobDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UnpauseBatchJobRequest wrapper for the UnpauseBatchJob operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UnpauseBatchJob.go.html to see an example of how to use UnpauseBatchJobRequest.

func (UnpauseBatchJobRequest) BinaryRequestBody

func (request UnpauseBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UnpauseBatchJobRequest) HTTPRequest

func (request UnpauseBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UnpauseBatchJobRequest) RetryPolicy

func (request UnpauseBatchJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UnpauseBatchJobRequest) String

func (request UnpauseBatchJobRequest) String() string

func (UnpauseBatchJobRequest) ValidateEnumValue

func (request UnpauseBatchJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UnpauseBatchJobResponse

type UnpauseBatchJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UnpauseBatchJobResponse wrapper for the UnpauseBatchJob operation

func (UnpauseBatchJobResponse) HTTPResponse

func (response UnpauseBatchJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UnpauseBatchJobResponse) String

func (response UnpauseBatchJobResponse) String() string

type UpdateBatchContextDetails

type UpdateBatchContextDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Can't be set to null.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Summarized information about the batch context.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// List of job priority configurations related to the batch context.
	JobPriorityConfigurations []JobPriorityConfiguration `mandatory:"false" json:"jobPriorityConfigurations"`

	// Mapping of concurrent/shared resources used in job tasks to their limits.
	Entitlements map[string]int `mandatory:"false" json:"entitlements"`

	LoggingConfiguration UpdateLoggingConfigurationDetails `mandatory:"false" json:"loggingConfiguration"`
}

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.

func (UpdateBatchContextDetails) String

func (m UpdateBatchContextDetails) String() string

func (*UpdateBatchContextDetails) UnmarshalJSON added in v65.114.0

func (m *UpdateBatchContextDetails) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (UpdateBatchContextDetails) ValidateEnumValue

func (m UpdateBatchContextDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchContextRequest

type UpdateBatchContextRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch context.
	BatchContextId *string `mandatory:"true" contributesTo:"path" name:"batchContextId"`

	// The information to be updated.
	UpdateBatchContextDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateBatchContextRequest wrapper for the UpdateBatchContext operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchContext.go.html to see an example of how to use UpdateBatchContextRequest.

func (UpdateBatchContextRequest) BinaryRequestBody

func (request UpdateBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateBatchContextRequest) HTTPRequest

func (request UpdateBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBatchContextRequest) RetryPolicy

func (request UpdateBatchContextRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBatchContextRequest) String

func (request UpdateBatchContextRequest) String() string

func (UpdateBatchContextRequest) ValidateEnumValue

func (request UpdateBatchContextRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchContextResponse

type UpdateBatchContextResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateBatchContextResponse wrapper for the UpdateBatchContext operation

func (UpdateBatchContextResponse) HTTPResponse

func (response UpdateBatchContextResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBatchContextResponse) String

func (response UpdateBatchContextResponse) String() string

type UpdateBatchJobDetails

type UpdateBatchJobDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Can't be set to null.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// An optional description that provides additional context next to the displayName.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (UpdateBatchJobDetails) String

func (m UpdateBatchJobDetails) String() string

func (UpdateBatchJobDetails) ValidateEnumValue

func (m UpdateBatchJobDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchJobPoolDetails

type UpdateBatchJobPoolDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Can't be set to null.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// Summarized information about the batch job pool.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (UpdateBatchJobPoolDetails) String

func (m UpdateBatchJobPoolDetails) String() string

func (UpdateBatchJobPoolDetails) ValidateEnumValue

func (m UpdateBatchJobPoolDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchJobPoolRequest

type UpdateBatchJobPoolRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job pool.
	BatchJobPoolId *string `mandatory:"true" contributesTo:"path" name:"batchJobPoolId"`

	// The information to be updated.
	UpdateBatchJobPoolDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateBatchJobPoolRequest wrapper for the UpdateBatchJobPool operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchJobPool.go.html to see an example of how to use UpdateBatchJobPoolRequest.

func (UpdateBatchJobPoolRequest) BinaryRequestBody

func (request UpdateBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateBatchJobPoolRequest) HTTPRequest

func (request UpdateBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBatchJobPoolRequest) RetryPolicy

func (request UpdateBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBatchJobPoolRequest) String

func (request UpdateBatchJobPoolRequest) String() string

func (UpdateBatchJobPoolRequest) ValidateEnumValue

func (request UpdateBatchJobPoolRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchJobPoolResponse

type UpdateBatchJobPoolResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateBatchJobPoolResponse wrapper for the UpdateBatchJobPool operation

func (UpdateBatchJobPoolResponse) HTTPResponse

func (response UpdateBatchJobPoolResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBatchJobPoolResponse) String

func (response UpdateBatchJobPoolResponse) String() string

type UpdateBatchJobRequest

type UpdateBatchJobRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch job.
	BatchJobId *string `mandatory:"true" contributesTo:"path" name:"batchJobId"`

	// The information to be updated.
	UpdateBatchJobDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateBatchJobRequest wrapper for the UpdateBatchJob operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchJob.go.html to see an example of how to use UpdateBatchJobRequest.

func (UpdateBatchJobRequest) BinaryRequestBody

func (request UpdateBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateBatchJobRequest) HTTPRequest

func (request UpdateBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBatchJobRequest) RetryPolicy

func (request UpdateBatchJobRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBatchJobRequest) String

func (request UpdateBatchJobRequest) String() string

func (UpdateBatchJobRequest) ValidateEnumValue

func (request UpdateBatchJobRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchJobResponse

type UpdateBatchJobResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
	// Use GetWorkRequest with this ID to track the status of the request.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateBatchJobResponse wrapper for the UpdateBatchJob operation

func (UpdateBatchJobResponse) HTTPResponse

func (response UpdateBatchJobResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBatchJobResponse) String

func (response UpdateBatchJobResponse) String() string

type UpdateBatchTaskEnvironmentDetails

type UpdateBatchTaskEnvironmentDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Can't be set to null.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The batch task environment description.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (UpdateBatchTaskEnvironmentDetails) String

func (UpdateBatchTaskEnvironmentDetails) ValidateEnumValue

func (m UpdateBatchTaskEnvironmentDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchTaskEnvironmentRequest

type UpdateBatchTaskEnvironmentRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task environment.
	BatchTaskEnvironmentId *string `mandatory:"true" contributesTo:"path" name:"batchTaskEnvironmentId"`

	// The information to be updated.
	UpdateBatchTaskEnvironmentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateBatchTaskEnvironmentRequest wrapper for the UpdateBatchTaskEnvironment operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchTaskEnvironment.go.html to see an example of how to use UpdateBatchTaskEnvironmentRequest.

func (UpdateBatchTaskEnvironmentRequest) BinaryRequestBody

func (request UpdateBatchTaskEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateBatchTaskEnvironmentRequest) HTTPRequest

func (request UpdateBatchTaskEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBatchTaskEnvironmentRequest) RetryPolicy

func (request UpdateBatchTaskEnvironmentRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBatchTaskEnvironmentRequest) String

func (request UpdateBatchTaskEnvironmentRequest) String() string

func (UpdateBatchTaskEnvironmentRequest) ValidateEnumValue

func (request UpdateBatchTaskEnvironmentRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchTaskEnvironmentResponse

type UpdateBatchTaskEnvironmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchTaskEnvironment instance
	BatchTaskEnvironment `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateBatchTaskEnvironmentResponse wrapper for the UpdateBatchTaskEnvironment operation

func (UpdateBatchTaskEnvironmentResponse) HTTPResponse

func (response UpdateBatchTaskEnvironmentResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBatchTaskEnvironmentResponse) String

func (response UpdateBatchTaskEnvironmentResponse) String() string

type UpdateBatchTaskProfileDetails

type UpdateBatchTaskProfileDetails struct {

	// A user-friendly name. Does not have to be unique, and it's changeable.
	// Can't be set to null.
	DisplayName *string `mandatory:"false" json:"displayName"`

	// The batch task profile description.
	Description *string `mandatory:"false" json:"description"`

	// Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Department": "Finance"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
	// Example: `{"Operations": {"CostCenter": "42"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (UpdateBatchTaskProfileDetails) String

func (UpdateBatchTaskProfileDetails) ValidateEnumValue

func (m UpdateBatchTaskProfileDetails) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchTaskProfileRequest

type UpdateBatchTaskProfileRequest struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the batch task profile.
	BatchTaskProfileId *string `mandatory:"true" contributesTo:"path" name:"batchTaskProfileId"`

	// The information to be updated.
	UpdateBatchTaskProfileDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call for a resource, set the
	// `if-match` parameter to the value of the etag from a previous GET or POST response for
	// that resource. The resource will be updated or deleted only if the etag you provide
	// matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	// The only valid characters for request IDs are letters, numbers,
	// underscore, and dash.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

	// Metadata about the request. This information will not be transmitted to the service, but
	// represents information that the SDK will consume to drive retry behavior.
	RequestMetadata common.RequestMetadata
}

UpdateBatchTaskProfileRequest wrapper for the UpdateBatchTaskProfile operation

See also

Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/batch/UpdateBatchTaskProfile.go.html to see an example of how to use UpdateBatchTaskProfileRequest.

func (UpdateBatchTaskProfileRequest) BinaryRequestBody

func (request UpdateBatchTaskProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (UpdateBatchTaskProfileRequest) HTTPRequest

func (request UpdateBatchTaskProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (UpdateBatchTaskProfileRequest) RetryPolicy

func (request UpdateBatchTaskProfileRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (UpdateBatchTaskProfileRequest) String

func (request UpdateBatchTaskProfileRequest) String() string

func (UpdateBatchTaskProfileRequest) ValidateEnumValue

func (request UpdateBatchTaskProfileRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type UpdateBatchTaskProfileResponse

type UpdateBatchTaskProfileResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The BatchTaskProfile instance
	BatchTaskProfile `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

	// Unique Oracle-assigned identifier for the request. If you need to contact
	// Oracle about a particular request, please provide the request ID.
	OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}

UpdateBatchTaskProfileResponse wrapper for the UpdateBatchTaskProfile operation

func (UpdateBatchTaskProfileResponse) HTTPResponse

func (response UpdateBatchTaskProfileResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (UpdateBatchTaskProfileResponse) String

func (response UpdateBatchTaskProfileResponse) String() string

type UpdateLoggingConfigurationDetails added in v65.114.0

type UpdateLoggingConfigurationDetails interface {
}

UpdateLoggingConfigurationDetails The data to update logging configuration of the batch context.

type UpdateLoggingConfigurationDetailsTypeEnum added in v65.114.0

type UpdateLoggingConfigurationDetailsTypeEnum string

UpdateLoggingConfigurationDetailsTypeEnum Enum with underlying type: string

const (
	UpdateLoggingConfigurationDetailsTypeOciLogging UpdateLoggingConfigurationDetailsTypeEnum = "OCI_LOGGING"
)

Set of constants representing the allowable values for UpdateLoggingConfigurationDetailsTypeEnum

func GetMappingUpdateLoggingConfigurationDetailsTypeEnum added in v65.114.0

func GetMappingUpdateLoggingConfigurationDetailsTypeEnum(val string) (UpdateLoggingConfigurationDetailsTypeEnum, bool)

GetMappingUpdateLoggingConfigurationDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum

func GetUpdateLoggingConfigurationDetailsTypeEnumValues added in v65.114.0

func GetUpdateLoggingConfigurationDetailsTypeEnumValues() []UpdateLoggingConfigurationDetailsTypeEnum

GetUpdateLoggingConfigurationDetailsTypeEnumValues Enumerates the set of values for UpdateLoggingConfigurationDetailsTypeEnum

type UpdateOciLoggingConfiguration added in v65.114.0

type UpdateOciLoggingConfiguration struct {

	// A switch to enable or disable propagation of job and task events to the customer's logs in OCI logging service.
	IsJobTaskEventsPropagationEnabled *bool `mandatory:"true" json:"isJobTaskEventsPropagationEnabled"`
}

UpdateOciLoggingConfiguration The data to update logging configuration for OCI Logging service.

func (UpdateOciLoggingConfiguration) MarshalJSON added in v65.114.0

func (m UpdateOciLoggingConfiguration) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (UpdateOciLoggingConfiguration) String added in v65.114.0

func (UpdateOciLoggingConfiguration) ValidateEnumValue added in v65.114.0

func (m UpdateOciLoggingConfiguration) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type VirtualNetworkVnic

type VirtualNetworkVnic struct {
}

VirtualNetworkVnic VirtualNetwork service Vnic

func (VirtualNetworkVnic) String

func (m VirtualNetworkVnic) String() string

func (VirtualNetworkVnic) ValidateEnumValue

func (m VirtualNetworkVnic) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type Vnic

type Vnic struct {

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint's VNIC,
	// which resides in the customer's VCN.
	Id *string `mandatory:"true" json:"id"`

	// A list of private IP addresses (in the customer's VCN) that represent access points for the service.
	SourceIps []string `mandatory:"true" json:"sourceIps"`
}

Vnic Private endpoint's VNIC.

func (Vnic) String

func (m Vnic) String() string

func (Vnic) ValidateEnumValue

func (m Vnic) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequest

type WorkRequest struct {

	// The asynchronous operation tracked by this work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status OperationStatusEnum `mandatory:"true" json:"status"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources that are affected by the work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// Shows the progress of the operation tracked by the work request, as a percentage of the total work
	// that must be performed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the work request was created, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the work request was started, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the work request was finished, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// The date and time the work request was updated, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

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.

func (WorkRequest) String

func (m WorkRequest) String() string

func (WorkRequest) ValidateEnumValue

func (m WorkRequest) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestError

type WorkRequestError struct {

	// A machine-usable code for the error that occurred. For a list of error codes, see
	// API Errors (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm).
	Code *string `mandatory:"true" json:"code"`

	// A human-readable error message.
	Message *string `mandatory:"true" json:"message"`

	// The date and time the error occurred, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestError An error encountered while performing an operation that is tracked by a work request.

func (WorkRequestError) String

func (m WorkRequestError) String() string

func (WorkRequestError) ValidateEnumValue

func (m WorkRequestError) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestErrorCollection

type WorkRequestErrorCollection struct {

	// A list of work request errors.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.

func (WorkRequestErrorCollection) String

func (WorkRequestErrorCollection) ValidateEnumValue

func (m WorkRequestErrorCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLogAndErrorSortByEnum

type WorkRequestLogAndErrorSortByEnum string

WorkRequestLogAndErrorSortByEnum Enum with underlying type: string

const (
	WorkRequestLogAndErrorSortByTimeCreated WorkRequestLogAndErrorSortByEnum = "timeCreated"
)

Set of constants representing the allowable values for WorkRequestLogAndErrorSortByEnum

func GetMappingWorkRequestLogAndErrorSortByEnum

func GetMappingWorkRequestLogAndErrorSortByEnum(val string) (WorkRequestLogAndErrorSortByEnum, bool)

GetMappingWorkRequestLogAndErrorSortByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestLogAndErrorSortByEnumValues

func GetWorkRequestLogAndErrorSortByEnumValues() []WorkRequestLogAndErrorSortByEnum

GetWorkRequestLogAndErrorSortByEnumValues Enumerates the set of values for WorkRequestLogAndErrorSortByEnum

type WorkRequestLogEntry

type WorkRequestLogEntry struct {

	// A human-readable log message.
	Message *string `mandatory:"true" json:"message"`

	// The date and time the log message was written, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}

WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.

func (WorkRequestLogEntry) String

func (m WorkRequestLogEntry) String() string

func (WorkRequestLogEntry) ValidateEnumValue

func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestLogEntryCollection

type WorkRequestLogEntryCollection struct {

	// A list of work request log entries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.

func (WorkRequestLogEntryCollection) String

func (WorkRequestLogEntryCollection) ValidateEnumValue

func (m WorkRequestLogEntryCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResource

type WorkRequestResource struct {

	// The resource type that the work request affects.
	EntityType *string `mandatory:"true" json:"entityType"`

	// The way in which this resource is affected by the operation tracked in the work request.
	// A resource being created, updated, or deleted remains in the IN_PROGRESS state until
	// work is complete for that resource, at which point it transitions to CREATED, UPDATED,
	// or DELETED, respectively.
	ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`

	// An OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
	Identifier *string `mandatory:"true" json:"identifier"`

	// The URI path that you can use for a GET request to access the resource metadata.
	EntityUri *string `mandatory:"false" json:"entityUri"`

	// Additional information that helps to explain the resource.
	Metadata map[string]string `mandatory:"false" json:"metadata"`
}

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String

func (m WorkRequestResource) String() string

func (WorkRequestResource) ValidateEnumValue

func (m WorkRequestResource) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestResourceMetadataKeyEnum

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string

const (
	WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum

func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)

GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestResourceMetadataKeyEnumValues

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSortByEnum

type WorkRequestSortByEnum string

WorkRequestSortByEnum Enum with underlying type: string

const (
	WorkRequestSortByTimeAccepted WorkRequestSortByEnum = "timeAccepted"
)

Set of constants representing the allowable values for WorkRequestSortByEnum

func GetMappingWorkRequestSortByEnum

func GetMappingWorkRequestSortByEnum(val string) (WorkRequestSortByEnum, bool)

GetMappingWorkRequestSortByEnum performs case Insensitive comparison on enum value and return the desired enum

func GetWorkRequestSortByEnumValues

func GetWorkRequestSortByEnumValues() []WorkRequestSortByEnum

GetWorkRequestSortByEnumValues Enumerates the set of values for WorkRequestSortByEnum

type WorkRequestSummary

type WorkRequestSummary struct {

	// The asynchronous operation tracked by this work request.
	OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`

	// The status of the work request.
	Status OperationStatusEnum `mandatory:"true" json:"status"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.
	Id *string `mandatory:"true" json:"id"`

	// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The resources that are affected by this work request.
	Resources []WorkRequestResource `mandatory:"true" json:"resources"`

	// Shows the progress of the operation tracked by the work request, as a percentage of the total work
	// that must be performed.
	PercentComplete *float32 `mandatory:"true" json:"percentComplete"`

	// The date and time the work request was created, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`

	// The date and time the work request was started, in the format defined by
	// RFC 3339 (https://tools.ietf.org/html/rfc3339).
	TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`

	// The date and time the work request was finished, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`

	// The date and time the work request was updated, in the format defined by
	// RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
	TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
}

WorkRequestSummary Summary information about an asynchronous work request.

func (WorkRequestSummary) String

func (m WorkRequestSummary) String() string

func (WorkRequestSummary) ValidateEnumValue

func (m WorkRequestSummary) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

type WorkRequestSummaryCollection

type WorkRequestSummaryCollection struct {

	// A list of work requests.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.

func (WorkRequestSummaryCollection) String

func (WorkRequestSummaryCollection) ValidateEnumValue

func (m WorkRequestSummaryCollection) ValidateEnumValue() (bool, error)

ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL