datalabelingservicedataplane

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: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Annotation 

type Annotation struct {

	// The OCID of the annotation
	Id *string `mandatory:"true" json:"id"`

	// The date and time the annotation was created, in the timestamp format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The date and time the resource was updated, in the timestamp format defined by RFC3339.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// The OCID of the principal who created the annotation
	CreatedBy *string `mandatory:"true" json:"createdBy"`

	// The OCID of the principal who updated the annotation
	UpdatedBy *string `mandatory:"true" json:"updatedBy"`

	// The OCID of the record annotated
	RecordId *string `mandatory:"true" json:"recordId"`

	// The entity types will be validated against the dataset to ensure consistency.
	Entities []Entity `mandatory:"true" json:"entities"`

	// The OCID of the compartment for the annotation. This is tied to the dataset. It is not changeable on the record itself.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Lifecycle State of an Annotation.
	// ACTIVE - Annotation is active to be used for labeling.
	// INACTIVE - Annotation has been marked as inactive and should not be used for labeling.
	// DELETED - Annotation been deleted and no longer available for labeling.
	LifecycleState AnnotationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

Annotation An Annotation represents a user/machine generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails.

func (Annotation) String 

func (m Annotation) String() string

func (*Annotation) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type AnnotationAggregationDimensions 

type AnnotationAggregationDimensions struct {
	Label *Label `mandatory:"false" json:"label"`

	// The OCID of the principal who updated the resource.
	UpdatedBy *string `mandatory:"false" json:"updatedBy"`
}

AnnotationAggregationDimensions Dimensions to summarize annotations for a given dataset

func (AnnotationAggregationDimensions) String 

func (m AnnotationAggregationDimensions) String() string

type AnnotationAnalyticsAggregation 

type AnnotationAnalyticsAggregation struct {

	// the count of the matching results
	Count *float32 `mandatory:"true" json:"count"`

	// OCID of the dataset the annotations belongs to
	DatasetId *string `mandatory:"true" json:"datasetId"`

	// OCID of the compartment containing the annotations
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	Dimensions *AnnotationAggregationDimensions `mandatory:"false" json:"dimensions"`

	// The OCID of the principal who updated the annotation
	UpdatedBy *string `mandatory:"false" json:"updatedBy"`

	// Describes the lifecycle state.
	LifecycleState AnnotationLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

AnnotationAnalyticsAggregation Aggregation entities are required by the api consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters to the list API we apply would have to show up in the aggregation. We should limit the number of filters and dimensions as much as possible.

func (AnnotationAnalyticsAggregation) String 

func (m AnnotationAnalyticsAggregation) String() string

type AnnotationAnalyticsAggregationCollection 

type AnnotationAnalyticsAggregationCollection struct {

	// List of Annotation entities.
	Items []AnnotationAnalyticsAggregation `mandatory:"true" json:"items"`
}

AnnotationAnalyticsAggregationCollection Aggregation entities are required by the api consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters to the list API we apply would have to show up in the aggregation. We should limit the number of filters and dimensions as much as possible.

func (AnnotationAnalyticsAggregationCollection) String 

func (m AnnotationAnalyticsAggregationCollection) String() string

type AnnotationCollection 

type AnnotationCollection struct {

	// List of annotations.
	Items []AnnotationSummary `mandatory:"true" json:"items"`
}

AnnotationCollection Results of a annotations search. Contains boh AnnotationSummary items and other information, such as metadata.

func (AnnotationCollection) String 

func (m AnnotationCollection) String() string

type AnnotationLifecycleStateEnum 

type AnnotationLifecycleStateEnum string

AnnotationLifecycleStateEnum Enum with underlying type: string 

const (
	AnnotationLifecycleStateActive   AnnotationLifecycleStateEnum = "ACTIVE"
	AnnotationLifecycleStateInactive AnnotationLifecycleStateEnum = "INACTIVE"
	AnnotationLifecycleStateDeleted  AnnotationLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for AnnotationLifecycleStateEnum

func GetAnnotationLifecycleStateEnumValues 

func GetAnnotationLifecycleStateEnumValues() []AnnotationLifecycleStateEnum

GetAnnotationLifecycleStateEnumValues Enumerates the set of values for AnnotationLifecycleStateEnum

type AnnotationSummary 

type AnnotationSummary struct {

	// The OCID of the annotation
	Id *string `mandatory:"true" json:"id"`

	// The date and time the annotation was created, in the timestamp format defined by RFC3339.
	TimeCreated *common.SDKTime `mandatory:"true" json:"timeCreated"`

	// The date and time the resource was updated, in the timestamp format defined by RFC3339.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// The OCID of the record annotated
	RecordId *string `mandatory:"true" json:"recordId"`

	// The OCID of the compartment for the annotation
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Describes the lifecycle state.
	LifecycleState AnnotationLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

AnnotationSummary An annotation summary is the representation returned in list views. It is usually a subset of the full annotation entity and should not contain any potentially sensitive information.

func (AnnotationSummary) String 

func (m AnnotationSummary) String() string

type BoundingPolygon 

type BoundingPolygon struct {

	// The normalized vertices that make up the polygon.  They are in order of the segments that they connect.
	NormalizedVertices []NormalizedVertex `mandatory:"true" json:"normalizedVertices"`
}

BoundingPolygon A polygon used to describe the location of an object.

func (BoundingPolygon) String 

func (m BoundingPolygon) String() string

type CreateAnnotationDetails 

type CreateAnnotationDetails struct {

	// The OCID of the record annotated
	RecordId *string `mandatory:"true" json:"recordId"`

	// The OCID of the compartment for the annotation
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// The entity types will be validated against the dataset to ensure consistency.
	Entities []Entity `mandatory:"true" json:"entities"`

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

CreateAnnotationDetails This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an Annotation for a record.

func (CreateAnnotationDetails) String 

func (m CreateAnnotationDetails) String() string

func (*CreateAnnotationDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type CreateAnnotationRequest 

type CreateAnnotationRequest struct {

	// Details for the new CreateAnnotation.
	CreateAnnotationDetails `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
}

CreateAnnotationRequest wrapper for the CreateAnnotation operation

See also

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

func (CreateAnnotationRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateAnnotationRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateAnnotationRequest) RetryPolicy 

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

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

func (CreateAnnotationRequest) String 

func (request CreateAnnotationRequest) String() string

type CreateAnnotationResponse 

type CreateAnnotationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateAnnotationResponse wrapper for the CreateAnnotation operation

func (CreateAnnotationResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateAnnotationResponse) String 

func (response CreateAnnotationResponse) String() string

type CreateObjectStorageSourceDetails 

type CreateObjectStorageSourceDetails struct {

	// The path relative to the prefix specified in the dataset source details (file name).
	RelativePath *string `mandatory:"true" json:"relativePath"`

	// The offset into the file containing the content.
	Offset *float32 `mandatory:"false" json:"offset"`

	// The length from offset into the file containing the content.
	Length *float32 `mandatory:"false" json:"length"`
}

CreateObjectStorageSourceDetails Object Storage Source Details.

func (CreateObjectStorageSourceDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (CreateObjectStorageSourceDetails) String 

func (m CreateObjectStorageSourceDetails) String() string

type CreateRecordDetails 

type CreateRecordDetails struct {

	// This will be automatically assigned by the service. It will be unique and immutable.
	Name *string `mandatory:"true" json:"name"`

	// The OCID of the dataset to associate the record with.
	DatasetId *string `mandatory:"true" json:"datasetId"`

	// The OCID of the compartment for the record. This is tied to the dataset. It is not changeable on the record itself.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	SourceDetails CreateSourceDetails `mandatory:"true" json:"sourceDetails"`

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

CreateRecordDetails A record represents an entry in a dataset that needs labeling.

func (CreateRecordDetails) String 

func (m CreateRecordDetails) String() string

func (*CreateRecordDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type CreateRecordRequest 

type CreateRecordRequest struct {

	// Details for the new Record.
	CreateRecordDetails `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
}

CreateRecordRequest wrapper for the CreateRecord operation

See also

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

func (CreateRecordRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (CreateRecordRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (CreateRecordRequest) RetryPolicy 

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

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

func (CreateRecordRequest) String 

func (request CreateRecordRequest) String() string

type CreateRecordResponse 

type CreateRecordResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

CreateRecordResponse wrapper for the CreateRecord operation

func (CreateRecordResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (CreateRecordResponse) String 

func (response CreateRecordResponse) String() string

type CreateSourceDetails 

type CreateSourceDetails interface {
}

CreateSourceDetails The source information is a polymorphic entity. It captures the details of how to access the data for record creation. The discriminator type must match the dataset's source type. The convention will be enforced by the API. It should only provide the difference in data necessary to access the content, i.e. the object storage path, or the database record id.

type CreateSourceDetailsSourceTypeEnum 

type CreateSourceDetailsSourceTypeEnum string

CreateSourceDetailsSourceTypeEnum Enum with underlying type: string 

const (
	CreateSourceDetailsSourceTypeObjectStorage CreateSourceDetailsSourceTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for CreateSourceDetailsSourceTypeEnum

func GetCreateSourceDetailsSourceTypeEnumValues 

func GetCreateSourceDetailsSourceTypeEnumValues() []CreateSourceDetailsSourceTypeEnum

GetCreateSourceDetailsSourceTypeEnumValues Enumerates the set of values for CreateSourceDetailsSourceTypeEnum

type DataLabelingClient 

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

DataLabelingClient a client for DataLabeling

func NewDataLabelingClientWithConfigurationProvider 

func NewDataLabelingClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client DataLabelingClient, err error)

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

func NewDataLabelingClientWithOboToken 

func NewDataLabelingClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client DataLabelingClient, err error)

NewDataLabelingClientWithOboToken Creates a new default DataLabeling 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 (*DataLabelingClient) ConfigurationProvider 

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

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

func (DataLabelingClient) CreateAnnotation 

func (client DataLabelingClient) CreateAnnotation(ctx context.Context, request CreateAnnotationRequest) (response CreateAnnotationResponse, err error)

CreateAnnotation Creates an annotation.

See also

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

func (DataLabelingClient) CreateRecord 

func (client DataLabelingClient) CreateRecord(ctx context.Context, request CreateRecordRequest) (response CreateRecordResponse, err error)

CreateRecord Creates a Record.

See also

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

func (DataLabelingClient) DeleteAnnotation 

func (client DataLabelingClient) DeleteAnnotation(ctx context.Context, request DeleteAnnotationRequest) (response DeleteAnnotationResponse, err error)

DeleteAnnotation Deletes an Annotation resource by identifier

See also

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

func (DataLabelingClient) DeleteRecord 

func (client DataLabelingClient) DeleteRecord(ctx context.Context, request DeleteRecordRequest) (response DeleteRecordResponse, err error)

DeleteRecord Deletes a Record resource by identifier

See also

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

func (DataLabelingClient) GetAnnotation 

func (client DataLabelingClient) GetAnnotation(ctx context.Context, request GetAnnotationRequest) (response GetAnnotationResponse, err error)

GetAnnotation Gets an Annotation

See also

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

func (DataLabelingClient) GetDataset 

func (client DataLabelingClient) 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/datalabelingservicedataplane/GetDataset.go.html to see an example of how to use GetDataset API.

func (DataLabelingClient) GetRecord 

func (client DataLabelingClient) GetRecord(ctx context.Context, request GetRecordRequest) (response GetRecordResponse, err error)

GetRecord Gets a record

See also

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

func (DataLabelingClient) GetRecordContent 

func (client DataLabelingClient) GetRecordContent(ctx context.Context, request GetRecordContentRequest) (response GetRecordContentResponse, err error)

GetRecordContent Retrieves the content of the record from the Dataset source.

See also

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

func (DataLabelingClient) GetRecordPreviewContent 

func (client DataLabelingClient) GetRecordPreviewContent(ctx context.Context, request GetRecordPreviewContentRequest) (response GetRecordPreviewContentResponse, err error)

GetRecordPreviewContent Retrieves the preview of the record content from the Dataset source.

See also

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

func (DataLabelingClient) ListAnnotations 

func (client DataLabelingClient) ListAnnotations(ctx context.Context, request ListAnnotationsRequest) (response ListAnnotationsResponse, err error)

ListAnnotations Returns a list of Annotations.

See also

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

func (DataLabelingClient) ListRecords 

func (client DataLabelingClient) ListRecords(ctx context.Context, request ListRecordsRequest) (response ListRecordsResponse, err error)

ListRecords List Record in the specified compartment.

See also

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

func (*DataLabelingClient) SetRegion 

func (client *DataLabelingClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (DataLabelingClient) SummarizeAnnotationAnalytics 

func (client DataLabelingClient) SummarizeAnnotationAnalytics(ctx context.Context, request SummarizeAnnotationAnalyticsRequest) (response SummarizeAnnotationAnalyticsResponse, err error)

SummarizeAnnotationAnalytics Summarize annotations created for a given dataset

See also

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

func (DataLabelingClient) SummarizeRecordAnalytics 

func (client DataLabelingClient) SummarizeRecordAnalytics(ctx context.Context, request SummarizeRecordAnalyticsRequest) (response SummarizeRecordAnalyticsResponse, err error)

SummarizeRecordAnalytics Summarize records created for a given dataset

See also

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

func (DataLabelingClient) UpdateAnnotation 

func (client DataLabelingClient) UpdateAnnotation(ctx context.Context, request UpdateAnnotationRequest) (response UpdateAnnotationResponse, err error)

UpdateAnnotation Updates an annotation.

See also

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

func (DataLabelingClient) UpdateRecord 

func (client DataLabelingClient) UpdateRecord(ctx context.Context, request UpdateRecordRequest) (response UpdateRecordResponse, err error)

UpdateRecord Updates record.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/datalabelingservicedataplane/UpdateRecord.go.html to see an example of how to use UpdateRecord 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 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 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 DeleteAnnotationRequest 

type DeleteAnnotationRequest struct {

	// unique Annotation identifier
	AnnotationId *string `mandatory:"true" contributesTo:"path" name:"annotationId"`

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

DeleteAnnotationRequest wrapper for the DeleteAnnotation operation

See also

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

func (DeleteAnnotationRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteAnnotationRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteAnnotationRequest) RetryPolicy 

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

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

func (DeleteAnnotationRequest) String 

func (request DeleteAnnotationRequest) String() string

type DeleteAnnotationResponse 

type DeleteAnnotationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteAnnotationResponse wrapper for the DeleteAnnotation operation

func (DeleteAnnotationResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteAnnotationResponse) String 

func (response DeleteAnnotationResponse) String() string

type DeleteRecordRequest 

type DeleteRecordRequest struct {

	// The OCID of the record annotated
	RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"`

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

DeleteRecordRequest wrapper for the DeleteRecord operation

See also

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

func (DeleteRecordRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DeleteRecordRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DeleteRecordRequest) RetryPolicy 

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

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

func (DeleteRecordRequest) String 

func (request DeleteRecordRequest) String() string

type DeleteRecordResponse 

type DeleteRecordResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

DeleteRecordResponse wrapper for the DeleteRecord operation

func (DeleteRecordResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DeleteRecordResponse) String 

func (response DeleteRecordResponse) 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 Entity 

type Entity interface {
}

Entity An entity allows the labeler to identify an object in the record to label. This can be a snippet of text, an entire image, a bounding box within an image, or, eventually, a custom format that works for them. All entity types will have an array of labels that we'll index. If more than one label is provided, but the annotationType on the corresponding Dataset is for single class, the API will reject the create annotation request.

type EntityEntityTypeEnum 

type EntityEntityTypeEnum string

EntityEntityTypeEnum Enum with underlying type: string 

const (
	EntityEntityTypeGeneric              EntityEntityTypeEnum = "GENERIC"
	EntityEntityTypeImageobjectselection EntityEntityTypeEnum = "IMAGEOBJECTSELECTION"
	EntityEntityTypeTextselection        EntityEntityTypeEnum = "TEXTSELECTION"
)

Set of constants representing the allowable values for EntityEntityTypeEnum

func GetEntityEntityTypeEnumValues 

func GetEntityEntityTypeEnumValues() []EntityEntityTypeEnum

GetEntityEntityTypeEnumValues Enumerates the set of values for EntityEntityTypeEnum

type GenericEntity 

type GenericEntity struct {

	// collection of Label entities
	Labels []Label `mandatory:"true" json:"labels"`

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

GenericEntity This is an extensible entity type for users and the base entity type for some annotation formats

func (GenericEntity) MarshalJSON 

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

MarshalJSON marshals to json representation

func (GenericEntity) String 

func (m GenericEntity) String() string

type GetAnnotationRequest 

type GetAnnotationRequest struct {

	// unique Annotation identifier
	AnnotationId *string `mandatory:"true" contributesTo:"path" name:"annotationId"`

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

GetAnnotationRequest wrapper for the GetAnnotation operation

See also

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

func (GetAnnotationRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetAnnotationRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetAnnotationRequest) RetryPolicy 

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

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

func (GetAnnotationRequest) String 

func (request GetAnnotationRequest) String() string

type GetAnnotationResponse 

type GetAnnotationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetAnnotationResponse wrapper for the GetAnnotation operation

func (GetAnnotationResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetAnnotationResponse) String 

func (response GetAnnotationResponse) 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/datalabelingservicedataplane/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 GetRecordContentRequest 

type GetRecordContentRequest struct {

	// The OCID of the record annotated
	RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

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

GetRecordContentRequest wrapper for the GetRecordContent operation

See also

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

func (GetRecordContentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetRecordContentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetRecordContentRequest) RetryPolicy 

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

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

func (GetRecordContentRequest) String 

func (request GetRecordContentRequest) String() string

type GetRecordContentResponse 

type GetRecordContentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The io.ReadCloser instance
	Content io.ReadCloser `presentIn:"body" encoding:"binary"`

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

	// The content size of the body in bytes.
	ContentLength *int64 `presentIn:"header" name:"content-length"`

	// The content disposition of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 19.5.1.
	ContentDisposition *string `presentIn:"header" name:"content-disposition"`

	// The content type as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.17.
	ContentType *string `presentIn:"header" name:"content-type"`

	// Cache-control allows us to tell browsers to cache assets, how long to store them, and whether to validate them.
	CacheControl *string `presentIn:"header" name:"cache-control"`

	// Flag to indicate whether or not the object was modified.  If this is true,
	// the getter for the object itself will return null.  Callers should check this
	// if they specified one of the request params that might result in a conditional
	// response (like 'if-match'/'if-none-match').
	IsNotModified bool
}

GetRecordContentResponse wrapper for the GetRecordContent operation

func (GetRecordContentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetRecordContentResponse) String 

func (response GetRecordContentResponse) String() string

type GetRecordPreviewContentRequest 

type GetRecordPreviewContentRequest struct {

	// The OCID of the record annotated
	RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"`

	// The client request ID for tracing.
	OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`

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

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

GetRecordPreviewContentRequest wrapper for the GetRecordPreviewContent operation

See also

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

func (GetRecordPreviewContentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetRecordPreviewContentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetRecordPreviewContentRequest) RetryPolicy 

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

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

func (GetRecordPreviewContentRequest) String 

func (request GetRecordPreviewContentRequest) String() string

type GetRecordPreviewContentResponse 

type GetRecordPreviewContentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The io.ReadCloser instance
	Content io.ReadCloser `presentIn:"body" encoding:"binary"`

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

	// The content size of the body in bytes.
	ContentLength *int64 `presentIn:"header" name:"content-length"`

	// The content disposition of the body, as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 19.5.1.
	ContentDisposition *string `presentIn:"header" name:"content-disposition"`

	// The content type as described in RFC 2616 (https://tools.ietf.org/rfc/rfc2616), section 14.17.
	ContentType *string `presentIn:"header" name:"content-type"`

	// Cache-control allows us to tell browsers to cache assets, how long to store them, and whether to validate them.
	CacheControl *string `presentIn:"header" name:"cache-control"`

	// Flag to indicate whether or not the object was modified.  If this is true,
	// the getter for the object itself will return null.  Callers should check this
	// if they specified one of the request params that might result in a conditional
	// response (like 'if-match'/'if-none-match').
	IsNotModified bool
}

GetRecordPreviewContentResponse wrapper for the GetRecordPreviewContent operation

func (GetRecordPreviewContentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetRecordPreviewContentResponse) String 

func (response GetRecordPreviewContentResponse) String() string

type GetRecordRequest 

type GetRecordRequest struct {

	// The OCID of the record annotated
	RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"`

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

GetRecordRequest wrapper for the GetRecord operation

See also

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

func (GetRecordRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetRecordRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetRecordRequest) RetryPolicy 

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

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

func (GetRecordRequest) String 

func (request GetRecordRequest) String() string

type GetRecordResponse 

type GetRecordResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

GetRecordResponse wrapper for the GetRecord operation

func (GetRecordResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetRecordResponse) String 

func (response GetRecordResponse) 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 ImageObjectSelectionEntity 

type ImageObjectSelectionEntity struct {

	// Collection of Label entities
	Labels []Label `mandatory:"true" json:"labels"`

	BoundingPolygon *BoundingPolygon `mandatory:"true" json:"boundingPolygon"`

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

ImageObjectSelectionEntity This allows the labeler to use specify a series of coordinates in the image to represent an object and apply labels to it. The coordinates will be connected in the order that they are provided and the last coordinate in the array will be connected to the first.

func (ImageObjectSelectionEntity) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ImageObjectSelectionEntity) String 

func (m ImageObjectSelectionEntity) 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 {

	// The label provided by the annotator.
	Label *string `mandatory:"true" json:"label"`
}

Label A label is a string value. The API will validate that it's one of the dataset's pre-defined labels. In the future, we'll be able to support a confidence score.

func (Label) String 

func (m Label) String() string

type LabelName 

type LabelName struct {

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

LabelName Represents a label.

func (LabelName) String 

func (m LabelName) String() string

type LabelSet 

type LabelSet struct {

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

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

func (LabelSet) String 

func (m LabelSet) String() string

type ListAnnotationsRequest 

type ListAnnotationsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Filter results by the OCID of the dataset.
	DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"`

	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	LifecycleState AnnotationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// Unique OCID identifier
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// The OCID of the principal who updated the annotation.
	UpdatedBy *string `mandatory:"false" contributesTo:"query" name:"updatedBy"`

	// The OCID of the record annotated
	RecordId *string `mandatory:"false" contributesTo:"query" name:"recordId"`

	// The date and time the resource was created, in the timestamp format defined by RFC3339.
	TimeCreatedGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedGreaterThanOrEqualTo"`

	// The date and time the resource was created, in the timestamp format defined by RFC3339.
	TimeCreatedLessThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeCreatedLessThanOrEqualTo"`

	// 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 ListAnnotationsSortOrderEnum `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. If no value is specified timeCreated is default.
	SortBy ListAnnotationsSortByEnum `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
}

ListAnnotationsRequest wrapper for the ListAnnotations operation

See also

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

func (ListAnnotationsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListAnnotationsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListAnnotationsRequest) RetryPolicy 

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

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

func (ListAnnotationsRequest) String 

func (request ListAnnotationsRequest) String() string

type ListAnnotationsResponse 

type ListAnnotationsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of AnnotationCollection instances
	AnnotationCollection `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"`
}

ListAnnotationsResponse wrapper for the ListAnnotations operation

func (ListAnnotationsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListAnnotationsResponse) String 

func (response ListAnnotationsResponse) String() string

type ListAnnotationsSortByEnum 

type ListAnnotationsSortByEnum string

ListAnnotationsSortByEnum Enum with underlying type: string 

const (
	ListAnnotationsSortByTimecreated ListAnnotationsSortByEnum = "timeCreated"
	ListAnnotationsSortByLabel       ListAnnotationsSortByEnum = "label"
)

Set of constants representing the allowable values for ListAnnotationsSortByEnum

func GetListAnnotationsSortByEnumValues 

func GetListAnnotationsSortByEnumValues() []ListAnnotationsSortByEnum

GetListAnnotationsSortByEnumValues Enumerates the set of values for ListAnnotationsSortByEnum

type ListAnnotationsSortOrderEnum 

type ListAnnotationsSortOrderEnum string

ListAnnotationsSortOrderEnum Enum with underlying type: string 

const (
	ListAnnotationsSortOrderAsc  ListAnnotationsSortOrderEnum = "ASC"
	ListAnnotationsSortOrderDesc ListAnnotationsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListAnnotationsSortOrderEnum

func GetListAnnotationsSortOrderEnumValues 

func GetListAnnotationsSortOrderEnumValues() []ListAnnotationsSortOrderEnum

GetListAnnotationsSortOrderEnumValues Enumerates the set of values for ListAnnotationsSortOrderEnum

type ListRecordsRequest 

type ListRecordsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Filter results by the OCID of the dataset.
	DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"`

	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	LifecycleState RecordLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// Name of the record
	Name *string `mandatory:"false" contributesTo:"query" name:"name"`

	// Unique OCID identifier
	Id *string `mandatory:"false" contributesTo:"query" name:"id"`

	// Whether the record has been labeled and has associated annotations.
	IsLabeled *bool `mandatory:"false" contributesTo:"query" name:"isLabeled"`

	// Allows the user to filter records based on the related annotations.
	AnnotationLabelsContains []string `contributesTo:"query" name:"annotationLabelsContains" collectionFormat:"multi"`

	// 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 ListRecordsSortOrderEnum `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 name is ascending. If no value is specified timeCreated is default.
	SortBy ListRecordsSortByEnum `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
}

ListRecordsRequest wrapper for the ListRecords operation

See also

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

func (ListRecordsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListRecordsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListRecordsRequest) RetryPolicy 

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

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

func (ListRecordsRequest) String 

func (request ListRecordsRequest) String() string

type ListRecordsResponse 

type ListRecordsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of RecordCollection instances
	RecordCollection `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"`
}

ListRecordsResponse wrapper for the ListRecords operation

func (ListRecordsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListRecordsResponse) String 

func (response ListRecordsResponse) String() string

type ListRecordsSortByEnum 

type ListRecordsSortByEnum string

ListRecordsSortByEnum Enum with underlying type: string 

const (
	ListRecordsSortByTimecreated ListRecordsSortByEnum = "timeCreated"
	ListRecordsSortByName        ListRecordsSortByEnum = "name"
)

Set of constants representing the allowable values for ListRecordsSortByEnum

func GetListRecordsSortByEnumValues 

func GetListRecordsSortByEnumValues() []ListRecordsSortByEnum

GetListRecordsSortByEnumValues Enumerates the set of values for ListRecordsSortByEnum

type ListRecordsSortOrderEnum 

type ListRecordsSortOrderEnum string

ListRecordsSortOrderEnum Enum with underlying type: string 

const (
	ListRecordsSortOrderAsc  ListRecordsSortOrderEnum = "ASC"
	ListRecordsSortOrderDesc ListRecordsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListRecordsSortOrderEnum

func GetListRecordsSortOrderEnumValues 

func GetListRecordsSortOrderEnumValues() []ListRecordsSortOrderEnum

GetListRecordsSortOrderEnumValues Enumerates the set of values for ListRecordsSortOrderEnum

type NormalizedVertex 

type NormalizedVertex struct {

	// X axis coordinate
	X *float32 `mandatory:"true" json:"x"`

	// Y axis coordinate
	Y *float32 `mandatory:"true" json:"y"`
}

NormalizedVertex A NormalizedVertex is a cartesian coordinate that represents a corner between two segments of a polygon.

func (NormalizedVertex) String 

func (m NormalizedVertex) String() string

type ObjectStorageDatasetSourceDetails 

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

ObjectStorageDatasetSourceDetails 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 (ObjectStorageDatasetSourceDetails) MarshalJSON 

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

MarshalJSON marshals to json representation

func (ObjectStorageDatasetSourceDetails) String 

func (m ObjectStorageDatasetSourceDetails) String() string

type ObjectStorageSourceDetails 

type ObjectStorageSourceDetails struct {

	// The path relative to the prefix specified in the dataset source details (file name).
	RelativePath *string `mandatory:"true" json:"relativePath"`

	// The full path of the file this record belongs to.
	Path *string `mandatory:"true" json:"path"`

	// The offset into the file containing the content.
	Offset *float32 `mandatory:"false" json:"offset"`

	// The length from offset into the file containing the content.
	Length *float32 `mandatory:"false" json:"length"`
}

ObjectStorageSourceDetails Object Storage Source Details.

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 Record 

type Record struct {

	// The OCID of the record
	Id *string `mandatory:"true" json:"id"`

	// This will be created by Customer. It will be unique and immutable.
	Name *string `mandatory:"true" json:"name"`

	// 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 updated, in the timestamp format defined by RFC3339.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// The OCID of the dataset to associate the record with
	DatasetId *string `mandatory:"true" json:"datasetId"`

	// The OCID of the compartment for the task.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	SourceDetails SourceDetails `mandatory:"true" json:"sourceDetails"`

	// Whether the record has been labeled and has associated annotations.
	IsLabeled *bool `mandatory:"true" json:"isLabeled"`

	// Lifecycle state of the Record.
	// ACTIVE - Record is active and ready for labeling.
	// INACTIVE - Record has been marked as inactive and should not be used for labeling.
	// DELETED - Record has been deleted and no longer available for labeling.
	LifecycleState RecordLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

Record A record represents an entry in a dataset that needs labeling.

func (Record) String 

func (m Record) String() string

func (*Record) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type RecordAggregationDimensions 

type RecordAggregationDimensions struct {

	// Whether the record has been labeled and has associated annotations.
	IsLabeled *bool `mandatory:"false" json:"isLabeled"`

	// Whether the annotation contains label.
	AnnotationLabelContains *string `mandatory:"false" json:"annotationLabelContains"`
}

RecordAggregationDimensions Dimensions to summarize record information for a given dataset

func (RecordAggregationDimensions) String 

func (m RecordAggregationDimensions) String() string

type RecordAnalyticsAggregation 

type RecordAnalyticsAggregation struct {

	// the count of the matching results
	Count *float32 `mandatory:"true" json:"count"`

	// ocid of the dataset the annotation belongs to
	DatasetId *string `mandatory:"true" json:"datasetId"`

	// ocid of the compartment the records
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	Dimensions *RecordAggregationDimensions `mandatory:"false" json:"dimensions"`

	// Describes the lifecycle state.
	LifecycleState RecordLifecycleStateEnum `mandatory:"false" json:"lifecycleState,omitempty"`
}

RecordAnalyticsAggregation Aggregation entities are required by the api consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize record information for a given dataset and will be used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters to the list API we apply would have to show up in the aggregation. We should limit the number of filters and dimensions as much as possible.

func (RecordAnalyticsAggregation) String 

func (m RecordAnalyticsAggregation) String() string

type RecordAnalyticsAggregationCollection 

type RecordAnalyticsAggregationCollection struct {

	// List of Record entities.
	Items []RecordAnalyticsAggregation `mandatory:"true" json:"items"`
}

RecordAnalyticsAggregationCollection Collection of records aggregated.

func (RecordAnalyticsAggregationCollection) String 

func (m RecordAnalyticsAggregationCollection) String() string

type RecordCollection 

type RecordCollection struct {

	// List of records.
	Items []RecordSummary `mandatory:"true" json:"items"`
}

RecordCollection Results of a record search. Contains both RecordSummary items and other data.

func (RecordCollection) String 

func (m RecordCollection) String() string

type RecordLifecycleStateEnum 

type RecordLifecycleStateEnum string

RecordLifecycleStateEnum Enum with underlying type: string 

const (
	RecordLifecycleStateActive   RecordLifecycleStateEnum = "ACTIVE"
	RecordLifecycleStateInactive RecordLifecycleStateEnum = "INACTIVE"
	RecordLifecycleStateDeleted  RecordLifecycleStateEnum = "DELETED"
)

Set of constants representing the allowable values for RecordLifecycleStateEnum

func GetRecordLifecycleStateEnumValues 

func GetRecordLifecycleStateEnumValues() []RecordLifecycleStateEnum

GetRecordLifecycleStateEnumValues Enumerates the set of values for RecordLifecycleStateEnum

type RecordSummary 

type RecordSummary struct {

	// The OCID of the record
	Id *string `mandatory:"true" json:"id"`

	// This will be automatically assigned by the service. It will be unique and immutable
	Name *string `mandatory:"true" json:"name"`

	// 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 updated, in the timestamp format defined by RFC3339.
	TimeUpdated *common.SDKTime `mandatory:"true" json:"timeUpdated"`

	// The OCID of the dataset to associate the record with
	DatasetId *string `mandatory:"true" json:"datasetId"`

	// The OCID of the compartment for the task.
	CompartmentId *string `mandatory:"true" json:"compartmentId"`

	// Whether the record has been labeled and has associated annotations.
	IsLabeled *bool `mandatory:"true" json:"isLabeled"`

	// Describes the lifecycle state.
	LifecycleState RecordLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`

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

RecordSummary A record summary is the representation returned in list views. It is usually a subset of the full record entity and should not contain any potentially sensitive information.

func (RecordSummary) String 

func (m RecordSummary) String() string

type SortOrdersEnum 

type SortOrdersEnum string

SortOrdersEnum Enum with underlying type: string 

const (
	SortOrdersAsc  SortOrdersEnum = "ASC"
	SortOrdersDesc SortOrdersEnum = "DESC"
)

Set of constants representing the allowable values for SortOrdersEnum

func GetSortOrdersEnumValues 

func GetSortOrdersEnumValues() []SortOrdersEnum

GetSortOrdersEnumValues Enumerates the set of values for SortOrdersEnum

type SourceDetails 

type SourceDetails interface {
}

SourceDetails The source information is a polymorphic entity. It captures the details of data used for record creation. The discriminator type must match the dataset's source type. The convention will be enforced by the API.

type SourceDetailsSourceTypeEnum 

type SourceDetailsSourceTypeEnum string

SourceDetailsSourceTypeEnum Enum with underlying type: string 

const (
	SourceDetailsSourceTypeObjectStorage SourceDetailsSourceTypeEnum = "OBJECT_STORAGE"
)

Set of constants representing the allowable values for SourceDetailsSourceTypeEnum

func GetSourceDetailsSourceTypeEnumValues 

func GetSourceDetailsSourceTypeEnumValues() []SourceDetailsSourceTypeEnum

GetSourceDetailsSourceTypeEnumValues Enumerates the set of values for SourceDetailsSourceTypeEnum

type SummarizeAnnotationAnalyticsAnnotationGroupByEnum 

type SummarizeAnnotationAnalyticsAnnotationGroupByEnum string

SummarizeAnnotationAnalyticsAnnotationGroupByEnum Enum with underlying type: string 

const (
	SummarizeAnnotationAnalyticsAnnotationGroupByUpdatedby SummarizeAnnotationAnalyticsAnnotationGroupByEnum = "updatedBy"
	SummarizeAnnotationAnalyticsAnnotationGroupByLabel     SummarizeAnnotationAnalyticsAnnotationGroupByEnum = "label"
)

Set of constants representing the allowable values for SummarizeAnnotationAnalyticsAnnotationGroupByEnum

func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues 

func GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues() []SummarizeAnnotationAnalyticsAnnotationGroupByEnum

GetSummarizeAnnotationAnalyticsAnnotationGroupByEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsAnnotationGroupByEnum

type SummarizeAnnotationAnalyticsRequest 

type SummarizeAnnotationAnalyticsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Filter results by the OCID of the dataset.
	DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"`

	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	LifecycleState AnnotationLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// This field is used to summarize annotations with specified label.
	Label *string `mandatory:"false" contributesTo:"query" name:"label"`

	// 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 SummarizeAnnotationAnalyticsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified updatedBy is default.
	SortBy SummarizeAnnotationAnalyticsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The field to group by. If no value is specified updatedBy is default.
	AnnotationGroupBy SummarizeAnnotationAnalyticsAnnotationGroupByEnum `mandatory:"false" contributesTo:"query" name:"annotationGroupBy" 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
}

SummarizeAnnotationAnalyticsRequest wrapper for the SummarizeAnnotationAnalytics operation

See also

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

func (SummarizeAnnotationAnalyticsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (SummarizeAnnotationAnalyticsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (SummarizeAnnotationAnalyticsRequest) RetryPolicy 

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

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

func (SummarizeAnnotationAnalyticsRequest) String 

func (request SummarizeAnnotationAnalyticsRequest) String() string

type SummarizeAnnotationAnalyticsResponse 

type SummarizeAnnotationAnalyticsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of AnnotationAnalyticsAggregationCollection instances
	AnnotationAnalyticsAggregationCollection `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"`
}

SummarizeAnnotationAnalyticsResponse wrapper for the SummarizeAnnotationAnalytics operation

func (SummarizeAnnotationAnalyticsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (SummarizeAnnotationAnalyticsResponse) String 

func (response SummarizeAnnotationAnalyticsResponse) String() string

type SummarizeAnnotationAnalyticsSortByEnum 

type SummarizeAnnotationAnalyticsSortByEnum string

SummarizeAnnotationAnalyticsSortByEnum Enum with underlying type: string 

const (
	SummarizeAnnotationAnalyticsSortByCount     SummarizeAnnotationAnalyticsSortByEnum = "count"
	SummarizeAnnotationAnalyticsSortByLabel     SummarizeAnnotationAnalyticsSortByEnum = "label"
	SummarizeAnnotationAnalyticsSortByUpdatedby SummarizeAnnotationAnalyticsSortByEnum = "updatedBy"
)

Set of constants representing the allowable values for SummarizeAnnotationAnalyticsSortByEnum

func GetSummarizeAnnotationAnalyticsSortByEnumValues 

func GetSummarizeAnnotationAnalyticsSortByEnumValues() []SummarizeAnnotationAnalyticsSortByEnum

GetSummarizeAnnotationAnalyticsSortByEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsSortByEnum

type SummarizeAnnotationAnalyticsSortOrderEnum 

type SummarizeAnnotationAnalyticsSortOrderEnum string

SummarizeAnnotationAnalyticsSortOrderEnum Enum with underlying type: string 

const (
	SummarizeAnnotationAnalyticsSortOrderAsc  SummarizeAnnotationAnalyticsSortOrderEnum = "ASC"
	SummarizeAnnotationAnalyticsSortOrderDesc SummarizeAnnotationAnalyticsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SummarizeAnnotationAnalyticsSortOrderEnum

func GetSummarizeAnnotationAnalyticsSortOrderEnumValues 

func GetSummarizeAnnotationAnalyticsSortOrderEnumValues() []SummarizeAnnotationAnalyticsSortOrderEnum

GetSummarizeAnnotationAnalyticsSortOrderEnumValues Enumerates the set of values for SummarizeAnnotationAnalyticsSortOrderEnum

type SummarizeRecordAnalyticsRecordGroupByEnum 

type SummarizeRecordAnalyticsRecordGroupByEnum string

SummarizeRecordAnalyticsRecordGroupByEnum Enum with underlying type: string 

const (
	SummarizeRecordAnalyticsRecordGroupByIslabeled               SummarizeRecordAnalyticsRecordGroupByEnum = "isLabeled"
	SummarizeRecordAnalyticsRecordGroupByAnnotationlabelcontains SummarizeRecordAnalyticsRecordGroupByEnum = "annotationLabelContains"
)

Set of constants representing the allowable values for SummarizeRecordAnalyticsRecordGroupByEnum

func GetSummarizeRecordAnalyticsRecordGroupByEnumValues 

func GetSummarizeRecordAnalyticsRecordGroupByEnumValues() []SummarizeRecordAnalyticsRecordGroupByEnum

GetSummarizeRecordAnalyticsRecordGroupByEnumValues Enumerates the set of values for SummarizeRecordAnalyticsRecordGroupByEnum

type SummarizeRecordAnalyticsRequest 

type SummarizeRecordAnalyticsRequest struct {

	// The ID of the compartment in which to list resources.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Filter results by the OCID of the dataset.
	DatasetId *string `mandatory:"true" contributesTo:"query" name:"datasetId"`

	// A filter to return only resources their lifecycleState matches the given lifecycleState.
	LifecycleState RecordLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"lifecycleState" omitEmpty:"true"`

	// 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 SummarizeRecordAnalyticsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

	// The field to group by. If no value is specified isLabeled is default.
	RecordGroupBy SummarizeRecordAnalyticsRecordGroupByEnum `mandatory:"false" contributesTo:"query" name:"recordGroupBy" omitEmpty:"true"`

	// The field to sort by. Only one sort order may be provided. Default order is descending. If no value is specified count is default.
	SortBy SummarizeRecordAnalyticsSortByEnum `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
}

SummarizeRecordAnalyticsRequest wrapper for the SummarizeRecordAnalytics operation

See also

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

func (SummarizeRecordAnalyticsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (SummarizeRecordAnalyticsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (SummarizeRecordAnalyticsRequest) RetryPolicy 

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

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

func (SummarizeRecordAnalyticsRequest) String 

func (request SummarizeRecordAnalyticsRequest) String() string

type SummarizeRecordAnalyticsResponse 

type SummarizeRecordAnalyticsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of RecordAnalyticsAggregationCollection instances
	RecordAnalyticsAggregationCollection `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"`
}

SummarizeRecordAnalyticsResponse wrapper for the SummarizeRecordAnalytics operation

func (SummarizeRecordAnalyticsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (SummarizeRecordAnalyticsResponse) String 

func (response SummarizeRecordAnalyticsResponse) String() string

type SummarizeRecordAnalyticsSortByEnum 

type SummarizeRecordAnalyticsSortByEnum string

SummarizeRecordAnalyticsSortByEnum Enum with underlying type: string 

const (
	SummarizeRecordAnalyticsSortByCount     SummarizeRecordAnalyticsSortByEnum = "count"
	SummarizeRecordAnalyticsSortByIslabeled SummarizeRecordAnalyticsSortByEnum = "isLabeled"
)

Set of constants representing the allowable values for SummarizeRecordAnalyticsSortByEnum

func GetSummarizeRecordAnalyticsSortByEnumValues 

func GetSummarizeRecordAnalyticsSortByEnumValues() []SummarizeRecordAnalyticsSortByEnum

GetSummarizeRecordAnalyticsSortByEnumValues Enumerates the set of values for SummarizeRecordAnalyticsSortByEnum

type SummarizeRecordAnalyticsSortOrderEnum 

type SummarizeRecordAnalyticsSortOrderEnum string

SummarizeRecordAnalyticsSortOrderEnum Enum with underlying type: string 

const (
	SummarizeRecordAnalyticsSortOrderAsc  SummarizeRecordAnalyticsSortOrderEnum = "ASC"
	SummarizeRecordAnalyticsSortOrderDesc SummarizeRecordAnalyticsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for SummarizeRecordAnalyticsSortOrderEnum

func GetSummarizeRecordAnalyticsSortOrderEnumValues 

func GetSummarizeRecordAnalyticsSortOrderEnumValues() []SummarizeRecordAnalyticsSortOrderEnum

GetSummarizeRecordAnalyticsSortOrderEnumValues Enumerates the set of values for SummarizeRecordAnalyticsSortOrderEnum

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 TextSelectionEntity 

type TextSelectionEntity struct {

	// Collection of Label entities
	Labels []Label `mandatory:"true" json:"labels"`

	TextSpan *TextSpan `mandatory:"true" json:"textSpan"`

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

TextSelectionEntity This allows the labeler to highlight text by specifying an offset and a length and apply labels to it.

func (TextSelectionEntity) MarshalJSON 

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

MarshalJSON marshals to json representation

func (TextSelectionEntity) String 

func (m TextSelectionEntity) String() string

type TextSpan 

type TextSpan struct {

	// Offset of the selected text within the entire text.
	Offset *float32 `mandatory:"false" json:"offset"`

	// Length of the selected text.
	Length *float32 `mandatory:"false" json:"length"`
}

TextSpan A wrapper class for offset and length, which together represent a span of text in a text document.

func (TextSpan) String 

func (m TextSpan) String() string

type UpdateAnnotationDetails 

type UpdateAnnotationDetails struct {

	// The entity types will be validated against the dataset to ensure consistency.
	Entities []Entity `mandatory:"false" json:"entities"`

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

UpdateAnnotationDetails This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an Annotation for a record.

func (UpdateAnnotationDetails) String 

func (m UpdateAnnotationDetails) String() string

func (*UpdateAnnotationDetails) UnmarshalJSON 

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

UnmarshalJSON unmarshals from json

type UpdateAnnotationRequest 

type UpdateAnnotationRequest struct {

	// unique Annotation identifier
	AnnotationId *string `mandatory:"true" contributesTo:"path" name:"annotationId"`

	// Information to be updated.
	UpdateAnnotationDetails `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
}

UpdateAnnotationRequest wrapper for the UpdateAnnotation operation

See also

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

func (UpdateAnnotationRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateAnnotationRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateAnnotationRequest) RetryPolicy 

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

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

func (UpdateAnnotationRequest) String 

func (request UpdateAnnotationRequest) String() string

type UpdateAnnotationResponse 

type UpdateAnnotationResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

UpdateAnnotationResponse wrapper for the UpdateAnnotation operation

func (UpdateAnnotationResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateAnnotationResponse) String 

func (response UpdateAnnotationResponse) String() string

type UpdateRecordDetails 

type UpdateRecordDetails struct {

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

UpdateRecordDetails Assuming we support tags, tags are supposed to be updatable.

func (UpdateRecordDetails) String 

func (m UpdateRecordDetails) String() string

type UpdateRecordRequest 

type UpdateRecordRequest struct {

	// The OCID of the record annotated
	RecordId *string `mandatory:"true" contributesTo:"path" name:"recordId"`

	// Information to be updated.
	UpdateRecordDetails `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
}

UpdateRecordRequest wrapper for the UpdateRecord operation

See also

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

func (UpdateRecordRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateRecordRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateRecordRequest) RetryPolicy 

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

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

func (UpdateRecordRequest) String 

func (request UpdateRecordRequest) String() string

type UpdateRecordResponse 

type UpdateRecordResponse struct {

	// The underlying http response
	RawResponse *http.Response

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

UpdateRecordResponse wrapper for the UpdateRecord operation

func (UpdateRecordResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateRecordResponse) String 

func (response UpdateRecordResponse) 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.