func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetDatasetFormatDetailsFormatTypeEnumStringValues() []string
GetDatasetFormatDetailsFormatTypeEnumStringValues Enumerates the set of values in String for DatasetFormatDetailsFormatTypeEnum
func GetDatasetLifecycleStateEnumStringValues() []string
GetDatasetLifecycleStateEnumStringValues Enumerates the set of values in String for DatasetLifecycleStateEnum
func GetDatasetLifecycleSubstateEnumStringValues() []string
GetDatasetLifecycleSubstateEnumStringValues Enumerates the set of values in String for DatasetLifecycleSubstateEnum
func GetDatasetSourceDetailsSourceTypeEnumStringValues() []string
GetDatasetSourceDetailsSourceTypeEnumStringValues Enumerates the set of values in String for DatasetSourceDetailsSourceTypeEnum
func GetExportFormatNameEnumStringValues() []string
GetExportFormatNameEnumStringValues Enumerates the set of values in String for ExportFormatNameEnum
func GetExportFormatVersionEnumStringValues() []string
GetExportFormatVersionEnumStringValues Enumerates the set of values in String for ExportFormatVersionEnum
func GetImportFormatNameEnumStringValues() []string
GetImportFormatNameEnumStringValues Enumerates the set of values in String for ImportFormatNameEnum
func GetImportFormatVersionEnumStringValues() []string
GetImportFormatVersionEnumStringValues Enumerates the set of values in String for ImportFormatVersionEnum
func GetImportMetadataPathSourceTypeEnumStringValues() []string
GetImportMetadataPathSourceTypeEnumStringValues Enumerates the set of values in String for ImportMetadataPathSourceTypeEnum
func GetListAnnotationFormatsSortOrderEnumStringValues() []string
GetListAnnotationFormatsSortOrderEnumStringValues Enumerates the set of values in String for ListAnnotationFormatsSortOrderEnum
func GetListDatasetsSortByEnumStringValues() []string
GetListDatasetsSortByEnumStringValues Enumerates the set of values in String for ListDatasetsSortByEnum
func GetListDatasetsSortOrderEnumStringValues() []string
GetListDatasetsSortOrderEnumStringValues Enumerates the set of values in String for ListDatasetsSortOrderEnum
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 GetSnapshotExportDetailsExportTypeEnumStringValues() []string
GetSnapshotExportDetailsExportTypeEnumStringValues Enumerates the set of values in String for SnapshotExportDetailsExportTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
func GetTextFileTypeMetadataFormatTypeEnumStringValues() []string
GetTextFileTypeMetadataFormatTypeEnumStringValues Enumerates the set of values in String for TextFileTypeMetadataFormatTypeEnum
func GetWorkRequestResourceMetadataKeyEnumStringValues() []string
GetWorkRequestResourceMetadataKeyEnumStringValues Enumerates the set of values in String for WorkRequestResourceMetadataKeyEnum
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"
ActionTypeWritten ActionTypeEnum = "WRITTEN"
ActionTypeRelated ActionTypeEnum = "RELATED"
)
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
AddDatasetLabelsDetails Adds a subset of Labels to the Dataset's LabelSet. This LabelSet will be merged with the current Dataset's LabelSet. Requests with duplicate Labels will be rejected.
type AddDatasetLabelsDetails struct {
LabelSet *LabelSet `mandatory:"false" json:"labelSet"`
}
func (m AddDatasetLabelsDetails) String() string
func (m AddDatasetLabelsDetails) 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
AddDatasetLabelsRequest wrapper for the AddDatasetLabels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/AddDatasetLabels.go.html to see an example of how to use AddDatasetLabelsRequest.
type AddDatasetLabelsRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// Details for adding Labels to the LabelSet of the Dataset.
AddDatasetLabelsDetails `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 executing 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 purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// The client request ID for tracing.
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 AddDatasetLabelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request AddDatasetLabelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request AddDatasetLabelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request AddDatasetLabelsRequest) String() string
func (request AddDatasetLabelsRequest) 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
AddDatasetLabelsResponse wrapper for the AddDatasetLabels operation
type AddDatasetLabelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 AddDatasetLabelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response AddDatasetLabelsResponse) String() string
AnnotationFormat annotation format
type AnnotationFormat struct {
// A unique name for the target AnnotationFormat for the Dataset.
Name *string `mandatory:"true" json:"name"`
}
func (m AnnotationFormat) String() string
func (m AnnotationFormat) 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
AnnotationFormatCollection Collection of annotation formats.
type AnnotationFormatCollection struct {
// List of annotation formats.
Items []AnnotationFormatSummary `mandatory:"true" json:"items"`
}
func (m AnnotationFormatCollection) String() string
func (m AnnotationFormatCollection) 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
AnnotationFormatSummary annotation format summary
type AnnotationFormatSummary struct {
// A unique name for the target AnnotationFormat for the Dataset.
Name *string `mandatory:"true" json:"name"`
}
func (m AnnotationFormatSummary) String() string
func (m AnnotationFormatSummary) 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
ChangeDatasetCompartmentDetails The payload sent to the Change Dataset compartment operation.
type ChangeDatasetCompartmentDetails struct {
// The OCID of the compartment where the resource should be moved.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeDatasetCompartmentDetails) String() string
func (m ChangeDatasetCompartmentDetails) 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
ChangeDatasetCompartmentRequest wrapper for the ChangeDatasetCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ChangeDatasetCompartment.go.html to see an example of how to use ChangeDatasetCompartmentRequest.
type ChangeDatasetCompartmentRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// Details for changing the compartment of a Dataset
ChangeDatasetCompartmentDetails `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"`
// The client request ID for tracing.
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 ChangeDatasetCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeDatasetCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeDatasetCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeDatasetCompartmentRequest) String() string
func (request ChangeDatasetCompartmentRequest) 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
ChangeDatasetCompartmentResponse wrapper for the ChangeDatasetCompartment operation
type ChangeDatasetCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 ChangeDatasetCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeDatasetCompartmentResponse) String() string
CreateDatasetDetails Parameters needed to create a new Dataset. A Dataset allows a user to describe the data source that provides the Records and how Annotations should be applied to the Records.
type CreateDatasetDetails struct {
// The OCID of the compartment of the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The annotation format name required for labeling records.
AnnotationFormat *string `mandatory:"true" json:"annotationFormat"`
DatasetSourceDetails DatasetSourceDetails `mandatory:"true" json:"datasetSourceDetails"`
DatasetFormatDetails DatasetFormatDetails `mandatory:"true" json:"datasetFormatDetails"`
LabelSet *LabelSet `mandatory:"true" json:"labelSet"`
// A user-friendly display name for the resource.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user provided description of the dataset
Description *string `mandatory:"false" json:"description"`
InitialRecordGenerationConfiguration *InitialRecordGenerationConfiguration `mandatory:"false" json:"initialRecordGenerationConfiguration"`
InitialImportDatasetConfiguration *InitialImportDatasetConfiguration `mandatory:"false" json:"initialImportDatasetConfiguration"`
// The labeling instructions for human labelers in rich text format
LabelingInstructions *string `mandatory:"false" json:"labelingInstructions"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateDatasetDetails) String() string
func (m *CreateDatasetDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateDatasetDetails) 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
CreateDatasetRequest wrapper for the CreateDataset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/CreateDataset.go.html to see an example of how to use CreateDatasetRequest.
type CreateDatasetRequest struct {
// Details for the new Dataset.
CreateDatasetDetails `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 executing 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 purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
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 CreateDatasetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateDatasetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateDatasetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateDatasetRequest) String() string
func (request CreateDatasetRequest) 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
CreateDatasetResponse wrapper for the CreateDataset operation
type CreateDatasetResponse struct {
// The underlying http response
RawResponse *http.Response
// The Dataset instance
Dataset `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// The URI that identifies the entity described in the response body.
Location *string `presentIn:"header" name:"location"`
// The URI that identifies the entity described in the response body.
ContentLocation *string `presentIn:"header" name:"content-location"`
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 CreateDatasetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateDatasetResponse) String() string
DataLabelingManagementClient a client for DataLabelingManagement
type DataLabelingManagementClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewDataLabelingManagementClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DataLabelingManagementClient, err error)
NewDataLabelingManagementClientWithConfigurationProvider Creates a new default DataLabelingManagement client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewDataLabelingManagementClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DataLabelingManagementClient, err error)
NewDataLabelingManagementClientWithOboToken Creates a new default DataLabelingManagement 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 DataLabelingManagementClient) AddDatasetLabels(ctx context.Context, request AddDatasetLabelsRequest) (response AddDatasetLabelsResponse, err error)
AddDatasetLabels Add Labels to the Dataset LabelSet until the maximum number of Labels has been reached.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/AddDatasetLabels.go.html to see an example of how to use AddDatasetLabels API. A default retry strategy applies to this operation AddDatasetLabels()
func (client DataLabelingManagementClient) ChangeDatasetCompartment(ctx context.Context, request ChangeDatasetCompartmentRequest) (response ChangeDatasetCompartmentResponse, err error)
ChangeDatasetCompartment Moves a Dataset resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ChangeDatasetCompartment.go.html to see an example of how to use ChangeDatasetCompartment API. A default retry strategy applies to this operation ChangeDatasetCompartment()
func (client *DataLabelingManagementClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client DataLabelingManagementClient) CreateDataset(ctx context.Context, request CreateDatasetRequest) (response CreateDatasetResponse, err error)
CreateDataset Creates a new Dataset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/CreateDataset.go.html to see an example of how to use CreateDataset API. A default retry strategy applies to this operation CreateDataset()
func (client DataLabelingManagementClient) DeleteDataset(ctx context.Context, request DeleteDatasetRequest) (response DeleteDatasetResponse, err error)
DeleteDataset Deletes a Dataset resource by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/DeleteDataset.go.html to see an example of how to use DeleteDataset API. A default retry strategy applies to this operation DeleteDataset()
func (client DataLabelingManagementClient) GenerateDatasetRecords(ctx context.Context, request GenerateDatasetRecordsRequest) (response GenerateDatasetRecordsResponse, err error)
GenerateDatasetRecords Generates Record resources from the Dataset's data source
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GenerateDatasetRecords.go.html to see an example of how to use GenerateDatasetRecords API. A default retry strategy applies to this operation GenerateDatasetRecords()
func (client DataLabelingManagementClient) GetDataset(ctx context.Context, request GetDatasetRequest) (response GetDatasetResponse, err error)
GetDataset Gets a Dataset by identifier
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GetDataset.go.html to see an example of how to use GetDataset API. A default retry strategy applies to this operation GetDataset()
func (client DataLabelingManagementClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API. A default retry strategy applies to this operation GetWorkRequest()
func (client DataLabelingManagementClient) ImportPreAnnotatedData(ctx context.Context, request ImportPreAnnotatedDataRequest) (response ImportPreAnnotatedDataResponse, err error)
ImportPreAnnotatedData Imports records and annotations from dataset files into existing Dataset.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ImportPreAnnotatedData.go.html to see an example of how to use ImportPreAnnotatedData API. A default retry strategy applies to this operation ImportPreAnnotatedData()
func (client DataLabelingManagementClient) ListAnnotationFormats(ctx context.Context, request ListAnnotationFormatsRequest) (response ListAnnotationFormatsResponse, err error)
ListAnnotationFormats These are a static list in a given region.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListAnnotationFormats.go.html to see an example of how to use ListAnnotationFormats API. A default retry strategy applies to this operation ListAnnotationFormats()
func (client DataLabelingManagementClient) ListDatasets(ctx context.Context, request ListDatasetsRequest) (response ListDatasetsResponse, err error)
ListDatasets Returns a list of Datasets.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListDatasets.go.html to see an example of how to use ListDatasets API. A default retry strategy applies to this operation ListDatasets()
func (client DataLabelingManagementClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API. A default retry strategy applies to this operation ListWorkRequestErrors()
func (client DataLabelingManagementClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API. A default retry strategy applies to this operation ListWorkRequestLogs()
func (client DataLabelingManagementClient) 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/datalabelingservice/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API. A default retry strategy applies to this operation ListWorkRequests()
func (client DataLabelingManagementClient) RemoveDatasetLabels(ctx context.Context, request RemoveDatasetLabelsRequest) (response RemoveDatasetLabelsResponse, err error)
RemoveDatasetLabels Removes the labels from the Dataset Labelset. Labels can only be removed if there are no Annotations associated with the Dataset that reference the Label names.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/RemoveDatasetLabels.go.html to see an example of how to use RemoveDatasetLabels API. A default retry strategy applies to this operation RemoveDatasetLabels()
func (client DataLabelingManagementClient) RenameDatasetLabels(ctx context.Context, request RenameDatasetLabelsRequest) (response RenameDatasetLabelsResponse, err error)
RenameDatasetLabels Renames the labels from the Dataset Labelset. Labels that are renamed will be reflected in Annotations associated with the Dataset that reference the Label names.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/RenameDatasetLabels.go.html to see an example of how to use RenameDatasetLabels API. A default retry strategy applies to this operation RenameDatasetLabels()
func (client *DataLabelingManagementClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client DataLabelingManagementClient) SnapshotDataset(ctx context.Context, request SnapshotDatasetRequest) (response SnapshotDatasetResponse, err error)
SnapshotDataset Writes the dataset records and annotations in a consolidated format out to an object storage reference for consumption. While the snapshot takes place, there may be a time while records and annotations cannot be created to ensure the snapshot is a point in time.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/SnapshotDataset.go.html to see an example of how to use SnapshotDataset API. A default retry strategy applies to this operation SnapshotDataset()
func (client DataLabelingManagementClient) UpdateDataset(ctx context.Context, request UpdateDatasetRequest) (response UpdateDatasetResponse, err error)
UpdateDataset Updates the Dataset
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/UpdateDataset.go.html to see an example of how to use UpdateDataset API. A default retry strategy applies to this operation UpdateDataset()
Dataset A dataset is a logical collection of records. The dataset contains all the information necessary to describe a record's source, format, type of annotations allowed on these records, and labels allowed on annotations.
type Dataset struct {
// The OCID of the Dataset.
Id *string `mandatory:"true" json:"id"`
// The OCID of the compartment of the resource.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The date and time the resource was created, in the timestamp format defined by RFC3339.
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the resource was last updated, in the timestamp format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The state of a dataset.
// CREATING - The dataset is being created. It will transition to ACTIVE when it is ready for labeling.
// ACTIVE - The dataset is ready for labeling.
// UPDATING - The dataset is being updated. It and its related resources may be unavailable for other updates until it returns to ACTIVE.
// NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention.
// DELETING - The dataset and its related resources are being deleted.
// DELETED - The dataset has been deleted and is no longer available.
// FAILED - The dataset has failed due to validation or other errors.
LifecycleState DatasetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The annotation format name required for labeling records.
AnnotationFormat *string `mandatory:"true" json:"annotationFormat"`
DatasetSourceDetails DatasetSourceDetails `mandatory:"true" json:"datasetSourceDetails"`
DatasetFormatDetails DatasetFormatDetails `mandatory:"true" json:"datasetFormatDetails"`
LabelSet *LabelSet `mandatory:"true" json:"labelSet"`
// A user-friendly display name for the resource.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user provided description of the dataset
Description *string `mandatory:"false" json:"description"`
// A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// The sub-state of the dataset.
// IMPORT_DATASET - The dataset is being imported.
LifecycleSubstate DatasetLifecycleSubstateEnum `mandatory:"false" json:"lifecycleSubstate,omitempty"`
InitialRecordGenerationConfiguration *InitialRecordGenerationConfiguration `mandatory:"false" json:"initialRecordGenerationConfiguration"`
InitialImportDatasetConfiguration *InitialImportDatasetConfiguration `mandatory:"false" json:"initialImportDatasetConfiguration"`
// The labeling instructions for human labelers in rich text format
LabelingInstructions *string `mandatory:"false" json:"labelingInstructions"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The usage of system tag keys. These predefined keys are scoped to namespaces.
// For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
AdditionalProperties map[string]string `mandatory:"false" json:"additionalProperties"`
}
func (m Dataset) String() string
func (m *Dataset) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Dataset) 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
DatasetCollection Results of a dataset list operation. Contains DatasetSummary items.
type DatasetCollection struct {
// List of datasets.
Items []DatasetSummary `mandatory:"true" json:"items"`
}
func (m DatasetCollection) String() string
func (m DatasetCollection) 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
DatasetFormatDetails It specifies how to process the data. Supported formats include DOCUMENT, IMAGE, and TEXT.
type DatasetFormatDetails interface {
}
DatasetFormatDetailsFormatTypeEnum Enum with underlying type: string
type DatasetFormatDetailsFormatTypeEnum string
Set of constants representing the allowable values for DatasetFormatDetailsFormatTypeEnum
const (
DatasetFormatDetailsFormatTypeDocument DatasetFormatDetailsFormatTypeEnum = "DOCUMENT"
DatasetFormatDetailsFormatTypeImage DatasetFormatDetailsFormatTypeEnum = "IMAGE"
DatasetFormatDetailsFormatTypeText DatasetFormatDetailsFormatTypeEnum = "TEXT"
)
func GetDatasetFormatDetailsFormatTypeEnumValues() []DatasetFormatDetailsFormatTypeEnum
GetDatasetFormatDetailsFormatTypeEnumValues Enumerates the set of values for DatasetFormatDetailsFormatTypeEnum
func GetMappingDatasetFormatDetailsFormatTypeEnum(val string) (DatasetFormatDetailsFormatTypeEnum, bool)
GetMappingDatasetFormatDetailsFormatTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DatasetLifecycleStateEnum Enum with underlying type: string
type DatasetLifecycleStateEnum string
Set of constants representing the allowable values for DatasetLifecycleStateEnum
const (
DatasetLifecycleStateCreating DatasetLifecycleStateEnum = "CREATING"
DatasetLifecycleStateUpdating DatasetLifecycleStateEnum = "UPDATING"
DatasetLifecycleStateActive DatasetLifecycleStateEnum = "ACTIVE"
DatasetLifecycleStateNeedsAttention DatasetLifecycleStateEnum = "NEEDS_ATTENTION"
DatasetLifecycleStateDeleting DatasetLifecycleStateEnum = "DELETING"
DatasetLifecycleStateDeleted DatasetLifecycleStateEnum = "DELETED"
DatasetLifecycleStateFailed DatasetLifecycleStateEnum = "FAILED"
)
func GetDatasetLifecycleStateEnumValues() []DatasetLifecycleStateEnum
GetDatasetLifecycleStateEnumValues Enumerates the set of values for DatasetLifecycleStateEnum
func GetMappingDatasetLifecycleStateEnum(val string) (DatasetLifecycleStateEnum, bool)
GetMappingDatasetLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
DatasetLifecycleSubstateEnum Enum with underlying type: string
type DatasetLifecycleSubstateEnum string
Set of constants representing the allowable values for DatasetLifecycleSubstateEnum
const (
DatasetLifecycleSubstateImportDataset DatasetLifecycleSubstateEnum = "IMPORT_DATASET"
)
func GetDatasetLifecycleSubstateEnumValues() []DatasetLifecycleSubstateEnum
GetDatasetLifecycleSubstateEnumValues Enumerates the set of values for DatasetLifecycleSubstateEnum
func GetMappingDatasetLifecycleSubstateEnum(val string) (DatasetLifecycleSubstateEnum, bool)
GetMappingDatasetLifecycleSubstateEnum performs case Insensitive comparison on enum value and return the desired enum
DatasetSourceDetails This allows the customer to specify the source of the dataset.
type DatasetSourceDetails interface {
}
DatasetSourceDetailsSourceTypeEnum Enum with underlying type: string
type DatasetSourceDetailsSourceTypeEnum string
Set of constants representing the allowable values for DatasetSourceDetailsSourceTypeEnum
const (
DatasetSourceDetailsSourceTypeObjectStorage DatasetSourceDetailsSourceTypeEnum = "OBJECT_STORAGE"
)
func GetDatasetSourceDetailsSourceTypeEnumValues() []DatasetSourceDetailsSourceTypeEnum
GetDatasetSourceDetailsSourceTypeEnumValues Enumerates the set of values for DatasetSourceDetailsSourceTypeEnum
func GetMappingDatasetSourceDetailsSourceTypeEnum(val string) (DatasetSourceDetailsSourceTypeEnum, bool)
GetMappingDatasetSourceDetailsSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
DatasetSummary A dataset summary is the representation returned in list views. It is usually a subset of the full dataset entity and should not contain any potentially sensitive information.
type DatasetSummary struct {
// The OCID of the Dataset
Id *string `mandatory:"true" json:"id"`
// Compartment Identifier
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The time the the Dataset was created. An RFC3339 formatted datetime string
TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The date and time the resource was last updated, in the timestamp format defined by RFC3339.
TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`
// The state of a Dataset.
LifecycleState DatasetLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The annotation format name required for labeling records.
AnnotationFormat *string `mandatory:"true" json:"annotationFormat"`
DatasetFormatDetails DatasetFormatDetails `mandatory:"true" json:"datasetFormatDetails"`
// A user-friendly display name for the resource.
DisplayName *string `mandatory:"false" json:"displayName"`
// A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// The usage of system tag keys. These predefined keys are scoped to namespaces.
// For example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m DatasetSummary) String() string
func (m *DatasetSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m DatasetSummary) 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
DeleteDatasetRequest wrapper for the DeleteDataset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/DeleteDataset.go.html to see an example of how to use DeleteDatasetRequest.
type DeleteDatasetRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// 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"`
// The client request ID for tracing.
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 DeleteDatasetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteDatasetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteDatasetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteDatasetRequest) String() string
func (request DeleteDatasetRequest) 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
DeleteDatasetResponse wrapper for the DeleteDataset operation
type DeleteDatasetResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 DeleteDatasetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteDatasetResponse) String() string
DelimitedFileTypeMetadata Metadata of delimited files.
type DelimitedFileTypeMetadata struct {
// The index of a selected column. This is a zero-based index.
ColumnIndex *int `mandatory:"true" json:"columnIndex"`
// The name of a selected column.
ColumnName *string `mandatory:"false" json:"columnName"`
// A column delimiter
ColumnDelimiter *string `mandatory:"false" json:"columnDelimiter"`
// A line delimiter.
LineDelimiter *string `mandatory:"false" json:"lineDelimiter"`
// An escape character.
EscapeCharacter *string `mandatory:"false" json:"escapeCharacter"`
}
func (m DelimitedFileTypeMetadata) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DelimitedFileTypeMetadata) String() string
func (m DelimitedFileTypeMetadata) 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
DocumentDatasetFormatDetails It indicates the dataset is comprised of document files. It is open for further configurability.
type DocumentDatasetFormatDetails struct {
}
func (m DocumentDatasetFormatDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DocumentDatasetFormatDetails) String() string
func (m DocumentDatasetFormatDetails) 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
ExportFormat Specifies the export format to be used for exporting snapshot.
type ExportFormat struct {
// Name of export format.
Name ExportFormatNameEnum `mandatory:"false" json:"name,omitempty"`
// Version of export format.
Version ExportFormatVersionEnum `mandatory:"false" json:"version,omitempty"`
}
func (m ExportFormat) String() string
func (m ExportFormat) 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
ExportFormatNameEnum Enum with underlying type: string
type ExportFormatNameEnum string
Set of constants representing the allowable values for ExportFormatNameEnum
const (
ExportFormatNameJsonl ExportFormatNameEnum = "JSONL"
ExportFormatNameJsonlConsolidated ExportFormatNameEnum = "JSONL_CONSOLIDATED"
ExportFormatNameConll ExportFormatNameEnum = "CONLL"
ExportFormatNameSpacy ExportFormatNameEnum = "SPACY"
ExportFormatNameCoco ExportFormatNameEnum = "COCO"
ExportFormatNameYolo ExportFormatNameEnum = "YOLO"
ExportFormatNamePascalVoc ExportFormatNameEnum = "PASCAL_VOC"
ExportFormatNameJsonlCompactPlusContent ExportFormatNameEnum = "JSONL_COMPACT_PLUS_CONTENT"
)
func GetExportFormatNameEnumValues() []ExportFormatNameEnum
GetExportFormatNameEnumValues Enumerates the set of values for ExportFormatNameEnum
func GetMappingExportFormatNameEnum(val string) (ExportFormatNameEnum, bool)
GetMappingExportFormatNameEnum performs case Insensitive comparison on enum value and return the desired enum
ExportFormatVersionEnum Enum with underlying type: string
type ExportFormatVersionEnum string
Set of constants representing the allowable values for ExportFormatVersionEnum
const (
ExportFormatVersionV2003 ExportFormatVersionEnum = "V2003"
ExportFormatVersionV5 ExportFormatVersionEnum = "V5"
)
func GetExportFormatVersionEnumValues() []ExportFormatVersionEnum
GetExportFormatVersionEnumValues Enumerates the set of values for ExportFormatVersionEnum
func GetMappingExportFormatVersionEnum(val string) (ExportFormatVersionEnum, bool)
GetMappingExportFormatVersionEnum performs case Insensitive comparison on enum value and return the desired enum
GenerateDatasetRecordsDetails Generate Records from the Dataset's source.
type GenerateDatasetRecordsDetails struct {
// the maximum number of records to generate.
Limit *float32 `mandatory:"false" json:"limit"`
}
func (m GenerateDatasetRecordsDetails) String() string
func (m GenerateDatasetRecordsDetails) 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
GenerateDatasetRecordsRequest wrapper for the GenerateDatasetRecords operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GenerateDatasetRecords.go.html to see an example of how to use GenerateDatasetRecordsRequest.
type GenerateDatasetRecordsRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// Details for generating Dataset records.
GenerateDatasetRecordsDetails `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 executing 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 purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// The client request ID for tracing.
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 GenerateDatasetRecordsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GenerateDatasetRecordsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GenerateDatasetRecordsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GenerateDatasetRecordsRequest) String() string
func (request GenerateDatasetRecordsRequest) 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
GenerateDatasetRecordsResponse wrapper for the GenerateDatasetRecords operation
type GenerateDatasetRecordsResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 GenerateDatasetRecordsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GenerateDatasetRecordsResponse) String() string
GetDatasetRequest wrapper for the GetDataset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GetDataset.go.html to see an example of how to use GetDatasetRequest.
type GetDatasetRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// The client request ID for tracing.
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 GetDatasetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetDatasetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetDatasetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetDatasetRequest) String() string
func (request GetDatasetRequest) 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
GetDatasetResponse wrapper for the GetDataset operation
type GetDatasetResponse struct {
// The underlying http response
RawResponse *http.Response
// The Dataset instance
Dataset `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A 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 GetDatasetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetDatasetResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
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"`
// A 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
ImageDatasetFormatDetails It indicates the dataset is comprised of images.
type ImageDatasetFormatDetails struct {
}
func (m ImageDatasetFormatDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ImageDatasetFormatDetails) String() string
func (m ImageDatasetFormatDetails) 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
ImportFormat File format details used for importing dataset
type ImportFormat struct {
// Name of import format
Name ImportFormatNameEnum `mandatory:"true" json:"name"`
// Version of import format
Version ImportFormatVersionEnum `mandatory:"false" json:"version,omitempty"`
}
func (m ImportFormat) String() string
func (m ImportFormat) 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
ImportFormatNameEnum Enum with underlying type: string
type ImportFormatNameEnum string
Set of constants representing the allowable values for ImportFormatNameEnum
const (
ImportFormatNameJsonlConsolidated ImportFormatNameEnum = "JSONL_CONSOLIDATED"
ImportFormatNameJsonlCompactPlusContent ImportFormatNameEnum = "JSONL_COMPACT_PLUS_CONTENT"
ImportFormatNameConll ImportFormatNameEnum = "CONLL"
ImportFormatNameSpacy ImportFormatNameEnum = "SPACY"
ImportFormatNameCoco ImportFormatNameEnum = "COCO"
ImportFormatNameYolo ImportFormatNameEnum = "YOLO"
ImportFormatNamePascalVoc ImportFormatNameEnum = "PASCAL_VOC"
)
func GetImportFormatNameEnumValues() []ImportFormatNameEnum
GetImportFormatNameEnumValues Enumerates the set of values for ImportFormatNameEnum
func GetMappingImportFormatNameEnum(val string) (ImportFormatNameEnum, bool)
GetMappingImportFormatNameEnum performs case Insensitive comparison on enum value and return the desired enum
ImportFormatVersionEnum Enum with underlying type: string
type ImportFormatVersionEnum string
Set of constants representing the allowable values for ImportFormatVersionEnum
const (
ImportFormatVersionV2003 ImportFormatVersionEnum = "V2003"
ImportFormatVersionV5 ImportFormatVersionEnum = "V5"
)
func GetImportFormatVersionEnumValues() []ImportFormatVersionEnum
GetImportFormatVersionEnumValues Enumerates the set of values for ImportFormatVersionEnum
func GetMappingImportFormatVersionEnum(val string) (ImportFormatVersionEnum, bool)
GetMappingImportFormatVersionEnum performs case Insensitive comparison on enum value and return the desired enum
ImportMetadataPath Object storage path for the metadata file
type ImportMetadataPath interface {
}
ImportMetadataPathSourceTypeEnum Enum with underlying type: string
type ImportMetadataPathSourceTypeEnum string
Set of constants representing the allowable values for ImportMetadataPathSourceTypeEnum
const (
ImportMetadataPathSourceTypeObjectStorage ImportMetadataPathSourceTypeEnum = "OBJECT_STORAGE"
)
func GetImportMetadataPathSourceTypeEnumValues() []ImportMetadataPathSourceTypeEnum
GetImportMetadataPathSourceTypeEnumValues Enumerates the set of values for ImportMetadataPathSourceTypeEnum
func GetMappingImportMetadataPathSourceTypeEnum(val string) (ImportMetadataPathSourceTypeEnum, bool)
GetMappingImportMetadataPathSourceTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ImportPreAnnotatedDataDetails Allows user to import dataset labels, records and annotations from dataset files
type ImportPreAnnotatedDataDetails struct {
ImportFormat *ImportFormat `mandatory:"false" json:"importFormat"`
ImportMetadataPath ImportMetadataPath `mandatory:"false" json:"importMetadataPath"`
}
func (m ImportPreAnnotatedDataDetails) String() string
func (m *ImportPreAnnotatedDataDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m ImportPreAnnotatedDataDetails) 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
ImportPreAnnotatedDataRequest wrapper for the ImportPreAnnotatedData operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ImportPreAnnotatedData.go.html to see an example of how to use ImportPreAnnotatedDataRequest.
type ImportPreAnnotatedDataRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// Details for importing Dataset
ImportPreAnnotatedDataDetails `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"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing 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 purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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 ImportPreAnnotatedDataRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ImportPreAnnotatedDataRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ImportPreAnnotatedDataRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ImportPreAnnotatedDataRequest) String() string
func (request ImportPreAnnotatedDataRequest) 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
ImportPreAnnotatedDataResponse wrapper for the ImportPreAnnotatedData operation
type ImportPreAnnotatedDataResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 ImportPreAnnotatedDataResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ImportPreAnnotatedDataResponse) String() string
InitialImportDatasetConfiguration Initial import dataset configuration. Allows user to create dataset from existing dataset files.
type InitialImportDatasetConfiguration struct {
ImportFormat *ImportFormat `mandatory:"true" json:"importFormat"`
ImportMetadataPath ImportMetadataPath `mandatory:"true" json:"importMetadataPath"`
}
func (m InitialImportDatasetConfiguration) String() string
func (m *InitialImportDatasetConfiguration) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m InitialImportDatasetConfiguration) 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
InitialRecordGenerationConfiguration The initial generate records configuration. It generates records from the dataset's source.
type InitialRecordGenerationConfiguration struct {
// The maximum number of records to generate.
Limit *float32 `mandatory:"false" json:"limit"`
}
func (m InitialRecordGenerationConfiguration) String() string
func (m InitialRecordGenerationConfiguration) 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
Label It represents a label.
type Label struct {
// An unique name for a label within its dataset.
Name *string `mandatory:"false" json:"name"`
}
func (m Label) String() string
func (m Label) 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
LabelSet An ordered collection of labels that are unique by name.
type LabelSet struct {
// An ordered collection of labels that are unique by name.
Items []Label `mandatory:"false" json:"items"`
}
func (m LabelSet) String() string
func (m LabelSet) 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
ListAnnotationFormatsRequest wrapper for the ListAnnotationFormats operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListAnnotationFormats.go.html to see an example of how to use ListAnnotationFormatsRequest.
type ListAnnotationFormatsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListAnnotationFormatsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The client request ID for tracing.
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 ListAnnotationFormatsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAnnotationFormatsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAnnotationFormatsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAnnotationFormatsRequest) String() string
func (request ListAnnotationFormatsRequest) 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
ListAnnotationFormatsResponse wrapper for the ListAnnotationFormats operation
type ListAnnotationFormatsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of AnnotationFormatCollection instances
AnnotationFormatCollection `presentIn:"body"`
// A 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 the pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListAnnotationFormatsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAnnotationFormatsResponse) String() string
ListAnnotationFormatsSortOrderEnum Enum with underlying type: string
type ListAnnotationFormatsSortOrderEnum string
Set of constants representing the allowable values for ListAnnotationFormatsSortOrderEnum
const (
ListAnnotationFormatsSortOrderAsc ListAnnotationFormatsSortOrderEnum = "ASC"
ListAnnotationFormatsSortOrderDesc ListAnnotationFormatsSortOrderEnum = "DESC"
)
func GetListAnnotationFormatsSortOrderEnumValues() []ListAnnotationFormatsSortOrderEnum
GetListAnnotationFormatsSortOrderEnumValues Enumerates the set of values for ListAnnotationFormatsSortOrderEnum
func GetMappingListAnnotationFormatsSortOrderEnum(val string) (ListAnnotationFormatsSortOrderEnum, bool)
GetMappingListAnnotationFormatsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListDatasetsRequest wrapper for the ListDatasets operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListDatasets.go.html to see an example of how to use ListDatasetsRequest.
type ListDatasetsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Dataset OCID
Id *string `mandatory:"false" contributesTo:"query" name:"id"`
// A filter to return only resources that match the entire annotation format given.
AnnotationFormat *string `mandatory:"false" contributesTo:"query" name:"annotationFormat"`
// A filter to return only resources whose lifecycleState matches this query param.
LifecycleState DatasetLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListDatasetsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListDatasetsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The client request ID for tracing.
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 ListDatasetsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListDatasetsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListDatasetsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListDatasetsRequest) String() string
func (request ListDatasetsRequest) 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
ListDatasetsResponse wrapper for the ListDatasets operation
type ListDatasetsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of DatasetCollection instances
DatasetCollection `presentIn:"body"`
// A 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 the pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListDatasetsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListDatasetsResponse) String() string
ListDatasetsSortByEnum Enum with underlying type: string
type ListDatasetsSortByEnum string
Set of constants representing the allowable values for ListDatasetsSortByEnum
const (
ListDatasetsSortByTimecreated ListDatasetsSortByEnum = "timeCreated"
ListDatasetsSortByDisplayname ListDatasetsSortByEnum = "displayName"
)
func GetListDatasetsSortByEnumValues() []ListDatasetsSortByEnum
GetListDatasetsSortByEnumValues Enumerates the set of values for ListDatasetsSortByEnum
func GetMappingListDatasetsSortByEnum(val string) (ListDatasetsSortByEnum, bool)
GetMappingListDatasetsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListDatasetsSortOrderEnum Enum with underlying type: string
type ListDatasetsSortOrderEnum string
Set of constants representing the allowable values for ListDatasetsSortOrderEnum
const (
ListDatasetsSortOrderAsc ListDatasetsSortOrderEnum = "ASC"
ListDatasetsSortOrderDesc ListDatasetsSortOrderEnum = "DESC"
)
func GetListDatasetsSortOrderEnumValues() []ListDatasetsSortOrderEnum
GetListDatasetsSortOrderEnumValues Enumerates the set of values for ListDatasetsSortOrderEnum
func GetMappingListDatasetsSortOrderEnum(val string) (ListDatasetsSortOrderEnum, bool)
GetMappingListDatasetsSortOrderEnum 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/datalabelingservice/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 the pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// A 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
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The ID of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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 the pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// A 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
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The ID of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The ID of the asynchronous work request.
WorkRequestId *string `mandatory:"false" contributesTo:"query" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// 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"`
// A 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 the pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ObjectStorageImportMetadataPath Object Storage details for import metadata path.
type ObjectStorageImportMetadataPath struct {
// Bucket namespace name
Namespace *string `mandatory:"true" json:"namespace"`
// Bucket name
Bucket *string `mandatory:"true" json:"bucket"`
// Path for the metadata file.
Path *string `mandatory:"true" json:"path"`
}
func (m ObjectStorageImportMetadataPath) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageImportMetadataPath) String() string
func (m ObjectStorageImportMetadataPath) 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
ObjectStorageSnapshotExportDetails Specifies where to output the export in Object Storage.
type ObjectStorageSnapshotExportDetails struct {
// Bucket namespace name
Namespace *string `mandatory:"true" json:"namespace"`
// Bucket name
Bucket *string `mandatory:"true" json:"bucket"`
// Object path prefix to put snapshot file(s)
Prefix *string `mandatory:"false" json:"prefix"`
}
func (m ObjectStorageSnapshotExportDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageSnapshotExportDetails) String() string
func (m ObjectStorageSnapshotExportDetails) 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
ObjectStorageSourceDetails Specifies the dataset location in object storage. This requires that all records are in this bucket, and under this prefix. We do not support a dataset with objects in arbitrary locations across buckets or prefixes.
type ObjectStorageSourceDetails struct {
// The namespace of the bucket that contains the dataset data source.
Namespace *string `mandatory:"true" json:"namespace"`
// The object storage bucket that contains the dataset data source.
Bucket *string `mandatory:"true" json:"bucket"`
// A common path prefix shared by the objects that make up the dataset. Except for the CSV file type, records are not generated for the objects whose names exactly match with the prefix.
Prefix *string `mandatory:"false" json:"prefix"`
}
func (m ObjectStorageSourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ObjectStorageSourceDetails) String() string
func (m ObjectStorageSourceDetails) 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"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
OperationStatusFailed OperationStatusEnum = "FAILED"
)
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 (
OperationTypeCreateDataset OperationTypeEnum = "CREATE_DATASET"
OperationTypeDeleteDataset OperationTypeEnum = "DELETE_DATASET"
OperationTypeMoveDataset OperationTypeEnum = "MOVE_DATASET"
OperationTypeGenerateDatasetRecords OperationTypeEnum = "GENERATE_DATASET_RECORDS"
OperationTypeSnapshotDataset OperationTypeEnum = "SNAPSHOT_DATASET"
OperationTypeAddDatasetLabels OperationTypeEnum = "ADD_DATASET_LABELS"
OperationTypeRemoveDatasetLabels OperationTypeEnum = "REMOVE_DATASET_LABELS"
OperationTypeRenameDatasetLabels OperationTypeEnum = "RENAME_DATASET_LABELS"
OperationTypeImportDataset OperationTypeEnum = "IMPORT_DATASET"
)
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
RemoveDatasetLabelsDetails Removes a subset of Labels from the Dataset's LabelSet. This LabelSet will be subtracted from the current Dataset's LabelSet. Requests with non-existent Labels will be rejected.
type RemoveDatasetLabelsDetails struct {
LabelSet *LabelSet `mandatory:"false" json:"labelSet"`
}
func (m RemoveDatasetLabelsDetails) String() string
func (m RemoveDatasetLabelsDetails) 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
RemoveDatasetLabelsRequest wrapper for the RemoveDatasetLabels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/RemoveDatasetLabels.go.html to see an example of how to use RemoveDatasetLabelsRequest.
type RemoveDatasetLabelsRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// Details for removing Labels from the LabelSet of the Dataset.
RemoveDatasetLabelsDetails `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 executing 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 purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// The client request ID for tracing.
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 RemoveDatasetLabelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RemoveDatasetLabelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RemoveDatasetLabelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RemoveDatasetLabelsRequest) String() string
func (request RemoveDatasetLabelsRequest) 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
RemoveDatasetLabelsResponse wrapper for the RemoveDatasetLabels operation
type RemoveDatasetLabelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 RemoveDatasetLabelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RemoveDatasetLabelsResponse) String() string
RenameDatasetLabelsDetails Renames a subset of Labels in the Dataset's LabelSet. The Labels in the source LabelSet will be replaced with the Labels in the target LabelSet. Labels are correlated by index, i.e. the first Label in the source LabelSet will be replaced by the first Label in the target LabelSet. If the size of the source and target LabelSets are not equal, the request will be rejected.
type RenameDatasetLabelsDetails struct {
SourceLabelSet *LabelSet `mandatory:"false" json:"sourceLabelSet"`
TargetLabelSet *LabelSet `mandatory:"false" json:"targetLabelSet"`
}
func (m RenameDatasetLabelsDetails) String() string
func (m RenameDatasetLabelsDetails) 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
RenameDatasetLabelsRequest wrapper for the RenameDatasetLabels operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/RenameDatasetLabels.go.html to see an example of how to use RenameDatasetLabelsRequest.
type RenameDatasetLabelsRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// Details for renaming Labels in the LabelSet of the Dataset.
RenameDatasetLabelsDetails `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 executing 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 purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// The client request ID for tracing.
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 RenameDatasetLabelsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request RenameDatasetLabelsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request RenameDatasetLabelsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request RenameDatasetLabelsRequest) String() string
func (request RenameDatasetLabelsRequest) 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
RenameDatasetLabelsResponse wrapper for the RenameDatasetLabels operation
type RenameDatasetLabelsResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 RenameDatasetLabelsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response RenameDatasetLabelsResponse) String() string
SnapshotDatasetDetails Allows outputting the latest records paired with annotations and write them to object storage.
type SnapshotDatasetDetails struct {
// Whether annotations are to be included in the export dataset digest.
AreAnnotationsIncluded *bool `mandatory:"true" json:"areAnnotationsIncluded"`
// Whether to include records that have yet to be annotated in the export dataset digest.
AreUnannotatedRecordsIncluded *bool `mandatory:"true" json:"areUnannotatedRecordsIncluded"`
ExportDetails *ObjectStorageSnapshotExportDetails `mandatory:"true" json:"exportDetails"`
ExportFormat *ExportFormat `mandatory:"false" json:"exportFormat"`
}
func (m SnapshotDatasetDetails) String() string
func (m SnapshotDatasetDetails) 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
SnapshotDatasetRequest wrapper for the SnapshotDataset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/SnapshotDataset.go.html to see an example of how to use SnapshotDatasetRequest.
type SnapshotDatasetRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// Details of creating a snapshot of the Dataset's Records and Annotations
SnapshotDatasetDetails `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 executing 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 purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// 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"`
// The client request ID for tracing.
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 SnapshotDatasetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request SnapshotDatasetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request SnapshotDatasetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request SnapshotDatasetRequest) String() string
func (request SnapshotDatasetRequest) 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
SnapshotDatasetResponse wrapper for the SnapshotDataset operation
type SnapshotDatasetResponse struct {
// The underlying http response
RawResponse *http.Response
// A unique Oracle-assigned identifier for the asynchronous request. You can use this to query the status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// A 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 SnapshotDatasetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response SnapshotDatasetResponse) String() string
SnapshotExportDetails Specifies where to output the export.
type SnapshotExportDetails interface {
}
SnapshotExportDetailsExportTypeEnum Enum with underlying type: string
type SnapshotExportDetailsExportTypeEnum string
Set of constants representing the allowable values for SnapshotExportDetailsExportTypeEnum
const (
SnapshotExportDetailsExportTypeObjectStorage SnapshotExportDetailsExportTypeEnum = "OBJECT_STORAGE"
)
func GetMappingSnapshotExportDetailsExportTypeEnum(val string) (SnapshotExportDetailsExportTypeEnum, bool)
GetMappingSnapshotExportDetailsExportTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSnapshotExportDetailsExportTypeEnumValues() []SnapshotExportDetailsExportTypeEnum
GetSnapshotExportDetailsExportTypeEnumValues Enumerates the set of values for SnapshotExportDetailsExportTypeEnum
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
TextDatasetFormatDetails It indicates the dataset is comprised of TXT files.
type TextDatasetFormatDetails struct {
TextFileTypeMetadata TextFileTypeMetadata `mandatory:"false" json:"textFileTypeMetadata"`
}
func (m TextDatasetFormatDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m TextDatasetFormatDetails) String() string
func (m *TextDatasetFormatDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m TextDatasetFormatDetails) 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
TextFileTypeMetadata Metadata for files with text content.
type TextFileTypeMetadata interface {
}
TextFileTypeMetadataFormatTypeEnum Enum with underlying type: string
type TextFileTypeMetadataFormatTypeEnum string
Set of constants representing the allowable values for TextFileTypeMetadataFormatTypeEnum
const (
TextFileTypeMetadataFormatTypeDelimited TextFileTypeMetadataFormatTypeEnum = "DELIMITED"
)
func GetMappingTextFileTypeMetadataFormatTypeEnum(val string) (TextFileTypeMetadataFormatTypeEnum, bool)
GetMappingTextFileTypeMetadataFormatTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetTextFileTypeMetadataFormatTypeEnumValues() []TextFileTypeMetadataFormatTypeEnum
GetTextFileTypeMetadataFormatTypeEnumValues Enumerates the set of values for TextFileTypeMetadataFormatTypeEnum
UpdateDatasetDetails Once the Dataset is defined, it's largely immutable from a metadata perspective. The records found in the data source itself, may change over time.
type UpdateDatasetDetails struct {
// A user-friendly display name for the resource.
DisplayName *string `mandatory:"false" json:"displayName"`
// A user provided description of the dataset
Description *string `mandatory:"false" json:"description"`
// The labeling instructions for human labelers in rich text format
LabelingInstructions *string `mandatory:"false" json:"labelingInstructions"`
// A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only.
// For example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// The defined tags for this resource. Each key is predefined and scoped to a namespace.
// For example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateDatasetDetails) String() string
func (m UpdateDatasetDetails) 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
UpdateDatasetRequest wrapper for the UpdateDataset operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/UpdateDataset.go.html to see an example of how to use UpdateDatasetRequest.
type UpdateDatasetRequest struct {
// Unique Dataset OCID
DatasetId *string `mandatory:"true" contributesTo:"path" name:"datasetId"`
// Details for updating a Dataset.
UpdateDatasetDetails `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"`
// The client request ID for tracing.
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 UpdateDatasetRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateDatasetRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateDatasetRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateDatasetRequest) String() string
func (request UpdateDatasetRequest) 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
UpdateDatasetResponse wrapper for the UpdateDataset operation
type UpdateDatasetResponse struct {
// The underlying http response
RawResponse *http.Response
// The Dataset instance
Dataset `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// A 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 UpdateDatasetResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateDatasetResponse) String() string
WorkRequest A description of workrequest status
type WorkRequest struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the request was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
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 executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occured. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occured. An RFC3339 formatted datetime string.
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 Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.
type WorkRequestErrorCollection struct {
// List of workRequestError objects.
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
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string
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 Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.
type WorkRequestLogEntryCollection struct {
// List of workRequestLogEntries.
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 the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// The way in which this resource is affected by the work tracked in the work request.
// A resource being created, updated, or deleted will remain in the IN_PROGRESS state until
// work is complete for that resource at which point it will transition to CREATED, UPDATED,
// or DELETED, respectively.
ActionType ActionTypeEnum `mandatory:"true" json:"actionType"`
// The identifier of the resource the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on 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 (
WorkRequestResourceMetadataKeyNamespace WorkRequestResourceMetadataKeyEnum = "NAMESPACE"
WorkRequestResourceMetadataKeyBucket WorkRequestResourceMetadataKeyEnum = "BUCKET"
WorkRequestResourceMetadataKeyObject WorkRequestResourceMetadataKeyEnum = "OBJECT"
WorkRequestResourceMetadataKeySnapshotVersion WorkRequestResourceMetadataKeyEnum = "SNAPSHOT_VERSION"
)
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
WorkRequestSummary A summary of the status of a work request.
type WorkRequestSummary struct {
// Type of the work request
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The id of the work request.
Id *string `mandatory:"true" json:"id"`
// The ocid of the compartment that contains the work request. Work requests should be scoped to
// the same compartment as the resource the work request affects. If the work request affects multiple resources,
// and those resources are not in the same compartment, it is up to the service team to pick the primary
// resource whose compartment should be used
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
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 Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.
type WorkRequestSummaryCollection struct {
// List of workRequestSummary objects.
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