func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetBatchContextLifecycleStateEnumStringValues() []string
GetBatchContextLifecycleStateEnumStringValues Enumerates the set of values in String for BatchContextLifecycleStateEnum
func GetBatchJobLifecycleStateEnumStringValues() []string
GetBatchJobLifecycleStateEnumStringValues Enumerates the set of values in String for BatchJobLifecycleStateEnum
func GetBatchJobPoolLifecycleStateEnumStringValues() []string
GetBatchJobPoolLifecycleStateEnumStringValues Enumerates the set of values in String for BatchJobPoolLifecycleStateEnum
func GetBatchTaskEnvironmentLifecycleStateEnumStringValues() []string
GetBatchTaskEnvironmentLifecycleStateEnumStringValues Enumerates the set of values in String for BatchTaskEnvironmentLifecycleStateEnum
func GetBatchTaskEnvironmentVolumeTypeEnumStringValues() []string
GetBatchTaskEnvironmentVolumeTypeEnumStringValues Enumerates the set of values in String for BatchTaskEnvironmentVolumeTypeEnum
func GetBatchTaskLifecycleStateEnumStringValues() []string
GetBatchTaskLifecycleStateEnumStringValues Enumerates the set of values in String for BatchTaskLifecycleStateEnum
func GetBatchTaskProfileLifecycleStateEnumStringValues() []string
GetBatchTaskProfileLifecycleStateEnumStringValues Enumerates the set of values in String for BatchTaskProfileLifecycleStateEnum
func GetBatchTaskSortByEnumStringValues() []string
GetBatchTaskSortByEnumStringValues Enumerates the set of values in String for BatchTaskSortByEnum
func GetBatchTaskTypeEnumStringValues() []string
GetBatchTaskTypeEnumStringValues Enumerates the set of values in String for BatchTaskTypeEnum
func GetCreateBatchTaskDetailsTypeEnumStringValues() []string
GetCreateBatchTaskDetailsTypeEnumStringValues Enumerates the set of values in String for CreateBatchTaskDetailsTypeEnum
func GetCreateFleetDetailsTypeEnumStringValues() []string
GetCreateFleetDetailsTypeEnumStringValues Enumerates the set of values in String for CreateFleetDetailsTypeEnum
func GetFleetAssignmentPolicyTypeEnumStringValues() []string
GetFleetAssignmentPolicyTypeEnumStringValues Enumerates the set of values in String for FleetAssignmentPolicyTypeEnum
func GetFleetTypeEnumStringValues() []string
GetFleetTypeEnumStringValues Enumerates the set of values in String for FleetTypeEnum
func GetListBatchContextsSortByEnumStringValues() []string
GetListBatchContextsSortByEnumStringValues Enumerates the set of values in String for ListBatchContextsSortByEnum
func GetListBatchContextsSortOrderEnumStringValues() []string
GetListBatchContextsSortOrderEnumStringValues Enumerates the set of values in String for ListBatchContextsSortOrderEnum
func GetListBatchJobPoolsSortByEnumStringValues() []string
GetListBatchJobPoolsSortByEnumStringValues Enumerates the set of values in String for ListBatchJobPoolsSortByEnum
func GetListBatchJobPoolsSortOrderEnumStringValues() []string
GetListBatchJobPoolsSortOrderEnumStringValues Enumerates the set of values in String for ListBatchJobPoolsSortOrderEnum
func GetListBatchJobTasksSortByEnumStringValues() []string
GetListBatchJobTasksSortByEnumStringValues Enumerates the set of values in String for ListBatchJobTasksSortByEnum
func GetListBatchJobTasksSortOrderEnumStringValues() []string
GetListBatchJobTasksSortOrderEnumStringValues Enumerates the set of values in String for ListBatchJobTasksSortOrderEnum
func GetListBatchJobsSortByEnumStringValues() []string
GetListBatchJobsSortByEnumStringValues Enumerates the set of values in String for ListBatchJobsSortByEnum
func GetListBatchJobsSortOrderEnumStringValues() []string
GetListBatchJobsSortOrderEnumStringValues Enumerates the set of values in String for ListBatchJobsSortOrderEnum
func GetListBatchTaskEnvironmentsSortByEnumStringValues() []string
GetListBatchTaskEnvironmentsSortByEnumStringValues Enumerates the set of values in String for ListBatchTaskEnvironmentsSortByEnum
func GetListBatchTaskEnvironmentsSortOrderEnumStringValues() []string
GetListBatchTaskEnvironmentsSortOrderEnumStringValues Enumerates the set of values in String for ListBatchTaskEnvironmentsSortOrderEnum
func GetListBatchTaskProfilesSortByEnumStringValues() []string
GetListBatchTaskProfilesSortByEnumStringValues Enumerates the set of values in String for ListBatchTaskProfilesSortByEnum
func GetListBatchTaskProfilesSortOrderEnumStringValues() []string
GetListBatchTaskProfilesSortOrderEnumStringValues Enumerates the set of values in String for ListBatchTaskProfilesSortOrderEnum
func GetListBatchTasksSortByEnumStringValues() []string
GetListBatchTasksSortByEnumStringValues Enumerates the set of values in String for ListBatchTasksSortByEnum
func GetListBatchTasksSortOrderEnumStringValues() []string
GetListBatchTasksSortOrderEnumStringValues Enumerates the set of values in String for ListBatchTasksSortOrderEnum
func GetListWorkRequestErrorsSortByEnumStringValues() []string
GetListWorkRequestErrorsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortByEnum
func GetListWorkRequestErrorsSortOrderEnumStringValues() []string
GetListWorkRequestErrorsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestErrorsSortOrderEnum
func GetListWorkRequestLogsSortByEnumStringValues() []string
GetListWorkRequestLogsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortByEnum
func GetListWorkRequestLogsSortOrderEnumStringValues() []string
GetListWorkRequestLogsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestLogsSortOrderEnum
func GetListWorkRequestsSortByEnumStringValues() []string
GetListWorkRequestsSortByEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortByEnum
func GetListWorkRequestsSortOrderEnumStringValues() []string
GetListWorkRequestsSortOrderEnumStringValues Enumerates the set of values in String for ListWorkRequestsSortOrderEnum
func GetListWorkRequestsStatusEnumStringValues() []string
GetListWorkRequestsStatusEnumStringValues Enumerates the set of values in String for ListWorkRequestsStatusEnum
func GetLoggingConfigurationTypeEnumStringValues() []string
GetLoggingConfigurationTypeEnumStringValues Enumerates the set of values in String for LoggingConfigurationTypeEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSortByEnumStringValues() []string
GetSortByEnumStringValues Enumerates the set of values in String for SortByEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetWorkRequestLogAndErrorSortByEnumStringValues() []string
GetWorkRequestLogAndErrorSortByEnumStringValues Enumerates the set of values in String for WorkRequestLogAndErrorSortByEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
func GetWorkRequestSortByEnumStringValues() []string
GetWorkRequestSortByEnumStringValues Enumerates the set of values in String for WorkRequestSortByEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
ActionTypeFailed ActionTypeEnum = "FAILED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BatchComputingClient a client for BatchComputing
type BatchComputingClient struct {
common.BaseClient
// contains filtered or unexported fields
}
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(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 (client BatchComputingClient) CancelBatchJob(ctx context.Context, request CancelBatchJobRequest) (response CancelBatchJobResponse, err error)
CancelBatchJob Cancels a batch job.
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 (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).
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 (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).
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 (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).
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 (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).
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 (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).
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 (client *BatchComputingClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client BatchComputingClient) CreateBatchContext(ctx context.Context, request CreateBatchContextRequest) (response CreateBatchContextResponse, err error)
CreateBatchContext Creates a batch context.
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 (client BatchComputingClient) CreateBatchJob(ctx context.Context, request CreateBatchJobRequest) (response CreateBatchJobResponse, err error)
CreateBatchJob Creates a batch job.
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 (client BatchComputingClient) CreateBatchJobPool(ctx context.Context, request CreateBatchJobPoolRequest) (response CreateBatchJobPoolResponse, err error)
CreateBatchJobPool Creates a batch job pool.
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 (client BatchComputingClient) CreateBatchTaskEnvironment(ctx context.Context, request CreateBatchTaskEnvironmentRequest) (response CreateBatchTaskEnvironmentResponse, err error)
CreateBatchTaskEnvironment Creates a batch task environment.
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 (client BatchComputingClient) CreateBatchTaskProfile(ctx context.Context, request CreateBatchTaskProfileRequest) (response CreateBatchTaskProfileResponse, err error)
CreateBatchTaskProfile Creates a batch task profile.
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 (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.
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 (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.
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 (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.
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 (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.
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 (client BatchComputingClient) GetBatchContext(ctx context.Context, request GetBatchContextRequest) (response GetBatchContextResponse, err error)
GetBatchContext Gets information about a batch context.
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 (client BatchComputingClient) GetBatchJob(ctx context.Context, request GetBatchJobRequest) (response GetBatchJobResponse, err error)
GetBatchJob Gets information about a batch job.
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 (client BatchComputingClient) GetBatchJobPool(ctx context.Context, request GetBatchJobPoolRequest) (response GetBatchJobPoolResponse, err error)
GetBatchJobPool Gets information about a batch job pool.
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 (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.
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 (client BatchComputingClient) GetBatchTaskEnvironment(ctx context.Context, request GetBatchTaskEnvironmentRequest) (response GetBatchTaskEnvironmentResponse, err error)
GetBatchTaskEnvironment Gets information about a batch task environment.
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 (client BatchComputingClient) GetBatchTaskProfile(ctx context.Context, request GetBatchTaskProfileRequest) (response GetBatchTaskProfileResponse, err error)
GetBatchTaskProfile Gets information about a batch task profile.
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 (client BatchComputingClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the details of a work request.
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 (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.
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 (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
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 (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
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 (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
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 (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
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 (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
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 (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
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 (client BatchComputingClient) ListBatchTasks(ctx context.Context, request ListBatchTasksRequest) (response ListBatchTasksResponse, err error)
ListBatchTasks Lists the batch tasks associated with batch jobs.
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 (client BatchComputingClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Lists the errors for a work request.
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 (client BatchComputingClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Lists the logs for a work request.
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 (client BatchComputingClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
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 (client BatchComputingClient) PauseBatchJob(ctx context.Context, request PauseBatchJobRequest) (response PauseBatchJobResponse, err error)
PauseBatchJob Pauses the batch job and all its tasks.
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 (client *BatchComputingClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client BatchComputingClient) StartBatchContext(ctx context.Context, request StartBatchContextRequest) (response StartBatchContextResponse, err error)
StartBatchContext Activates a batch context to accept new jobs.
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 (client BatchComputingClient) StartBatchJobPool(ctx context.Context, request StartBatchJobPoolRequest) (response StartBatchJobPoolResponse, err error)
StartBatchJobPool Activates the batch job pool.
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 (client BatchComputingClient) StopBatchContext(ctx context.Context, request StopBatchContextRequest) (response StopBatchContextResponse, err error)
StopBatchContext Stops a batch context from accepting new jobs.
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 (client BatchComputingClient) StopBatchJobPool(ctx context.Context, request StopBatchJobPoolRequest) (response StopBatchJobPoolResponse, err error)
StopBatchJobPool Deactivates the batch job pool.
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 (client BatchComputingClient) UnpauseBatchJob(ctx context.Context, request UnpauseBatchJobRequest) (response UnpauseBatchJobResponse, err error)
UnpauseBatchJob Resumes the batch job and all its tasks.
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 (client BatchComputingClient) UpdateBatchContext(ctx context.Context, request UpdateBatchContextRequest) (response UpdateBatchContextResponse, err error)
UpdateBatchContext Updates a batch context.
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 (client BatchComputingClient) UpdateBatchJob(ctx context.Context, request UpdateBatchJobRequest) (response UpdateBatchJobResponse, err error)
UpdateBatchJob Updates a batch job.
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 (client BatchComputingClient) UpdateBatchJobPool(ctx context.Context, request UpdateBatchJobPoolRequest) (response UpdateBatchJobPoolResponse, err error)
UpdateBatchJobPool Updates a batch job pool.
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 (client BatchComputingClient) UpdateBatchTaskEnvironment(ctx context.Context, request UpdateBatchTaskEnvironmentRequest) (response UpdateBatchTaskEnvironmentResponse, err error)
UpdateBatchTaskEnvironment Updates a batch task environment.
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 (client BatchComputingClient) UpdateBatchTaskProfile(ctx context.Context, request UpdateBatchTaskProfileRequest) (response UpdateBatchTaskProfileResponse, err error)
UpdateBatchTaskProfile Updates a batch task profile.
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()
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).
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"`
}
func (m BatchContext) String() string
func (m *BatchContext) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
BatchContextCollection Results of a batch context search. Contains both batch context summary items and other information, such as metadata.
type BatchContextCollection struct {
// List of batch contexts.
Items []BatchContextSummary `mandatory:"true" json:"items"`
}
func (m BatchContextCollection) String() string
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
BatchContextLifecycleStateEnum Enum with underlying type: string
type BatchContextLifecycleStateEnum string
Set of constants representing the allowable values for BatchContextLifecycleStateEnum
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"
)
func GetBatchContextLifecycleStateEnumValues() []BatchContextLifecycleStateEnum
GetBatchContextLifecycleStateEnumValues Enumerates the set of values for BatchContextLifecycleStateEnum
func GetMappingBatchContextLifecycleStateEnum(val string) (BatchContextLifecycleStateEnum, bool)
GetMappingBatchContextLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BatchContextShapeCollection A collection of container instance shapes.
type BatchContextShapeCollection struct {
// List of shapes.
Items []BatchContextShapeSummary `mandatory:"true" json:"items"`
}
func (m BatchContextShapeCollection) String() string
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
BatchContextShapeSummary Details about a shape for a container instance.
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"`
}
func (m BatchContextShapeSummary) String() string
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
BatchContextSummary Summary information about a batch context.
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"`
}
func (m BatchContextSummary) String() string
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
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).
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"`
}
func (m BatchJob) String() string
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
BatchJobCollection Results of a batch job search. Contains both batch job summary items and other information, such as metadata.
type BatchJobCollection struct {
// List of batch jobs.
Items []BatchJobSummary `mandatory:"true" json:"items"`
}
func (m BatchJobCollection) String() string
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
BatchJobLifecycleStateEnum Enum with underlying type: string
type BatchJobLifecycleStateEnum string
Set of constants representing the allowable values for BatchJobLifecycleStateEnum
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"
)
func GetBatchJobLifecycleStateEnumValues() []BatchJobLifecycleStateEnum
GetBatchJobLifecycleStateEnumValues Enumerates the set of values for BatchJobLifecycleStateEnum
func GetMappingBatchJobLifecycleStateEnum(val string) (BatchJobLifecycleStateEnum, bool)
GetMappingBatchJobLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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).
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"`
}
func (m BatchJobPool) String() string
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
BatchJobPoolCollection Results of a batch job pool search. Contains both batch job pool summary items and other information, such as metadata.
type BatchJobPoolCollection struct {
// List of batch job pools.
Items []BatchJobPoolSummary `mandatory:"true" json:"items"`
}
func (m BatchJobPoolCollection) String() string
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
BatchJobPoolLifecycleStateEnum Enum with underlying type: string
type BatchJobPoolLifecycleStateEnum string
Set of constants representing the allowable values for BatchJobPoolLifecycleStateEnum
const (
BatchJobPoolLifecycleStateActive BatchJobPoolLifecycleStateEnum = "ACTIVE"
BatchJobPoolLifecycleStateInactive BatchJobPoolLifecycleStateEnum = "INACTIVE"
BatchJobPoolLifecycleStateUpdating BatchJobPoolLifecycleStateEnum = "UPDATING"
BatchJobPoolLifecycleStateNeedsAttention BatchJobPoolLifecycleStateEnum = "NEEDS_ATTENTION"
BatchJobPoolLifecycleStateDeleted BatchJobPoolLifecycleStateEnum = "DELETED"
)
func GetBatchJobPoolLifecycleStateEnumValues() []BatchJobPoolLifecycleStateEnum
GetBatchJobPoolLifecycleStateEnumValues Enumerates the set of values for BatchJobPoolLifecycleStateEnum
func GetMappingBatchJobPoolLifecycleStateEnum(val string) (BatchJobPoolLifecycleStateEnum, bool)
GetMappingBatchJobPoolLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BatchJobPoolSummary Summary information about a batch job pool.
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"`
}
func (m BatchJobPoolSummary) String() string
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
BatchJobSummary Summary information about a batch job.
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"`
}
func (m BatchJobSummary) String() string
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
BatchTask A batch task contains common properties for all types of job tasks.
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 from the same job this task depends on referenced by name.
GetDependencies() []string
// Environment variables to use for the task execution.
GetEnvironmentVariables() []EnvironmentVariable
// 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
}
BatchTaskCollection Results of a batch task search. Contains both batch task summary items and other information, such as metadata.
type BatchTaskCollection struct {
// List of batch task summaries.
Items []BatchTaskSummary `mandatory:"true" json:"items"`
}
func (m BatchTaskCollection) String() string
func (m *BatchTaskCollection) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
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).
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"`
}
func (m BatchTaskEnvironment) String() string
func (m *BatchTaskEnvironment) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
BatchTaskEnvironmentCollection Results of a batch task environment search. Contains both batch task environment summary items and other information, such as metadata.
type BatchTaskEnvironmentCollection struct {
// List of batch task environments.
Items []BatchTaskEnvironmentSummary `mandatory:"true" json:"items"`
}
func (m BatchTaskEnvironmentCollection) String() string
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
BatchTaskEnvironmentLifecycleStateEnum Enum with underlying type: string
type BatchTaskEnvironmentLifecycleStateEnum string
Set of constants representing the allowable values for BatchTaskEnvironmentLifecycleStateEnum
const (
BatchTaskEnvironmentLifecycleStateActive BatchTaskEnvironmentLifecycleStateEnum = "ACTIVE"
BatchTaskEnvironmentLifecycleStateDeleted BatchTaskEnvironmentLifecycleStateEnum = "DELETED"
)
func GetBatchTaskEnvironmentLifecycleStateEnumValues() []BatchTaskEnvironmentLifecycleStateEnum
GetBatchTaskEnvironmentLifecycleStateEnumValues Enumerates the set of values for BatchTaskEnvironmentLifecycleStateEnum
func GetMappingBatchTaskEnvironmentLifecycleStateEnum(val string) (BatchTaskEnvironmentLifecycleStateEnum, bool)
GetMappingBatchTaskEnvironmentLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BatchTaskEnvironmentSummary Summary information about a batch task environment.
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"`
}
func (m BatchTaskEnvironmentSummary) String() string
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
BatchTaskEnvironmentVolume A base type for volume for batch task environment.
type BatchTaskEnvironmentVolume interface {
}
BatchTaskEnvironmentVolumeTypeEnum Enum with underlying type: string
type BatchTaskEnvironmentVolumeTypeEnum string
Set of constants representing the allowable values for BatchTaskEnvironmentVolumeTypeEnum
const (
BatchTaskEnvironmentVolumeTypeNfs BatchTaskEnvironmentVolumeTypeEnum = "NFS"
)
func GetBatchTaskEnvironmentVolumeTypeEnumValues() []BatchTaskEnvironmentVolumeTypeEnum
GetBatchTaskEnvironmentVolumeTypeEnumValues Enumerates the set of values for BatchTaskEnvironmentVolumeTypeEnum
func GetMappingBatchTaskEnvironmentVolumeTypeEnum(val string) (BatchTaskEnvironmentVolumeTypeEnum, bool)
GetMappingBatchTaskEnvironmentVolumeTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BatchTaskLifecycleStateEnum Enum with underlying type: string
type BatchTaskLifecycleStateEnum string
Set of constants representing the allowable values for BatchTaskLifecycleStateEnum
const (
BatchTaskLifecycleStateAccepted BatchTaskLifecycleStateEnum = "ACCEPTED"
BatchTaskLifecycleStateWaiting BatchTaskLifecycleStateEnum = "WAITING"
BatchTaskLifecycleStateInProgress BatchTaskLifecycleStateEnum = "IN_PROGRESS"
BatchTaskLifecycleStateSucceeded BatchTaskLifecycleStateEnum = "SUCCEEDED"
BatchTaskLifecycleStateFailed BatchTaskLifecycleStateEnum = "FAILED"
BatchTaskLifecycleStateCanceling BatchTaskLifecycleStateEnum = "CANCELING"
BatchTaskLifecycleStateCanceled BatchTaskLifecycleStateEnum = "CANCELED"
)
func GetBatchTaskLifecycleStateEnumValues() []BatchTaskLifecycleStateEnum
GetBatchTaskLifecycleStateEnumValues Enumerates the set of values for BatchTaskLifecycleStateEnum
func GetMappingBatchTaskLifecycleStateEnum(val string) (BatchTaskLifecycleStateEnum, bool)
GetMappingBatchTaskLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
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).
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 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"`
}
func (m BatchTaskProfile) String() string
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
BatchTaskProfileCollection Results of a batch task profile search. Contains both batch task profile summary items and other information, such as metadata.
type BatchTaskProfileCollection struct {
// List of batch task profiles.
Items []BatchTaskProfileSummary `mandatory:"true" json:"items"`
}
func (m BatchTaskProfileCollection) String() string
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
BatchTaskProfileLifecycleStateEnum Enum with underlying type: string
type BatchTaskProfileLifecycleStateEnum string
Set of constants representing the allowable values for BatchTaskProfileLifecycleStateEnum
const (
BatchTaskProfileLifecycleStateActive BatchTaskProfileLifecycleStateEnum = "ACTIVE"
BatchTaskProfileLifecycleStateDeleted BatchTaskProfileLifecycleStateEnum = "DELETED"
)
func GetBatchTaskProfileLifecycleStateEnumValues() []BatchTaskProfileLifecycleStateEnum
GetBatchTaskProfileLifecycleStateEnumValues Enumerates the set of values for BatchTaskProfileLifecycleStateEnum
func GetMappingBatchTaskProfileLifecycleStateEnum(val string) (BatchTaskProfileLifecycleStateEnum, bool)
GetMappingBatchTaskProfileLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BatchTaskProfileSummary Summary information about a batch task profile.
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 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"`
}
func (m BatchTaskProfileSummary) String() string
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
BatchTaskSortByEnum Enum with underlying type: string
type BatchTaskSortByEnum string
Set of constants representing the allowable values for BatchTaskSortByEnum
const (
BatchTaskSortByName BatchTaskSortByEnum = "name"
)
func GetBatchTaskSortByEnumValues() []BatchTaskSortByEnum
GetBatchTaskSortByEnumValues Enumerates the set of values for BatchTaskSortByEnum
func GetMappingBatchTaskSortByEnum(val string) (BatchTaskSortByEnum, bool)
GetMappingBatchTaskSortByEnum performs case Insensitive comparison on enum value and return the desired enum
BatchTaskSummary Summary information about a batch task.
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
// 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
}
BatchTaskTypeEnum Enum with underlying type: string
type BatchTaskTypeEnum string
Set of constants representing the allowable values for BatchTaskTypeEnum
const (
BatchTaskTypeCompute BatchTaskTypeEnum = "COMPUTE"
)
func GetBatchTaskTypeEnumValues() []BatchTaskTypeEnum
GetBatchTaskTypeEnumValues Enumerates the set of values for BatchTaskTypeEnum
func GetMappingBatchTaskTypeEnum(val string) (BatchTaskTypeEnum, bool)
GetMappingBatchTaskTypeEnum performs case Insensitive comparison on enum value and return the desired enum
BestFitFleetAssignmentPolicy The system will assign a task to the smallest sufficient fleet, with no flexibility for using larger fleets.
type BestFitFleetAssignmentPolicy struct {
}
func (m BestFitFleetAssignmentPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m BestFitFleetAssignmentPolicy) String() string
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
CancelBatchJobRequest wrapper for the CancelBatchJob operation
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.
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
}
func (request CancelBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CancelBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CancelBatchJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CancelBatchJobRequest) String() string
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
CancelBatchJobResponse wrapper for the CancelBatchJob operation
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"`
}
func (response CancelBatchJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CancelBatchJobResponse) String() string
ChangeBatchContextCompartmentDetails The configuration details for the move operation.
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"`
}
func (m ChangeBatchContextCompartmentDetails) String() string
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
ChangeBatchContextCompartmentRequest wrapper for the ChangeBatchContextCompartment operation
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.
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
}
func (request ChangeBatchContextCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBatchContextCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBatchContextCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBatchContextCompartmentRequest) String() string
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
ChangeBatchContextCompartmentResponse wrapper for the ChangeBatchContextCompartment operation
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"`
}
func (response ChangeBatchContextCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBatchContextCompartmentResponse) String() string
ChangeBatchJobCompartmentDetails The configuration details for the move operation.
type ChangeBatchJobCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeBatchJobCompartmentDetails) String() string
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
ChangeBatchJobCompartmentRequest wrapper for the ChangeBatchJobCompartment operation
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.
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
}
func (request ChangeBatchJobCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBatchJobCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBatchJobCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBatchJobCompartmentRequest) String() string
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
ChangeBatchJobCompartmentResponse wrapper for the ChangeBatchJobCompartment operation
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"`
}
func (response ChangeBatchJobCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBatchJobCompartmentResponse) String() string
ChangeBatchJobPoolCompartmentDetails The configuration details for the move operation.
type ChangeBatchJobPoolCompartmentDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeBatchJobPoolCompartmentDetails) String() string
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
ChangeBatchJobPoolCompartmentRequest wrapper for the ChangeBatchJobPoolCompartment operation
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.
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
}
func (request ChangeBatchJobPoolCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBatchJobPoolCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBatchJobPoolCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBatchJobPoolCompartmentRequest) String() string
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
ChangeBatchJobPoolCompartmentResponse wrapper for the ChangeBatchJobPoolCompartment operation
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"`
}
func (response ChangeBatchJobPoolCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBatchJobPoolCompartmentResponse) String() string
ChangeBatchTaskEnvironmentCompartmentDetails The configuration details for the move operation.
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"`
}
func (m ChangeBatchTaskEnvironmentCompartmentDetails) String() string
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
ChangeBatchTaskEnvironmentCompartmentRequest wrapper for the ChangeBatchTaskEnvironmentCompartment operation
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.
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
}
func (request ChangeBatchTaskEnvironmentCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBatchTaskEnvironmentCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBatchTaskEnvironmentCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBatchTaskEnvironmentCompartmentRequest) String() string
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
ChangeBatchTaskEnvironmentCompartmentResponse wrapper for the ChangeBatchTaskEnvironmentCompartment operation
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"`
}
func (response ChangeBatchTaskEnvironmentCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBatchTaskEnvironmentCompartmentResponse) String() string
ChangeBatchTaskProfileCompartmentDetails The configuration details for the move operation.
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"`
}
func (m ChangeBatchTaskProfileCompartmentDetails) String() string
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
ChangeBatchTaskProfileCompartmentRequest wrapper for the ChangeBatchTaskProfileCompartment operation
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.
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
}
func (request ChangeBatchTaskProfileCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBatchTaskProfileCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBatchTaskProfileCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBatchTaskProfileCompartmentRequest) String() string
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
ChangeBatchTaskProfileCompartmentResponse wrapper for the ChangeBatchTaskProfileCompartment operation
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"`
}
func (response ChangeBatchTaskProfileCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBatchTaskProfileCompartmentResponse) String() string
ComputeTask compute task represents a single executable command together with its dependencies and resources.
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 from the same job this task depends on referenced by name.
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"`
// 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"`
// The current state of the batch task.
LifecycleState BatchTaskLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}
func (m ComputeTask) GetDependencies() []string
GetDependencies returns Dependencies
func (m ComputeTask) GetDescription() *string
GetDescription returns Description
func (m ComputeTask) GetEntitlementClaims() []string
GetEntitlementClaims returns EntitlementClaims
func (m ComputeTask) GetEnvironmentVariables() []EnvironmentVariable
GetEnvironmentVariables returns EnvironmentVariables
func (m ComputeTask) GetId() *string
GetId returns Id
func (m ComputeTask) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m ComputeTask) GetLifecycleState() BatchTaskLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ComputeTask) GetName() *string
GetName returns Name
func (m ComputeTask) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ComputeTask) String() string
func (m *ComputeTask) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
ComputeTaskSummary Summary information about a compute task.
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"`
// 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"`
}
func (m ComputeTaskSummary) GetDescription() *string
GetDescription returns Description
func (m ComputeTaskSummary) GetId() *string
GetId returns Id
func (m ComputeTaskSummary) GetJobId() *string
GetJobId returns JobId
func (m ComputeTaskSummary) GetLifecycleDetails() *string
GetLifecycleDetails returns LifecycleDetails
func (m ComputeTaskSummary) GetLifecycleState() BatchTaskLifecycleStateEnum
GetLifecycleState returns LifecycleState
func (m ComputeTaskSummary) GetName() *string
GetName returns Name
func (m ComputeTaskSummary) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ComputeTaskSummary) String() string
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
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.
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"`
}
func (m CreateBatchContextDetails) String() string
func (m *CreateBatchContextDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateBatchContextRequest wrapper for the CreateBatchContext operation
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.
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
}
func (request CreateBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBatchContextRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBatchContextRequest) String() string
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
CreateBatchContextResponse wrapper for the CreateBatchContext operation
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"`
}
func (response CreateBatchContextResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBatchContextResponse) String() string
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.
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"`
}
func (m CreateBatchJobDetails) String() string
func (m *CreateBatchJobDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
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.
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"`
}
func (m CreateBatchJobPoolDetails) String() string
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
CreateBatchJobPoolRequest wrapper for the CreateBatchJobPool operation
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.
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
}
func (request CreateBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBatchJobPoolRequest) String() string
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
CreateBatchJobPoolResponse wrapper for the CreateBatchJobPool operation
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"`
}
func (response CreateBatchJobPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBatchJobPoolResponse) String() string
CreateBatchJobRequest wrapper for the CreateBatchJob operation
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.
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
}
func (request CreateBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBatchJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBatchJobRequest) String() string
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
CreateBatchJobResponse wrapper for the CreateBatchJob operation
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"`
}
func (response CreateBatchJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBatchJobResponse) String() string
CreateBatchTaskDetails A batch task contains common properties for all types of job tasks.
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 from the same job this task depends on referenced by name.
GetDependencies() []string
// Environment variables to use for the task execution.
GetEnvironmentVariables() []EnvironmentVariable
}
CreateBatchTaskDetailsTypeEnum Enum with underlying type: string
type CreateBatchTaskDetailsTypeEnum string
Set of constants representing the allowable values for CreateBatchTaskDetailsTypeEnum
const (
CreateBatchTaskDetailsTypeCompute CreateBatchTaskDetailsTypeEnum = "COMPUTE"
)
func GetCreateBatchTaskDetailsTypeEnumValues() []CreateBatchTaskDetailsTypeEnum
GetCreateBatchTaskDetailsTypeEnumValues Enumerates the set of values for CreateBatchTaskDetailsTypeEnum
func GetMappingCreateBatchTaskDetailsTypeEnum(val string) (CreateBatchTaskDetailsTypeEnum, bool)
GetMappingCreateBatchTaskDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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.
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"`
}
func (m CreateBatchTaskEnvironmentDetails) String() string
func (m *CreateBatchTaskEnvironmentDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateBatchTaskEnvironmentRequest wrapper for the CreateBatchTaskEnvironment operation
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.
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
}
func (request CreateBatchTaskEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBatchTaskEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBatchTaskEnvironmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBatchTaskEnvironmentRequest) String() string
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
CreateBatchTaskEnvironmentResponse wrapper for the CreateBatchTaskEnvironment operation
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"`
}
func (response CreateBatchTaskEnvironmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBatchTaskEnvironmentResponse) String() string
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.
type CreateBatchTaskProfileDetails struct {
// The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The minimum required OCPUs.
MinOcpus *int `mandatory:"true" json:"minOcpus"`
// The minimum required memory.
MinMemoryInGBs *int `mandatory:"true" json:"minMemoryInGBs"`
// 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"`
// 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"`
}
func (m CreateBatchTaskProfileDetails) String() string
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
CreateBatchTaskProfileRequest wrapper for the CreateBatchTaskProfile operation
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.
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
}
func (request CreateBatchTaskProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBatchTaskProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBatchTaskProfileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBatchTaskProfileRequest) String() string
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
CreateBatchTaskProfileResponse wrapper for the CreateBatchTaskProfile operation
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"`
}
func (response CreateBatchTaskProfileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBatchTaskProfileResponse) String() string
CreateComputeTaskDetails compute task represents a single executable command together with its dependencies and resources.
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 from the same job this task depends on referenced by name.
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"`
}
func (m CreateComputeTaskDetails) GetDependencies() []string
GetDependencies returns Dependencies
func (m CreateComputeTaskDetails) GetDescription() *string
GetDescription returns Description
func (m CreateComputeTaskDetails) GetEntitlementClaims() []string
GetEntitlementClaims returns EntitlementClaims
func (m CreateComputeTaskDetails) GetEnvironmentVariables() []EnvironmentVariable
GetEnvironmentVariables returns EnvironmentVariables
func (m CreateComputeTaskDetails) GetName() *string
GetName returns Name
func (m CreateComputeTaskDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateComputeTaskDetails) String() string
func (m *CreateComputeTaskDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
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
CreateFleetDetails Fleet configuration of the batch context.
type CreateFleetDetails interface {
}
CreateFleetDetailsTypeEnum Enum with underlying type: string
type CreateFleetDetailsTypeEnum string
Set of constants representing the allowable values for CreateFleetDetailsTypeEnum
const (
CreateFleetDetailsTypeServiceManagedFleet CreateFleetDetailsTypeEnum = "SERVICE_MANAGED_FLEET"
)
func GetCreateFleetDetailsTypeEnumValues() []CreateFleetDetailsTypeEnum
GetCreateFleetDetailsTypeEnumValues Enumerates the set of values for CreateFleetDetailsTypeEnum
func GetMappingCreateFleetDetailsTypeEnum(val string) (CreateFleetDetailsTypeEnum, bool)
GetMappingCreateFleetDetailsTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateNetworkDetails Network configuration of the batch context.
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"`
}
func (m CreateNetworkDetails) String() string
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
CreateServiceManagedFleetDetails Service managed Fleet configuration of the batch context.
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"`
}
func (m CreateServiceManagedFleetDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateServiceManagedFleetDetails) String() string
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
DeleteBatchContextRequest wrapper for the DeleteBatchContext operation
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.
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
}
func (request DeleteBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBatchContextRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBatchContextRequest) String() string
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
DeleteBatchContextResponse wrapper for the DeleteBatchContext operation
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"`
}
func (response DeleteBatchContextResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBatchContextResponse) String() string
DeleteBatchJobPoolRequest wrapper for the DeleteBatchJobPool operation
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.
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
}
func (request DeleteBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBatchJobPoolRequest) String() string
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
DeleteBatchJobPoolResponse wrapper for the DeleteBatchJobPool operation
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"`
}
func (response DeleteBatchJobPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBatchJobPoolResponse) String() string
DeleteBatchTaskEnvironmentRequest wrapper for the DeleteBatchTaskEnvironment operation
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.
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
}
func (request DeleteBatchTaskEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBatchTaskEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBatchTaskEnvironmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBatchTaskEnvironmentRequest) String() string
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
DeleteBatchTaskEnvironmentResponse wrapper for the DeleteBatchTaskEnvironment operation
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"`
}
func (response DeleteBatchTaskEnvironmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBatchTaskEnvironmentResponse) String() string
DeleteBatchTaskProfileRequest wrapper for the DeleteBatchTaskProfile operation
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.
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
}
func (request DeleteBatchTaskProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBatchTaskProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBatchTaskProfileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBatchTaskProfileRequest) String() string
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
DeleteBatchTaskProfileResponse wrapper for the DeleteBatchTaskProfile operation
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"`
}
func (response DeleteBatchTaskProfileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBatchTaskProfileResponse) String() string
EnvironmentVariable OS environment variable.
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"`
}
func (m EnvironmentVariable) String() string
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
Fleet Fleet configuration of the batch context.
type Fleet 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 FleetAssignmentPolicy interface {
}
FleetAssignmentPolicyTypeEnum Enum with underlying type: string
type FleetAssignmentPolicyTypeEnum string
Set of constants representing the allowable values for FleetAssignmentPolicyTypeEnum
const (
FleetAssignmentPolicyTypeBestFit FleetAssignmentPolicyTypeEnum = "BEST_FIT"
FleetAssignmentPolicyTypeFlexFit FleetAssignmentPolicyTypeEnum = "FLEX_FIT"
)
func GetFleetAssignmentPolicyTypeEnumValues() []FleetAssignmentPolicyTypeEnum
GetFleetAssignmentPolicyTypeEnumValues Enumerates the set of values for FleetAssignmentPolicyTypeEnum
func GetMappingFleetAssignmentPolicyTypeEnum(val string) (FleetAssignmentPolicyTypeEnum, bool)
GetMappingFleetAssignmentPolicyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
FleetShape Shape of the fleet. Describes hardware resources of each node in the fleet.
type FleetShape struct {
// The name of the shape.
ShapeName *string `mandatory:"true" json:"shapeName"`
// Number of OCPUs required by the shape.
Ocpus *int `mandatory:"true" json:"ocpus"`
// Amount of memory in GBs required by the shape.
MemoryInGBs *int `mandatory:"true" json:"memoryInGBs"`
}
func (m FleetShape) String() string
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
FleetTypeEnum Enum with underlying type: string
type FleetTypeEnum string
Set of constants representing the allowable values for FleetTypeEnum
const (
FleetTypeServiceManagedFleet FleetTypeEnum = "SERVICE_MANAGED_FLEET"
)
func GetFleetTypeEnumValues() []FleetTypeEnum
GetFleetTypeEnumValues Enumerates the set of values for FleetTypeEnum
func GetMappingFleetTypeEnum(val string) (FleetTypeEnum, bool)
GetMappingFleetTypeEnum performs case Insensitive comparison on enum value and return the desired enum
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.
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"`
}
func (m FlexFitFleetAssignmentPolicy) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m FlexFitFleetAssignmentPolicy) String() string
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
GetBatchContextRequest wrapper for the GetBatchContext operation
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.
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
}
func (request GetBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBatchContextRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBatchContextRequest) String() string
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
GetBatchContextResponse wrapper for the GetBatchContext operation
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"`
}
func (response GetBatchContextResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBatchContextResponse) String() string
GetBatchJobPoolRequest wrapper for the GetBatchJobPool operation
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.
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
}
func (request GetBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBatchJobPoolRequest) String() string
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
GetBatchJobPoolResponse wrapper for the GetBatchJobPool operation
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"`
}
func (response GetBatchJobPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBatchJobPoolResponse) String() string
GetBatchJobRequest wrapper for the GetBatchJob operation
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.
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
}
func (request GetBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBatchJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBatchJobRequest) String() string
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
GetBatchJobResponse wrapper for the GetBatchJob operation
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"`
}
func (response GetBatchJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBatchJobResponse) String() string
GetBatchTaskEnvironmentRequest wrapper for the GetBatchTaskEnvironment operation
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.
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
}
func (request GetBatchTaskEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBatchTaskEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBatchTaskEnvironmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBatchTaskEnvironmentRequest) String() string
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
GetBatchTaskEnvironmentResponse wrapper for the GetBatchTaskEnvironment operation
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"`
}
func (response GetBatchTaskEnvironmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBatchTaskEnvironmentResponse) String() string
GetBatchTaskProfileRequest wrapper for the GetBatchTaskProfile operation
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.
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
}
func (request GetBatchTaskProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBatchTaskProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBatchTaskProfileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBatchTaskProfileRequest) String() string
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
GetBatchTaskProfileResponse wrapper for the GetBatchTaskProfile operation
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"`
}
func (response GetBatchTaskProfileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBatchTaskProfileResponse) String() string
GetBatchTaskRequest wrapper for the GetBatchTask operation
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.
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 name of the batch task.
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
}
func (request GetBatchTaskRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBatchTaskRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBatchTaskRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBatchTaskRequest) String() string
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
GetBatchTaskResponse wrapper for the GetBatchTask operation
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"`
}
func (response GetBatchTaskResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBatchTaskResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
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.
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
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
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
GetWorkRequestResponse wrapper for the GetWorkRequest operation
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"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
JobPriorityConfiguration Job priority configuration to instruct the service on how to use priority tags.
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"`
}
func (m JobPriorityConfiguration) String() string
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
ListBatchContextShapesRequest wrapper for the ListBatchContextShapes operation
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.
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"`
// 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
}
func (request ListBatchContextShapesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBatchContextShapesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBatchContextShapesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBatchContextShapesRequest) String() string
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
ListBatchContextShapesResponse wrapper for the ListBatchContextShapes operation
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"`
}
func (response ListBatchContextShapesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBatchContextShapesResponse) String() string
ListBatchContextsRequest wrapper for the ListBatchContexts operation
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.
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
}
func (request ListBatchContextsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBatchContextsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBatchContextsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBatchContextsRequest) String() string
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
ListBatchContextsResponse wrapper for the ListBatchContexts operation
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"`
}
func (response ListBatchContextsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBatchContextsResponse) String() string
ListBatchContextsSortByEnum Enum with underlying type: string
type ListBatchContextsSortByEnum string
Set of constants representing the allowable values for ListBatchContextsSortByEnum
const (
ListBatchContextsSortByTimecreated ListBatchContextsSortByEnum = "timeCreated"
ListBatchContextsSortByDisplayname ListBatchContextsSortByEnum = "displayName"
)
func GetListBatchContextsSortByEnumValues() []ListBatchContextsSortByEnum
GetListBatchContextsSortByEnumValues Enumerates the set of values for ListBatchContextsSortByEnum
func GetMappingListBatchContextsSortByEnum(val string) (ListBatchContextsSortByEnum, bool)
GetMappingListBatchContextsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchContextsSortOrderEnum Enum with underlying type: string
type ListBatchContextsSortOrderEnum string
Set of constants representing the allowable values for ListBatchContextsSortOrderEnum
const (
ListBatchContextsSortOrderAsc ListBatchContextsSortOrderEnum = "ASC"
ListBatchContextsSortOrderDesc ListBatchContextsSortOrderEnum = "DESC"
)
func GetListBatchContextsSortOrderEnumValues() []ListBatchContextsSortOrderEnum
GetListBatchContextsSortOrderEnumValues Enumerates the set of values for ListBatchContextsSortOrderEnum
func GetMappingListBatchContextsSortOrderEnum(val string) (ListBatchContextsSortOrderEnum, bool)
GetMappingListBatchContextsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchJobPoolsRequest wrapper for the ListBatchJobPools operation
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.
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
}
func (request ListBatchJobPoolsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBatchJobPoolsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBatchJobPoolsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBatchJobPoolsRequest) String() string
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
ListBatchJobPoolsResponse wrapper for the ListBatchJobPools operation
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"`
}
func (response ListBatchJobPoolsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBatchJobPoolsResponse) String() string
ListBatchJobPoolsSortByEnum Enum with underlying type: string
type ListBatchJobPoolsSortByEnum string
Set of constants representing the allowable values for ListBatchJobPoolsSortByEnum
const (
ListBatchJobPoolsSortByTimecreated ListBatchJobPoolsSortByEnum = "timeCreated"
ListBatchJobPoolsSortByDisplayname ListBatchJobPoolsSortByEnum = "displayName"
)
func GetListBatchJobPoolsSortByEnumValues() []ListBatchJobPoolsSortByEnum
GetListBatchJobPoolsSortByEnumValues Enumerates the set of values for ListBatchJobPoolsSortByEnum
func GetMappingListBatchJobPoolsSortByEnum(val string) (ListBatchJobPoolsSortByEnum, bool)
GetMappingListBatchJobPoolsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchJobPoolsSortOrderEnum Enum with underlying type: string
type ListBatchJobPoolsSortOrderEnum string
Set of constants representing the allowable values for ListBatchJobPoolsSortOrderEnum
const (
ListBatchJobPoolsSortOrderAsc ListBatchJobPoolsSortOrderEnum = "ASC"
ListBatchJobPoolsSortOrderDesc ListBatchJobPoolsSortOrderEnum = "DESC"
)
func GetListBatchJobPoolsSortOrderEnumValues() []ListBatchJobPoolsSortOrderEnum
GetListBatchJobPoolsSortOrderEnumValues Enumerates the set of values for ListBatchJobPoolsSortOrderEnum
func GetMappingListBatchJobPoolsSortOrderEnum(val string) (ListBatchJobPoolsSortOrderEnum, bool)
GetMappingListBatchJobPoolsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchJobTasksRequest wrapper for the ListBatchJobTasks operation
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.
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 name of the task.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// 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
}
func (request ListBatchJobTasksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBatchJobTasksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBatchJobTasksRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBatchJobTasksRequest) String() string
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
ListBatchJobTasksResponse wrapper for the ListBatchJobTasks operation
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"`
}
func (response ListBatchJobTasksResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBatchJobTasksResponse) String() string
ListBatchJobTasksSortByEnum Enum with underlying type: string
type ListBatchJobTasksSortByEnum string
Set of constants representing the allowable values for ListBatchJobTasksSortByEnum
const (
ListBatchJobTasksSortByName ListBatchJobTasksSortByEnum = "name"
)
func GetListBatchJobTasksSortByEnumValues() []ListBatchJobTasksSortByEnum
GetListBatchJobTasksSortByEnumValues Enumerates the set of values for ListBatchJobTasksSortByEnum
func GetMappingListBatchJobTasksSortByEnum(val string) (ListBatchJobTasksSortByEnum, bool)
GetMappingListBatchJobTasksSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchJobTasksSortOrderEnum Enum with underlying type: string
type ListBatchJobTasksSortOrderEnum string
Set of constants representing the allowable values for ListBatchJobTasksSortOrderEnum
const (
ListBatchJobTasksSortOrderAsc ListBatchJobTasksSortOrderEnum = "ASC"
ListBatchJobTasksSortOrderDesc ListBatchJobTasksSortOrderEnum = "DESC"
)
func GetListBatchJobTasksSortOrderEnumValues() []ListBatchJobTasksSortOrderEnum
GetListBatchJobTasksSortOrderEnumValues Enumerates the set of values for ListBatchJobTasksSortOrderEnum
func GetMappingListBatchJobTasksSortOrderEnum(val string) (ListBatchJobTasksSortOrderEnum, bool)
GetMappingListBatchJobTasksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchJobsRequest wrapper for the ListBatchJobs operation
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.
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
}
func (request ListBatchJobsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBatchJobsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBatchJobsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBatchJobsRequest) String() string
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
ListBatchJobsResponse wrapper for the ListBatchJobs operation
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"`
}
func (response ListBatchJobsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBatchJobsResponse) String() string
ListBatchJobsSortByEnum Enum with underlying type: string
type ListBatchJobsSortByEnum string
Set of constants representing the allowable values for ListBatchJobsSortByEnum
const (
ListBatchJobsSortByTimecreated ListBatchJobsSortByEnum = "timeCreated"
ListBatchJobsSortByDisplayname ListBatchJobsSortByEnum = "displayName"
)
func GetListBatchJobsSortByEnumValues() []ListBatchJobsSortByEnum
GetListBatchJobsSortByEnumValues Enumerates the set of values for ListBatchJobsSortByEnum
func GetMappingListBatchJobsSortByEnum(val string) (ListBatchJobsSortByEnum, bool)
GetMappingListBatchJobsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchJobsSortOrderEnum Enum with underlying type: string
type ListBatchJobsSortOrderEnum string
Set of constants representing the allowable values for ListBatchJobsSortOrderEnum
const (
ListBatchJobsSortOrderAsc ListBatchJobsSortOrderEnum = "ASC"
ListBatchJobsSortOrderDesc ListBatchJobsSortOrderEnum = "DESC"
)
func GetListBatchJobsSortOrderEnumValues() []ListBatchJobsSortOrderEnum
GetListBatchJobsSortOrderEnumValues Enumerates the set of values for ListBatchJobsSortOrderEnum
func GetMappingListBatchJobsSortOrderEnum(val string) (ListBatchJobsSortOrderEnum, bool)
GetMappingListBatchJobsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchTaskEnvironmentsRequest wrapper for the ListBatchTaskEnvironments operation
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.
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
}
func (request ListBatchTaskEnvironmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBatchTaskEnvironmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBatchTaskEnvironmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBatchTaskEnvironmentsRequest) String() string
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
ListBatchTaskEnvironmentsResponse wrapper for the ListBatchTaskEnvironments operation
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"`
}
func (response ListBatchTaskEnvironmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBatchTaskEnvironmentsResponse) String() string
ListBatchTaskEnvironmentsSortByEnum Enum with underlying type: string
type ListBatchTaskEnvironmentsSortByEnum string
Set of constants representing the allowable values for ListBatchTaskEnvironmentsSortByEnum
const (
ListBatchTaskEnvironmentsSortByTimecreated ListBatchTaskEnvironmentsSortByEnum = "timeCreated"
ListBatchTaskEnvironmentsSortByDisplayname ListBatchTaskEnvironmentsSortByEnum = "displayName"
)
func GetListBatchTaskEnvironmentsSortByEnumValues() []ListBatchTaskEnvironmentsSortByEnum
GetListBatchTaskEnvironmentsSortByEnumValues Enumerates the set of values for ListBatchTaskEnvironmentsSortByEnum
func GetMappingListBatchTaskEnvironmentsSortByEnum(val string) (ListBatchTaskEnvironmentsSortByEnum, bool)
GetMappingListBatchTaskEnvironmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchTaskEnvironmentsSortOrderEnum Enum with underlying type: string
type ListBatchTaskEnvironmentsSortOrderEnum string
Set of constants representing the allowable values for ListBatchTaskEnvironmentsSortOrderEnum
const (
ListBatchTaskEnvironmentsSortOrderAsc ListBatchTaskEnvironmentsSortOrderEnum = "ASC"
ListBatchTaskEnvironmentsSortOrderDesc ListBatchTaskEnvironmentsSortOrderEnum = "DESC"
)
func GetListBatchTaskEnvironmentsSortOrderEnumValues() []ListBatchTaskEnvironmentsSortOrderEnum
GetListBatchTaskEnvironmentsSortOrderEnumValues Enumerates the set of values for ListBatchTaskEnvironmentsSortOrderEnum
func GetMappingListBatchTaskEnvironmentsSortOrderEnum(val string) (ListBatchTaskEnvironmentsSortOrderEnum, bool)
GetMappingListBatchTaskEnvironmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchTaskProfilesRequest wrapper for the ListBatchTaskProfiles operation
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.
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
}
func (request ListBatchTaskProfilesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBatchTaskProfilesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBatchTaskProfilesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBatchTaskProfilesRequest) String() string
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
ListBatchTaskProfilesResponse wrapper for the ListBatchTaskProfiles operation
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"`
}
func (response ListBatchTaskProfilesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBatchTaskProfilesResponse) String() string
ListBatchTaskProfilesSortByEnum Enum with underlying type: string
type ListBatchTaskProfilesSortByEnum string
Set of constants representing the allowable values for ListBatchTaskProfilesSortByEnum
const (
ListBatchTaskProfilesSortByTimecreated ListBatchTaskProfilesSortByEnum = "timeCreated"
ListBatchTaskProfilesSortByDisplayname ListBatchTaskProfilesSortByEnum = "displayName"
)
func GetListBatchTaskProfilesSortByEnumValues() []ListBatchTaskProfilesSortByEnum
GetListBatchTaskProfilesSortByEnumValues Enumerates the set of values for ListBatchTaskProfilesSortByEnum
func GetMappingListBatchTaskProfilesSortByEnum(val string) (ListBatchTaskProfilesSortByEnum, bool)
GetMappingListBatchTaskProfilesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchTaskProfilesSortOrderEnum Enum with underlying type: string
type ListBatchTaskProfilesSortOrderEnum string
Set of constants representing the allowable values for ListBatchTaskProfilesSortOrderEnum
const (
ListBatchTaskProfilesSortOrderAsc ListBatchTaskProfilesSortOrderEnum = "ASC"
ListBatchTaskProfilesSortOrderDesc ListBatchTaskProfilesSortOrderEnum = "DESC"
)
func GetListBatchTaskProfilesSortOrderEnumValues() []ListBatchTaskProfilesSortOrderEnum
GetListBatchTaskProfilesSortOrderEnumValues Enumerates the set of values for ListBatchTaskProfilesSortOrderEnum
func GetMappingListBatchTaskProfilesSortOrderEnum(val string) (ListBatchTaskProfilesSortOrderEnum, bool)
GetMappingListBatchTaskProfilesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchTasksRequest wrapper for the ListBatchTasks operation
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.
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 name of the task.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// 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
}
func (request ListBatchTasksRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBatchTasksRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBatchTasksRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBatchTasksRequest) String() string
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
ListBatchTasksResponse wrapper for the ListBatchTasks operation
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"`
}
func (response ListBatchTasksResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBatchTasksResponse) String() string
ListBatchTasksSortByEnum Enum with underlying type: string
type ListBatchTasksSortByEnum string
Set of constants representing the allowable values for ListBatchTasksSortByEnum
const (
ListBatchTasksSortByName ListBatchTasksSortByEnum = "name"
)
func GetListBatchTasksSortByEnumValues() []ListBatchTasksSortByEnum
GetListBatchTasksSortByEnumValues Enumerates the set of values for ListBatchTasksSortByEnum
func GetMappingListBatchTasksSortByEnum(val string) (ListBatchTasksSortByEnum, bool)
GetMappingListBatchTasksSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBatchTasksSortOrderEnum Enum with underlying type: string
type ListBatchTasksSortOrderEnum string
Set of constants representing the allowable values for ListBatchTasksSortOrderEnum
const (
ListBatchTasksSortOrderAsc ListBatchTasksSortOrderEnum = "ASC"
ListBatchTasksSortOrderDesc ListBatchTasksSortOrderEnum = "DESC"
)
func GetListBatchTasksSortOrderEnumValues() []ListBatchTasksSortOrderEnum
GetListBatchTasksSortOrderEnumValues Enumerates the set of values for ListBatchTasksSortOrderEnum
func GetMappingListBatchTasksSortOrderEnum(val string) (ListBatchTasksSortOrderEnum, bool)
GetMappingListBatchTasksSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
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.
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
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
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
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
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"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestErrorsSortByEnum Enum with underlying type: string
type ListWorkRequestErrorsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortByEnum
const (
ListWorkRequestErrorsSortByTimecreated ListWorkRequestErrorsSortByEnum = "timeCreated"
)
func GetListWorkRequestErrorsSortByEnumValues() []ListWorkRequestErrorsSortByEnum
GetListWorkRequestErrorsSortByEnumValues Enumerates the set of values for ListWorkRequestErrorsSortByEnum
func GetMappingListWorkRequestErrorsSortByEnum(val string) (ListWorkRequestErrorsSortByEnum, bool)
GetMappingListWorkRequestErrorsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsSortOrderEnum Enum with underlying type: string
type ListWorkRequestErrorsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestErrorsSortOrderEnum
const (
ListWorkRequestErrorsSortOrderAsc ListWorkRequestErrorsSortOrderEnum = "ASC"
ListWorkRequestErrorsSortOrderDesc ListWorkRequestErrorsSortOrderEnum = "DESC"
)
func GetListWorkRequestErrorsSortOrderEnumValues() []ListWorkRequestErrorsSortOrderEnum
GetListWorkRequestErrorsSortOrderEnumValues Enumerates the set of values for ListWorkRequestErrorsSortOrderEnum
func GetMappingListWorkRequestErrorsSortOrderEnum(val string) (ListWorkRequestErrorsSortOrderEnum, bool)
GetMappingListWorkRequestErrorsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
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.
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
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
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
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
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"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestLogsSortByEnum Enum with underlying type: string
type ListWorkRequestLogsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortByEnum
const (
ListWorkRequestLogsSortByTimecreated ListWorkRequestLogsSortByEnum = "timeCreated"
)
func GetListWorkRequestLogsSortByEnumValues() []ListWorkRequestLogsSortByEnum
GetListWorkRequestLogsSortByEnumValues Enumerates the set of values for ListWorkRequestLogsSortByEnum
func GetMappingListWorkRequestLogsSortByEnum(val string) (ListWorkRequestLogsSortByEnum, bool)
GetMappingListWorkRequestLogsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestLogsSortOrderEnum Enum with underlying type: string
type ListWorkRequestLogsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestLogsSortOrderEnum
const (
ListWorkRequestLogsSortOrderAsc ListWorkRequestLogsSortOrderEnum = "ASC"
ListWorkRequestLogsSortOrderDesc ListWorkRequestLogsSortOrderEnum = "DESC"
)
func GetListWorkRequestLogsSortOrderEnumValues() []ListWorkRequestLogsSortOrderEnum
GetListWorkRequestLogsSortOrderEnumValues Enumerates the set of values for ListWorkRequestLogsSortOrderEnum
func GetMappingListWorkRequestLogsSortOrderEnum(val string) (ListWorkRequestLogsSortOrderEnum, bool)
GetMappingListWorkRequestLogsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
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.
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
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
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
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
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"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ListWorkRequestsSortByEnum Enum with underlying type: string
type ListWorkRequestsSortByEnum string
Set of constants representing the allowable values for ListWorkRequestsSortByEnum
const (
ListWorkRequestsSortByTimeaccepted ListWorkRequestsSortByEnum = "timeAccepted"
)
func GetListWorkRequestsSortByEnumValues() []ListWorkRequestsSortByEnum
GetListWorkRequestsSortByEnumValues Enumerates the set of values for ListWorkRequestsSortByEnum
func GetMappingListWorkRequestsSortByEnum(val string) (ListWorkRequestsSortByEnum, bool)
GetMappingListWorkRequestsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsSortOrderEnum Enum with underlying type: string
type ListWorkRequestsSortOrderEnum string
Set of constants representing the allowable values for ListWorkRequestsSortOrderEnum
const (
ListWorkRequestsSortOrderAsc ListWorkRequestsSortOrderEnum = "ASC"
ListWorkRequestsSortOrderDesc ListWorkRequestsSortOrderEnum = "DESC"
)
func GetListWorkRequestsSortOrderEnumValues() []ListWorkRequestsSortOrderEnum
GetListWorkRequestsSortOrderEnumValues Enumerates the set of values for ListWorkRequestsSortOrderEnum
func GetMappingListWorkRequestsSortOrderEnum(val string) (ListWorkRequestsSortOrderEnum, bool)
GetMappingListWorkRequestsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestsStatusEnum Enum with underlying type: string
type ListWorkRequestsStatusEnum string
Set of constants representing the allowable values for ListWorkRequestsStatusEnum
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"
)
func GetListWorkRequestsStatusEnumValues() []ListWorkRequestsStatusEnum
GetListWorkRequestsStatusEnumValues Enumerates the set of values for ListWorkRequestsStatusEnum
func GetMappingListWorkRequestsStatusEnum(val string) (ListWorkRequestsStatusEnum, bool)
GetMappingListWorkRequestsStatusEnum performs case Insensitive comparison on enum value and return the desired enum
LoggingConfiguration Logging configuration for batch context.
type LoggingConfiguration interface {
}
LoggingConfigurationTypeEnum Enum with underlying type: string
type LoggingConfigurationTypeEnum string
Set of constants representing the allowable values for LoggingConfigurationTypeEnum
const (
LoggingConfigurationTypeOciLogging LoggingConfigurationTypeEnum = "OCI_LOGGING"
)
func GetLoggingConfigurationTypeEnumValues() []LoggingConfigurationTypeEnum
GetLoggingConfigurationTypeEnumValues Enumerates the set of values for LoggingConfigurationTypeEnum
func GetMappingLoggingConfigurationTypeEnum(val string) (LoggingConfigurationTypeEnum, bool)
GetMappingLoggingConfigurationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Network Network configuration of the batch context.
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"`
}
func (m Network) String() string
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
NetworkSecurityGroup VirtualNetwork service NetworkSecurityGroup
type NetworkSecurityGroup struct {
}
func (m NetworkSecurityGroup) String() string
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
NfsVolume A description of a NFS type of batch task environment volume.
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"`
}
func (m NfsVolume) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m NfsVolume) String() string
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
OciLoggingConfiguration Logging configuration for OCI Logging service.
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"`
}
func (m OciLoggingConfiguration) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m OciLoggingConfiguration) String() string
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
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
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"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
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"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PauseBatchJobDetails Information needed to pause the batch job.
type PauseBatchJobDetails struct {
}
func (m PauseBatchJobDetails) String() string
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
PauseBatchJobRequest wrapper for the PauseBatchJob operation
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.
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
}
func (request PauseBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request PauseBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request PauseBatchJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request PauseBatchJobRequest) String() string
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
PauseBatchJobResponse wrapper for the PauseBatchJob operation
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"`
}
func (response PauseBatchJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response PauseBatchJobResponse) String() string
PrivateIp VirtualNetwork service PrivateIp
type PrivateIp struct {
}
func (m PrivateIp) String() string
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
SecurityContext Security context for container runtime configuration. See also docs (https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/datatypes/LinuxSecurityContext).
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"`
}
func (m SecurityContext) String() string
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
ServiceManagedFleet Service managed Fleet configuration of the batch context.
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 manage fleet configuration in more detail.
Details *string `mandatory:"false" json:"details"`
}
func (m ServiceManagedFleet) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ServiceManagedFleet) String() string
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
ShapeMemoryOptions The amount of memory available for container instances that use this shape.
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"`
}
func (m ShapeMemoryOptions) String() string
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
ShapeNetworkingBandwidthOptions For a flexible shape, the amount of networking bandwidth available for container instances that use this shape.
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"`
}
func (m ShapeNetworkingBandwidthOptions) String() string
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
ShapeOcpuOptions For a flexible shape, the number of OCPUs available for container instances that use this shape.
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"`
}
func (m ShapeOcpuOptions) String() string
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
SortByEnum Enum with underlying type: string
type SortByEnum string
Set of constants representing the allowable values for SortByEnum
const (
SortByTimeCreated SortByEnum = "timeCreated"
SortByDisplayName SortByEnum = "displayName"
)
func GetMappingSortByEnum(val string) (SortByEnum, bool)
GetMappingSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortByEnumValues() []SortByEnum
GetSortByEnumValues Enumerates the set of values for SortByEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
StartBatchContextDetails Information needed to start the batch context.
type StartBatchContextDetails struct {
}
func (m StartBatchContextDetails) String() string
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
StartBatchContextRequest wrapper for the StartBatchContext operation
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.
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
}
func (request StartBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartBatchContextRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartBatchContextRequest) String() string
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
StartBatchContextResponse wrapper for the StartBatchContext operation
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"`
}
func (response StartBatchContextResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartBatchContextResponse) String() string
StartBatchJobPoolDetails Information needed to start the batch job pool.
type StartBatchJobPoolDetails struct {
}
func (m StartBatchJobPoolDetails) String() string
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
StartBatchJobPoolRequest wrapper for the StartBatchJobPool operation
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.
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
}
func (request StartBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StartBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StartBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StartBatchJobPoolRequest) String() string
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
StartBatchJobPoolResponse wrapper for the StartBatchJobPool operation
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"`
}
func (response StartBatchJobPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StartBatchJobPoolResponse) String() string
StopBatchContextDetails Information needed to stop the batch context.
type StopBatchContextDetails struct {
}
func (m StopBatchContextDetails) String() string
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
StopBatchContextRequest wrapper for the StopBatchContext operation
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.
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
}
func (request StopBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopBatchContextRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopBatchContextRequest) String() string
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
StopBatchContextResponse wrapper for the StopBatchContext operation
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"`
}
func (response StopBatchContextResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopBatchContextResponse) String() string
StopBatchJobPoolDetails Information needed to stop the batch job pool.
type StopBatchJobPoolDetails struct {
}
func (m StopBatchJobPoolDetails) String() string
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
StopBatchJobPoolRequest wrapper for the StopBatchJobPool operation
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.
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
}
func (request StopBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request StopBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request StopBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request StopBatchJobPoolRequest) String() string
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
StopBatchJobPoolResponse wrapper for the StopBatchJobPool operation
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"`
}
func (response StopBatchJobPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response StopBatchJobPoolResponse) String() string
Subnet VirtualNetwork service Subnet
type Subnet struct {
}
func (m Subnet) String() string
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
UnpauseBatchJobDetails Information needed to unpause the batch job.
type UnpauseBatchJobDetails struct {
}
func (m UnpauseBatchJobDetails) String() string
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
UnpauseBatchJobRequest wrapper for the UnpauseBatchJob operation
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.
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
}
func (request UnpauseBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UnpauseBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UnpauseBatchJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UnpauseBatchJobRequest) String() string
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
UnpauseBatchJobResponse wrapper for the UnpauseBatchJob operation
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"`
}
func (response UnpauseBatchJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UnpauseBatchJobResponse) String() string
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.
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"`
}
func (m UpdateBatchContextDetails) String() string
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
UpdateBatchContextRequest wrapper for the UpdateBatchContext operation
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.
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
}
func (request UpdateBatchContextRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBatchContextRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBatchContextRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBatchContextRequest) String() string
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
UpdateBatchContextResponse wrapper for the UpdateBatchContext operation
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"`
}
func (response UpdateBatchContextResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBatchContextResponse) String() string
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.
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"`
}
func (m UpdateBatchJobDetails) String() string
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
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.
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"`
}
func (m UpdateBatchJobPoolDetails) String() string
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
UpdateBatchJobPoolRequest wrapper for the UpdateBatchJobPool operation
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.
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
}
func (request UpdateBatchJobPoolRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBatchJobPoolRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBatchJobPoolRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBatchJobPoolRequest) String() string
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
UpdateBatchJobPoolResponse wrapper for the UpdateBatchJobPool operation
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"`
}
func (response UpdateBatchJobPoolResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBatchJobPoolResponse) String() string
UpdateBatchJobRequest wrapper for the UpdateBatchJob operation
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.
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
}
func (request UpdateBatchJobRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBatchJobRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBatchJobRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBatchJobRequest) String() string
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
UpdateBatchJobResponse wrapper for the UpdateBatchJob operation
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"`
}
func (response UpdateBatchJobResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBatchJobResponse) String() string
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.
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"`
}
func (m UpdateBatchTaskEnvironmentDetails) String() string
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
UpdateBatchTaskEnvironmentRequest wrapper for the UpdateBatchTaskEnvironment operation
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.
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
}
func (request UpdateBatchTaskEnvironmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBatchTaskEnvironmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBatchTaskEnvironmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBatchTaskEnvironmentRequest) String() string
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
UpdateBatchTaskEnvironmentResponse wrapper for the UpdateBatchTaskEnvironment operation
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"`
}
func (response UpdateBatchTaskEnvironmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBatchTaskEnvironmentResponse) String() string
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.
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"`
}
func (m UpdateBatchTaskProfileDetails) String() string
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
UpdateBatchTaskProfileRequest wrapper for the UpdateBatchTaskProfile operation
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.
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
}
func (request UpdateBatchTaskProfileRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBatchTaskProfileRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBatchTaskProfileRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBatchTaskProfileRequest) String() string
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
UpdateBatchTaskProfileResponse wrapper for the UpdateBatchTaskProfile operation
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"`
}
func (response UpdateBatchTaskProfileResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBatchTaskProfileResponse) String() string
VirtualNetworkVnic VirtualNetwork service Vnic
type VirtualNetworkVnic struct {
}
func (m VirtualNetworkVnic) String() string
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
Vnic Private endpoint's 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"`
}
func (m Vnic) String() string
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
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.
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"`
}
func (m WorkRequest) String() string
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
WorkRequestError An error encountered while performing an operation that is tracked by a work request.
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"`
}
func (m WorkRequestError) String() string
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
WorkRequestErrorCollection A list of work request errors. Can contain both errors and other information, such as metadata.
type WorkRequestErrorCollection struct {
// A list of work request errors.
Items []WorkRequestError `mandatory:"true" json:"items"`
}
func (m WorkRequestErrorCollection) String() string
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
WorkRequestLogAndErrorSortByEnum Enum with underlying type: string
type WorkRequestLogAndErrorSortByEnum string
Set of constants representing the allowable values for WorkRequestLogAndErrorSortByEnum
const (
WorkRequestLogAndErrorSortByTimeCreated WorkRequestLogAndErrorSortByEnum = "timeCreated"
)
func GetMappingWorkRequestLogAndErrorSortByEnum(val string) (WorkRequestLogAndErrorSortByEnum, bool)
GetMappingWorkRequestLogAndErrorSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestLogAndErrorSortByEnumValues() []WorkRequestLogAndErrorSortByEnum
GetWorkRequestLogAndErrorSortByEnumValues Enumerates the set of values for WorkRequestLogAndErrorSortByEnum
WorkRequestLogEntry A log message from performing an operation that is tracked by a work request.
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"`
}
func (m WorkRequestLogEntry) String() string
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
WorkRequestLogEntryCollection A list of work request logs. Can contain both logs and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// A list of work request log entries.
Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}
func (m WorkRequestLogEntryCollection) String() string
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
WorkRequestResource A resource created or operated on by a work request.
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"`
}
func (m WorkRequestResource) String() string
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
WorkRequestResourceMetadataKeyEnum Enum with underlying type: string
type WorkRequestResourceMetadataKeyEnum string
Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum
const (
WorkRequestResourceMetadataKeyIsDryRun WorkRequestResourceMetadataKeyEnum = "IS_DRY_RUN"
)
func GetMappingWorkRequestResourceMetadataKeyEnum(val string) (WorkRequestResourceMetadataKeyEnum, bool)
GetMappingWorkRequestResourceMetadataKeyEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum
GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum
WorkRequestSortByEnum Enum with underlying type: string
type WorkRequestSortByEnum string
Set of constants representing the allowable values for WorkRequestSortByEnum
const (
WorkRequestSortByTimeAccepted WorkRequestSortByEnum = "timeAccepted"
)
func GetMappingWorkRequestSortByEnum(val string) (WorkRequestSortByEnum, bool)
GetMappingWorkRequestSortByEnum performs case Insensitive comparison on enum value and return the desired enum
func GetWorkRequestSortByEnumValues() []WorkRequestSortByEnum
GetWorkRequestSortByEnumValues Enumerates the set of values for WorkRequestSortByEnum
WorkRequestSummary Summary information about an asynchronous work request.
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"`
}
func (m WorkRequestSummary) String() string
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
WorkRequestSummaryCollection A list of work requests. Can contain both work requests and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// A list of work requests.
Items []WorkRequestSummary `mandatory:"true" json:"items"`
}
func (m WorkRequestSummaryCollection) String() string
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