datalabelingservice

package
v52.0.0 Latest Latest
Warning

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

 Go to latest Published: Nov 17, 2021 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionTypeEnum 

type ActionTypeEnum string

ActionTypeEnum Enum with underlying type: string 

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

Set of constants representing the allowable values for ActionTypeEnum

func GetActionTypeEnumValues 

func GetActionTypeEnumValues() []ActionTypeEnum

GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum

type AddDatasetLabelsDetails 

type AddDatasetLabelsDetails struct {
	LabelSet *LabelSet `mandatory:"false" json:"labelSet"`
}

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.

func (AddDatasetLabelsDetails) String 

func (m AddDatasetLabelsDetails) String() string

type 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
}

AddDatasetLabelsRequest wrapper for the AddDatasetLabels operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/AddDatasetLabels.go.html to see an example of how to use AddDatasetLabelsRequest.

func (AddDatasetLabelsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (AddDatasetLabelsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (AddDatasetLabelsRequest) RetryPolicy 

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

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

func (AddDatasetLabelsRequest) String 

func (request AddDatasetLabelsRequest) String() string

type AddDatasetLabelsResponse 

type AddDatasetLabelsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

AddDatasetLabelsResponse wrapper for the AddDatasetLabels operation

func (AddDatasetLabelsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (AddDatasetLabelsResponse) String 

func (response AddDatasetLabelsResponse) String() string

type AnnotationFormat 

type AnnotationFormat struct {

	// A unique name for the target AnnotationFormat for the Dataset.
	Name *string `mandatory:"true" json:"name"`
}

AnnotationFormat annotation format

func (AnnotationFormat) String 

func (m AnnotationFormat) String() string

type AnnotationFormatCollection 

type AnnotationFormatCollection struct {

	// List of annotation formats.
	Items []AnnotationFormatSummary `mandatory:"true" json:"items"`
}

AnnotationFormatCollection Collection of annotation formats.

func (AnnotationFormatCollection) String 

func (m AnnotationFormatCollection) String() string

type AnnotationFormatSummary 

type AnnotationFormatSummary struct {

	// A unique name for the target AnnotationFormat for the Dataset.
	Name *string `mandatory:"true" json:"name"`
}

AnnotationFormatSummary annotation format summary

func (AnnotationFormatSummary) String 

func (m AnnotationFormatSummary) String() string

type ChangeDatasetCompartmentDetails 

type ChangeDatasetCompartmentDetails struct {

	// The OCID of the compartment where the resource should be moved.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`
}

ChangeDatasetCompartmentDetails The payload sent to the Change Dataset compartment operation.

func (ChangeDatasetCompartmentDetails) String 

func (m ChangeDatasetCompartmentDetails) String() string

type 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
}

ChangeDatasetCompartmentRequest wrapper for the ChangeDatasetCompartment operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ChangeDatasetCompartment.go.html to see an example of how to use ChangeDatasetCompartmentRequest.

func (ChangeDatasetCompartmentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ChangeDatasetCompartmentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ChangeDatasetCompartmentRequest) RetryPolicy 

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

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

func (ChangeDatasetCompartmentRequest) String 

func (request ChangeDatasetCompartmentRequest) String() string

type ChangeDatasetCompartmentResponse 

type ChangeDatasetCompartmentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

ChangeDatasetCompartmentResponse wrapper for the ChangeDatasetCompartment operation

func (ChangeDatasetCompartmentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ChangeDatasetCompartmentResponse) String 

func (response ChangeDatasetCompartmentResponse) String() string

type CreateDatasetDetails 

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"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (CreateDatasetDetails) String 

func (m CreateDatasetDetails) String() string

func (*CreateDatasetDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type 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
}

CreateDatasetRequest wrapper for the CreateDataset operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/CreateDataset.go.html to see an example of how to use CreateDatasetRequest.

func (CreateDatasetRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateDatasetRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateDatasetRequest) RetryPolicy 

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

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

func (CreateDatasetRequest) String 

func (request CreateDatasetRequest) String() string

type CreateDatasetResponse 

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"`

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

CreateDatasetResponse wrapper for the CreateDataset operation

func (CreateDatasetResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateDatasetResponse) String 

func (response CreateDatasetResponse) String() string

type DataLabelingManagementClient 

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

DataLabelingManagementClient a client for DataLabelingManagement

func NewDataLabelingManagementClientWithConfigurationProvider 

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 

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 (DataLabelingManagementClient) AddDatasetLabels 

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/AddDatasetLabels.go.html to see an example of how to use AddDatasetLabels API.

func (DataLabelingManagementClient) ChangeDatasetCompartment 

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ChangeDatasetCompartment.go.html to see an example of how to use ChangeDatasetCompartment API.

func (*DataLabelingManagementClient) ConfigurationProvider 

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

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

func (DataLabelingManagementClient) CreateDataset 

func (client DataLabelingManagementClient) CreateDataset(ctx context.Context, request CreateDatasetRequest) (response CreateDatasetResponse, err error)

CreateDataset Creates a new Dataset.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/CreateDataset.go.html to see an example of how to use CreateDataset API.

func (DataLabelingManagementClient) DeleteDataset 

func (client DataLabelingManagementClient) DeleteDataset(ctx context.Context, request DeleteDatasetRequest) (response DeleteDatasetResponse, err error)

DeleteDataset Deletes a Dataset resource by identifier

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/DeleteDataset.go.html to see an example of how to use DeleteDataset API.

func (DataLabelingManagementClient) GenerateDatasetRecords 

func (client DataLabelingManagementClient) GenerateDatasetRecords(ctx context.Context, request GenerateDatasetRecordsRequest) (response GenerateDatasetRecordsResponse, err error)

GenerateDatasetRecords Generates Record resources from the Dataset's data source

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GenerateDatasetRecords.go.html to see an example of how to use GenerateDatasetRecords API.

func (DataLabelingManagementClient) GetDataset 

func (client DataLabelingManagementClient) GetDataset(ctx context.Context, request GetDatasetRequest) (response GetDatasetResponse, err error)

GetDataset Gets a Dataset by identifier

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GetDataset.go.html to see an example of how to use GetDataset API.

func (DataLabelingManagementClient) GetWorkRequest 

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.

func (DataLabelingManagementClient) ListAnnotationFormats 

func (client DataLabelingManagementClient) ListAnnotationFormats(ctx context.Context, request ListAnnotationFormatsRequest) (response ListAnnotationFormatsResponse, err error)

ListAnnotationFormats These are a static list in a given region.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListAnnotationFormats.go.html to see an example of how to use ListAnnotationFormats API.

func (DataLabelingManagementClient) ListDatasets 

func (client DataLabelingManagementClient) ListDatasets(ctx context.Context, request ListDatasetsRequest) (response ListDatasetsResponse, err error)

ListDatasets Returns a list of Datasets.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListDatasets.go.html to see an example of how to use ListDatasets API.

func (DataLabelingManagementClient) ListWorkRequestErrors 

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.

func (DataLabelingManagementClient) ListWorkRequestLogs 

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.

func (DataLabelingManagementClient) ListWorkRequests 

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

ListWorkRequests Lists the work requests in a compartment.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.

func (DataLabelingManagementClient) RemoveDatasetLabels 

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/RemoveDatasetLabels.go.html to see an example of how to use RemoveDatasetLabels API.

func (DataLabelingManagementClient) RenameDatasetLabels 

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/RenameDatasetLabels.go.html to see an example of how to use RenameDatasetLabels API.

func (*DataLabelingManagementClient) SetRegion 

func (client *DataLabelingManagementClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DataLabelingManagementClient) SnapshotDataset 

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.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/SnapshotDataset.go.html to see an example of how to use SnapshotDataset API.

func (DataLabelingManagementClient) UpdateDataset 

func (client DataLabelingManagementClient) UpdateDataset(ctx context.Context, request UpdateDatasetRequest) (response UpdateDatasetResponse, err error)

UpdateDataset Updates the Dataset

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/UpdateDataset.go.html to see an example of how to use UpdateDataset API.

type Dataset 

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"`

	InitialRecordGenerationConfiguration *InitialRecordGenerationConfiguration `mandatory:"false" json:"initialRecordGenerationConfiguration"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

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.

func (Dataset) String 

func (m Dataset) String() string

func (*Dataset) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type DatasetCollection 

type DatasetCollection struct {

	// List of datasets.
	Items []DatasetSummary `mandatory:"true" json:"items"`
}

DatasetCollection Results of a dataset list operation. Contains DatasetSummary items.

func (DatasetCollection) String 

func (m DatasetCollection) String() string

type DatasetFormatDetails 

type DatasetFormatDetails interface {
}

DatasetFormatDetails Specifies how to process the data. Supported formats include IMAGE and TEXT.

type DatasetFormatDetailsFormatTypeEnum 

type DatasetFormatDetailsFormatTypeEnum string

DatasetFormatDetailsFormatTypeEnum Enum with underlying type: string 

const (
	DatasetFormatDetailsFormatTypeDocument DatasetFormatDetailsFormatTypeEnum = "DOCUMENT"
	DatasetFormatDetailsFormatTypeImage    DatasetFormatDetailsFormatTypeEnum = "IMAGE"
	DatasetFormatDetailsFormatTypeText     DatasetFormatDetailsFormatTypeEnum = "TEXT"
)

Set of constants representing the allowable values for DatasetFormatDetailsFormatTypeEnum

func GetDatasetFormatDetailsFormatTypeEnumValues 

func GetDatasetFormatDetailsFormatTypeEnumValues() []DatasetFormatDetailsFormatTypeEnum

GetDatasetFormatDetailsFormatTypeEnumValues Enumerates the set of values for DatasetFormatDetailsFormatTypeEnum

type DatasetLifecycleStateEnum 

type DatasetLifecycleStateEnum string

DatasetLifecycleStateEnum Enum with underlying type: string 

const (
	DatasetLifecycleStateCreating       DatasetLifecycleStateEnum = "CREATING"
	DatasetLifecycleStateUpdating       DatasetLifecycleStateEnum = "UPDATING"
	DatasetLifecycleStateActive         DatasetLifecycleStateEnum = "ACTIVE"
	DatasetLifecycleStateNeedsAttention DatasetLifecycleStateEnum = "NEEDS_ATTENTION"
	DatasetLifecycleStateDeleting       DatasetLifecycleStateEnum = "DELETING"
	DatasetLifecycleStateDeleted        DatasetLifecycleStateEnum = "DELETED"
	DatasetLifecycleStateFailed         DatasetLifecycleStateEnum = "FAILED"
)

Set of constants representing the allowable values for DatasetLifecycleStateEnum

func GetDatasetLifecycleStateEnumValues 

func GetDatasetLifecycleStateEnumValues() []DatasetLifecycleStateEnum

GetDatasetLifecycleStateEnumValues Enumerates the set of values for DatasetLifecycleStateEnum

type DatasetSourceDetails 

type DatasetSourceDetails interface {
}

DatasetSourceDetails This allows the customer to specify the source of the dataset.

type DatasetSourceDetailsSourceTypeEnum 

type DatasetSourceDetailsSourceTypeEnum string

DatasetSourceDetailsSourceTypeEnum Enum with underlying type: string 

const (
	DatasetSourceDetailsSourceTypeObjectStorage DatasetSourceDetailsSourceTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for DatasetSourceDetailsSourceTypeEnum

func GetDatasetSourceDetailsSourceTypeEnumValues 

func GetDatasetSourceDetailsSourceTypeEnumValues() []DatasetSourceDetailsSourceTypeEnum

GetDatasetSourceDetailsSourceTypeEnumValues Enumerates the set of values for DatasetSourceDetailsSourceTypeEnum

type DatasetSummary 

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"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`

	// Usage of system tag keys. These predefined keys are scoped to namespaces.
	// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
	SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}

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.

func (DatasetSummary) String 

func (m DatasetSummary) String() string

func (*DatasetSummary) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type 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
}

DeleteDatasetRequest wrapper for the DeleteDataset operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/DeleteDataset.go.html to see an example of how to use DeleteDatasetRequest.

func (DeleteDatasetRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteDatasetRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteDatasetRequest) RetryPolicy 

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

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

func (DeleteDatasetRequest) String 

func (request DeleteDatasetRequest) String() string

type DeleteDatasetResponse 

type DeleteDatasetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

DeleteDatasetResponse wrapper for the DeleteDataset operation

func (DeleteDatasetResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteDatasetResponse) String 

func (response DeleteDatasetResponse) String() string

type DocumentDatasetFormatDetails 

type DocumentDatasetFormatDetails struct {
}

DocumentDatasetFormatDetails Allows the user to specify that the dataset is comprised of document files (e.g. PDFs, DOCs, etc.). It is open for further configurability.

func (DocumentDatasetFormatDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (DocumentDatasetFormatDetails) String 

func (m DocumentDatasetFormatDetails) String() string

type GenerateDatasetRecordsDetails 

type GenerateDatasetRecordsDetails struct {

	// the maximum number of records to generate.
	Limit *float32 `mandatory:"false" json:"limit"`
}

GenerateDatasetRecordsDetails Generate Records from the Dataset's source.

func (GenerateDatasetRecordsDetails) String 

func (m GenerateDatasetRecordsDetails) String() string

type 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
}

GenerateDatasetRecordsRequest wrapper for the GenerateDatasetRecords operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GenerateDatasetRecords.go.html to see an example of how to use GenerateDatasetRecordsRequest.

func (GenerateDatasetRecordsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GenerateDatasetRecordsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GenerateDatasetRecordsRequest) RetryPolicy 

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

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

func (GenerateDatasetRecordsRequest) String 

func (request GenerateDatasetRecordsRequest) String() string

type GenerateDatasetRecordsResponse 

type GenerateDatasetRecordsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

GenerateDatasetRecordsResponse wrapper for the GenerateDatasetRecords operation

func (GenerateDatasetRecordsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GenerateDatasetRecordsResponse) String 

func (response GenerateDatasetRecordsResponse) String() string

type 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
}

GetDatasetRequest wrapper for the GetDataset operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GetDataset.go.html to see an example of how to use GetDatasetRequest.

func (GetDatasetRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetDatasetRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetDatasetRequest) RetryPolicy 

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

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

func (GetDatasetRequest) String 

func (request GetDatasetRequest) String() string

type GetDatasetResponse 

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"`

	// 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"`
}

GetDatasetResponse wrapper for the GetDataset operation

func (GetDatasetResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetDatasetResponse) String 

func (response GetDatasetResponse) String() string

type 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
}

GetWorkRequestRequest wrapper for the GetWorkRequest operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.

func (GetWorkRequestRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetWorkRequestRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetWorkRequestRequest) RetryPolicy 

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

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

func (GetWorkRequestRequest) String 

func (request GetWorkRequestRequest) String() string

type GetWorkRequestResponse 

type GetWorkRequestResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

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

	// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
	RetryAfter *int `presentIn:"header" name:"retry-after"`
}

GetWorkRequestResponse wrapper for the GetWorkRequest operation

func (GetWorkRequestResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetWorkRequestResponse) String 

func (response GetWorkRequestResponse) String() string

type ImageDatasetFormatDetails 

type ImageDatasetFormatDetails struct {
}

ImageDatasetFormatDetails Indicates the dataset is comprised of images.

func (ImageDatasetFormatDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ImageDatasetFormatDetails) String 

func (m ImageDatasetFormatDetails) String() string

type InitialRecordGenerationConfiguration 

type InitialRecordGenerationConfiguration struct {

	// the maximum number of records to generate.
	Limit *float32 `mandatory:"false" json:"limit"`
}

InitialRecordGenerationConfiguration Initial Generate Records configuration, generates records from the Dataset's source.

func (InitialRecordGenerationConfiguration) String 

func (m InitialRecordGenerationConfiguration) String() string

type Label 

type Label struct {

	// An unique name for a label within its dataset.
	Name *string `mandatory:"false" json:"name"`
}

Label Represents a label.

func (Label) String 

func (m Label) String() string

type LabelSet 

type LabelSet struct {

	// An ordered collection of Labels that are unique by name.
	Items []Label `mandatory:"false" json:"items"`
}

LabelSet An ordered collection of Labels that are unique by name.

func (LabelSet) String 

func (m LabelSet) String() string

type 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
}

ListAnnotationFormatsRequest wrapper for the ListAnnotationFormats operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListAnnotationFormats.go.html to see an example of how to use ListAnnotationFormatsRequest.

func (ListAnnotationFormatsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListAnnotationFormatsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListAnnotationFormatsRequest) RetryPolicy 

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

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

func (ListAnnotationFormatsRequest) String 

func (request ListAnnotationFormatsRequest) String() string

type ListAnnotationFormatsResponse 

type ListAnnotationFormatsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of AnnotationFormatCollection instances
	AnnotationFormatCollection `presentIn:"body"`

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

	// For 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"`
}

ListAnnotationFormatsResponse wrapper for the ListAnnotationFormats operation

func (ListAnnotationFormatsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListAnnotationFormatsResponse) String 

func (response ListAnnotationFormatsResponse) String() string

type ListAnnotationFormatsSortOrderEnum 

type ListAnnotationFormatsSortOrderEnum string

ListAnnotationFormatsSortOrderEnum Enum with underlying type: string 

const (
	ListAnnotationFormatsSortOrderAsc  ListAnnotationFormatsSortOrderEnum = "ASC"
	ListAnnotationFormatsSortOrderDesc ListAnnotationFormatsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAnnotationFormatsSortOrderEnum

func GetListAnnotationFormatsSortOrderEnumValues 

func GetListAnnotationFormatsSortOrderEnumValues() []ListAnnotationFormatsSortOrderEnum

GetListAnnotationFormatsSortOrderEnumValues Enumerates the set of values for ListAnnotationFormatsSortOrderEnum

type 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
}

ListDatasetsRequest wrapper for the ListDatasets operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListDatasets.go.html to see an example of how to use ListDatasetsRequest.

func (ListDatasetsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListDatasetsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListDatasetsRequest) RetryPolicy 

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

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

func (ListDatasetsRequest) String 

func (request ListDatasetsRequest) String() string

type ListDatasetsResponse 

type ListDatasetsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of DatasetCollection instances
	DatasetCollection `presentIn:"body"`

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

	// For 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"`
}

ListDatasetsResponse wrapper for the ListDatasets operation

func (ListDatasetsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListDatasetsResponse) String 

func (response ListDatasetsResponse) String() string

type ListDatasetsSortByEnum 

type ListDatasetsSortByEnum string

ListDatasetsSortByEnum Enum with underlying type: string 

const (
	ListDatasetsSortByTimecreated ListDatasetsSortByEnum = "timeCreated"
	ListDatasetsSortByDisplayname ListDatasetsSortByEnum = "displayName"
)

Set of constants representing the allowable values for ListDatasetsSortByEnum

func GetListDatasetsSortByEnumValues 

func GetListDatasetsSortByEnumValues() []ListDatasetsSortByEnum

GetListDatasetsSortByEnumValues Enumerates the set of values for ListDatasetsSortByEnum

type ListDatasetsSortOrderEnum 

type ListDatasetsSortOrderEnum string

ListDatasetsSortOrderEnum Enum with underlying type: string 

const (
	ListDatasetsSortOrderAsc  ListDatasetsSortOrderEnum = "ASC"
	ListDatasetsSortOrderDesc ListDatasetsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListDatasetsSortOrderEnum

func GetListDatasetsSortOrderEnumValues 

func GetListDatasetsSortOrderEnumValues() []ListDatasetsSortOrderEnum

GetListDatasetsSortOrderEnumValues Enumerates the set of values for ListDatasetsSortOrderEnum

type 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
}

ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.

func (ListWorkRequestErrorsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestErrorsRequest) RetryPolicy 

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

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

func (ListWorkRequestErrorsRequest) String 

func (request ListWorkRequestErrorsRequest) String() string

type ListWorkRequestErrorsResponse 

type ListWorkRequestErrorsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestErrorCollection instances
	WorkRequestErrorCollection `presentIn:"body"`

	// For 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"`

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

ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation

func (ListWorkRequestErrorsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestErrorsResponse) String 

func (response ListWorkRequestErrorsResponse) String() string

type 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
}

ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.

func (ListWorkRequestLogsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestLogsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestLogsRequest) RetryPolicy 

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

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

func (ListWorkRequestLogsRequest) String 

func (request ListWorkRequestLogsRequest) String() string

type ListWorkRequestLogsResponse 

type ListWorkRequestLogsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestLogEntryCollection instances
	WorkRequestLogEntryCollection `presentIn:"body"`

	// For 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"`

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

ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation

func (ListWorkRequestLogsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestLogsResponse) String 

func (response ListWorkRequestLogsResponse) String() string

type 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
}

ListWorkRequestsRequest wrapper for the ListWorkRequests operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.

func (ListWorkRequestsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListWorkRequestsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListWorkRequestsRequest) RetryPolicy 

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

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

func (ListWorkRequestsRequest) String 

func (request ListWorkRequestsRequest) String() string

type ListWorkRequestsResponse 

type ListWorkRequestsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of WorkRequestSummaryCollection instances
	WorkRequestSummaryCollection `presentIn:"body"`

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

	// For 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"`
}

ListWorkRequestsResponse wrapper for the ListWorkRequests operation

func (ListWorkRequestsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListWorkRequestsResponse) String 

func (response ListWorkRequestsResponse) String() string

type ObjectStorageSnapshotExportDetails 

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"`
}

ObjectStorageSnapshotExportDetails Specifies where to output the export in Object Storage.

func (ObjectStorageSnapshotExportDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ObjectStorageSnapshotExportDetails) String 

func (m ObjectStorageSnapshotExportDetails) String() string

type ObjectStorageSourceDetails 

type ObjectStorageSourceDetails struct {

	// 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.
	Prefix *string `mandatory:"false" json:"prefix"`
}

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.

func (ObjectStorageSourceDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ObjectStorageSourceDetails) String 

func (m ObjectStorageSourceDetails) String() string

type OperationStatusEnum 

type OperationStatusEnum string

OperationStatusEnum Enum with underlying type: string 

const (
	OperationStatusAccepted   OperationStatusEnum = "ACCEPTED"
	OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
	OperationStatusWaiting    OperationStatusEnum = "WAITING"
	OperationStatusSucceeded  OperationStatusEnum = "SUCCEEDED"
	OperationStatusCanceling  OperationStatusEnum = "CANCELING"
	OperationStatusCanceled   OperationStatusEnum = "CANCELED"
	OperationStatusFailed     OperationStatusEnum = "FAILED"
)

Set of constants representing the allowable values for OperationStatusEnum

func GetOperationStatusEnumValues 

func GetOperationStatusEnumValues() []OperationStatusEnum

GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum

type OperationTypeEnum 

type OperationTypeEnum string

OperationTypeEnum Enum with underlying type: string 

const (
	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"
)

Set of constants representing the allowable values for OperationTypeEnum

func GetOperationTypeEnumValues 

func GetOperationTypeEnumValues() []OperationTypeEnum

GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum

type RemoveDatasetLabelsDetails 

type RemoveDatasetLabelsDetails struct {
	LabelSet *LabelSet `mandatory:"false" json:"labelSet"`
}

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.

func (RemoveDatasetLabelsDetails) String 

func (m RemoveDatasetLabelsDetails) String() string

type 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
}

RemoveDatasetLabelsRequest wrapper for the RemoveDatasetLabels operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/RemoveDatasetLabels.go.html to see an example of how to use RemoveDatasetLabelsRequest.

func (RemoveDatasetLabelsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (RemoveDatasetLabelsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (RemoveDatasetLabelsRequest) RetryPolicy 

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

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

func (RemoveDatasetLabelsRequest) String 

func (request RemoveDatasetLabelsRequest) String() string

type RemoveDatasetLabelsResponse 

type RemoveDatasetLabelsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

RemoveDatasetLabelsResponse wrapper for the RemoveDatasetLabels operation

func (RemoveDatasetLabelsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RemoveDatasetLabelsResponse) String 

func (response RemoveDatasetLabelsResponse) String() string

type RenameDatasetLabelsDetails 

type RenameDatasetLabelsDetails struct {
	SourceLabelSet *LabelSet `mandatory:"false" json:"sourceLabelSet"`

	TargetLabelSet *LabelSet `mandatory:"false" json:"targetLabelSet"`
}

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.

func (RenameDatasetLabelsDetails) String 

func (m RenameDatasetLabelsDetails) String() string

type 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
}

RenameDatasetLabelsRequest wrapper for the RenameDatasetLabels operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/RenameDatasetLabels.go.html to see an example of how to use RenameDatasetLabelsRequest.

func (RenameDatasetLabelsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (RenameDatasetLabelsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (RenameDatasetLabelsRequest) RetryPolicy 

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

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

func (RenameDatasetLabelsRequest) String 

func (request RenameDatasetLabelsRequest) String() string

type RenameDatasetLabelsResponse 

type RenameDatasetLabelsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

RenameDatasetLabelsResponse wrapper for the RenameDatasetLabels operation

func (RenameDatasetLabelsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (RenameDatasetLabelsResponse) String 

func (response RenameDatasetLabelsResponse) String() string

type SnapshotDatasetDetails 

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"`
}

SnapshotDatasetDetails Allows outputting the latest records paired with annotations and write them to object storage.

func (SnapshotDatasetDetails) String 

func (m SnapshotDatasetDetails) String() string

type 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
}

SnapshotDatasetRequest wrapper for the SnapshotDataset operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/SnapshotDataset.go.html to see an example of how to use SnapshotDatasetRequest.

func (SnapshotDatasetRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (SnapshotDatasetRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (SnapshotDatasetRequest) RetryPolicy 

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

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

func (SnapshotDatasetRequest) String 

func (request SnapshotDatasetRequest) String() string

type SnapshotDatasetResponse 

type SnapshotDatasetResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
	OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`

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

SnapshotDatasetResponse wrapper for the SnapshotDataset operation

func (SnapshotDatasetResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (SnapshotDatasetResponse) String 

func (response SnapshotDatasetResponse) String() string

type SnapshotExportDetails 

type SnapshotExportDetails interface {
}

SnapshotExportDetails Specifies where to output the export.

type SnapshotExportDetailsExportTypeEnum 

type SnapshotExportDetailsExportTypeEnum string

SnapshotExportDetailsExportTypeEnum Enum with underlying type: string 

const (
	SnapshotExportDetailsExportTypeObjectStorage SnapshotExportDetailsExportTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for SnapshotExportDetailsExportTypeEnum

func GetSnapshotExportDetailsExportTypeEnumValues 

func GetSnapshotExportDetailsExportTypeEnumValues() []SnapshotExportDetailsExportTypeEnum

GetSnapshotExportDetailsExportTypeEnumValues Enumerates the set of values for SnapshotExportDetailsExportTypeEnum

type SortOrderEnum 

type SortOrderEnum string

SortOrderEnum Enum with underlying type: string 

const (
	SortOrderAsc  SortOrderEnum = "ASC"
	SortOrderDesc SortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SortOrderEnum

func GetSortOrderEnumValues 

func GetSortOrderEnumValues() []SortOrderEnum

GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum

type TextDatasetFormatDetails 

type TextDatasetFormatDetails struct {
}

TextDatasetFormatDetails Indicates the dataset is comprised of txt files.

func (TextDatasetFormatDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (TextDatasetFormatDetails) String 

func (m TextDatasetFormatDetails) String() string

type UpdateDatasetDetails 

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"`

	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
	// Example: `{"bar-key": "value"}`
	FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`

	// Defined tags for this resource. Each key is predefined and scoped to a namespace.
	// Example: `{"foo-namespace": {"bar-key": "value"}}`
	DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}

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.

func (UpdateDatasetDetails) String 

func (m UpdateDatasetDetails) String() string

type 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
}

UpdateDatasetRequest wrapper for the UpdateDataset operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservice/UpdateDataset.go.html to see an example of how to use UpdateDatasetRequest.

func (UpdateDatasetRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateDatasetRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateDatasetRequest) RetryPolicy 

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

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

func (UpdateDatasetRequest) String 

func (request UpdateDatasetRequest) String() string

type UpdateDatasetResponse 

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"`

	// 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"`
}

UpdateDatasetResponse wrapper for the UpdateDataset operation

func (UpdateDatasetResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateDatasetResponse) String 

func (response UpdateDatasetResponse) String() string

type WorkRequest 

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"`
}

WorkRequest A description of workrequest status

func (WorkRequest) String 

func (m WorkRequest) String() string

type WorkRequestError 

type WorkRequestError struct {

	// A machine-usable code for the error that occured. Error codes are listed on
	// (https://docs.cloud.oracle.com/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"`
}

WorkRequestError An error encountered while executing a work request.

func (WorkRequestError) String 

func (m WorkRequestError) String() string

type WorkRequestErrorCollection 

type WorkRequestErrorCollection struct {

	// List of workRequestError objects.
	Items []WorkRequestError `mandatory:"true" json:"items"`
}

WorkRequestErrorCollection Results of a workRequestError search. Contains both WorkRequestError items and other information, such as metadata.

func (WorkRequestErrorCollection) String 

func (m WorkRequestErrorCollection) String() string

type WorkRequestLogEntry 

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"`
}

WorkRequestLogEntry A log message from the execution of a work request.

func (WorkRequestLogEntry) String 

func (m WorkRequestLogEntry) String() string

type WorkRequestLogEntryCollection 

type WorkRequestLogEntryCollection struct {

	// List of workRequestLogEntries.
	Items []WorkRequestLogEntry `mandatory:"true" json:"items"`
}

WorkRequestLogEntryCollection Results of a workRequestLog search. Contains both workRequestLog items and other information, such as metadata.

func (WorkRequestLogEntryCollection) String 

func (m WorkRequestLogEntryCollection) String() string

type WorkRequestResource 

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"`
}

WorkRequestResource A resource created or operated on by a work request.

func (WorkRequestResource) String 

func (m WorkRequestResource) String() string

type WorkRequestResourceMetadataKeyEnum 

type WorkRequestResourceMetadataKeyEnum string

WorkRequestResourceMetadataKeyEnum Enum with underlying type: string 

const (
	WorkRequestResourceMetadataKeyNamespace       WorkRequestResourceMetadataKeyEnum = "NAMESPACE"
	WorkRequestResourceMetadataKeyBucket          WorkRequestResourceMetadataKeyEnum = "BUCKET"
	WorkRequestResourceMetadataKeyObject          WorkRequestResourceMetadataKeyEnum = "OBJECT"
	WorkRequestResourceMetadataKeySnapshotVersion WorkRequestResourceMetadataKeyEnum = "SNAPSHOT_VERSION"
)

Set of constants representing the allowable values for WorkRequestResourceMetadataKeyEnum

func GetWorkRequestResourceMetadataKeyEnumValues 

func GetWorkRequestResourceMetadataKeyEnumValues() []WorkRequestResourceMetadataKeyEnum

GetWorkRequestResourceMetadataKeyEnumValues Enumerates the set of values for WorkRequestResourceMetadataKeyEnum

type WorkRequestSummary 

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"`
}

WorkRequestSummary A summary of the status of a work request.

func (WorkRequestSummary) String 

func (m WorkRequestSummary) String() string

type WorkRequestSummaryCollection 

type WorkRequestSummaryCollection struct {

	// List of workRequestSummary objects.
	Items []WorkRequestSummary `mandatory:"true" json:"items"`
}

WorkRequestSummaryCollection Results of a workRequest search. Contains both WorkRequest items and other information, such as metadata.

func (WorkRequestSummaryCollection) String 

func (m WorkRequestSummaryCollection) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.