Package datalabeling is an auto-generated package for the Data Labeling API.
Public API for Google Cloud AI Data Labeling Service.
NOTE: This package is in beta. It is not stable, and may be subject to changes.
Use of Context
The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
Functions
func DefaultAuthScopes
func DefaultAuthScopes() [] string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
AnnotatedDatasetIterator
type AnnotatedDatasetIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. AnnotatedDataset
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
AnnotatedDatasetIterator manages a stream of *datalabelingpb.AnnotatedDataset.
func (*AnnotatedDatasetIterator) Next
func (it * AnnotatedDatasetIterator
) Next() (* datalabelingpb
. AnnotatedDataset
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*AnnotatedDatasetIterator) PageInfo
func (it * AnnotatedDatasetIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
AnnotationSpecSetIterator
type AnnotationSpecSetIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. AnnotationSpecSet
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
AnnotationSpecSetIterator manages a stream of *datalabelingpb.AnnotationSpecSet.
func (*AnnotationSpecSetIterator) Next
func (it * AnnotationSpecSetIterator
) Next() (* datalabelingpb
. AnnotationSpecSet
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*AnnotationSpecSetIterator) PageInfo
func (it * AnnotationSpecSetIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CallOptions
type CallOptions struct {
CreateDataset [] gax
. CallOption
GetDataset [] gax
. CallOption
ListDatasets [] gax
. CallOption
DeleteDataset [] gax
. CallOption
ImportData [] gax
. CallOption
ExportData [] gax
. CallOption
GetDataItem [] gax
. CallOption
ListDataItems [] gax
. CallOption
GetAnnotatedDataset [] gax
. CallOption
ListAnnotatedDatasets [] gax
. CallOption
DeleteAnnotatedDataset [] gax
. CallOption
LabelImage [] gax
. CallOption
LabelVideo [] gax
. CallOption
LabelText [] gax
. CallOption
GetExample [] gax
. CallOption
ListExamples [] gax
. CallOption
CreateAnnotationSpecSet [] gax
. CallOption
GetAnnotationSpecSet [] gax
. CallOption
ListAnnotationSpecSets [] gax
. CallOption
DeleteAnnotationSpecSet [] gax
. CallOption
CreateInstruction [] gax
. CallOption
GetInstruction [] gax
. CallOption
ListInstructions [] gax
. CallOption
DeleteInstruction [] gax
. CallOption
GetEvaluation [] gax
. CallOption
SearchEvaluations [] gax
. CallOption
SearchExampleComparisons [] gax
. CallOption
CreateEvaluationJob [] gax
. CallOption
UpdateEvaluationJob [] gax
. CallOption
GetEvaluationJob [] gax
. CallOption
PauseEvaluationJob [] gax
. CallOption
ResumeEvaluationJob [] gax
. CallOption
DeleteEvaluationJob [] gax
. CallOption
ListEvaluationJobs [] gax
. CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type Client struct {
// The call options for this service.
CallOptions * CallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient * lroauto
. OperationsClient
// contains filtered or unexported fields
}
Client is a client for interacting with Data Labeling API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Service for the AI Platform Data Labeling API.
func NewClient
NewClient creates a new data labeling service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Service for the AI Platform Data Labeling API.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
func (c * Client
) Connection() * grpc
. ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) CreateAnnotationSpecSet
func (c * Client
) CreateAnnotationSpecSet(ctx context
. Context
, req * datalabelingpb
. CreateAnnotationSpecSetRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotationSpecSet
, error
)
CreateAnnotationSpecSet creates an annotation spec set by providing a set of labels.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.CreateAnnotationSpecSetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateAnnotationSpecSet(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) CreateDataset
func (c * Client
) CreateDataset(ctx context
. Context
, req * datalabelingpb
. CreateDatasetRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. Dataset
, error
)
CreateDataset creates dataset. If success return a Dataset resource.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.CreateDatasetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) CreateEvaluationJob
func (c * Client
) CreateEvaluationJob(ctx context
. Context
, req * datalabelingpb
. CreateEvaluationJobRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. EvaluationJob
, error
)
CreateEvaluationJob creates an evaluation job.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.CreateEvaluationJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateEvaluationJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) CreateInstruction
func (c * Client
) CreateInstruction(ctx context
. Context
, req * datalabelingpb
. CreateInstructionRequest
, opts ... gax
. CallOption
) (* CreateInstructionOperation
, error
)
CreateInstruction creates an instruction for how data should be labeled.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.CreateInstructionRequest{
// TODO: Fill request struct fields.
}
op, err := c.CreateInstruction(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) CreateInstructionOperation
func (c * Client
) CreateInstructionOperation(name string
) * CreateInstructionOperation
CreateInstructionOperation returns a new CreateInstructionOperation from a given name. The name must be that of a previously created CreateInstructionOperation, possibly from a different process.
func (*Client) DeleteAnnotatedDataset
func (c * Client
) DeleteAnnotatedDataset(ctx context
. Context
, req * datalabelingpb
. DeleteAnnotatedDatasetRequest
, opts ... gax
. CallOption
) error
DeleteAnnotatedDataset deletes an annotated dataset by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.DeleteAnnotatedDatasetRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteAnnotatedDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) DeleteAnnotationSpecSet
func (c * Client
) DeleteAnnotationSpecSet(ctx context
. Context
, req * datalabelingpb
. DeleteAnnotationSpecSetRequest
, opts ... gax
. CallOption
) error
DeleteAnnotationSpecSet deletes an annotation spec set by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.DeleteAnnotationSpecSetRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteAnnotationSpecSet(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) DeleteDataset
func (c * Client
) DeleteDataset(ctx context
. Context
, req * datalabelingpb
. DeleteDatasetRequest
, opts ... gax
. CallOption
) error
DeleteDataset deletes a dataset by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.DeleteDatasetRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) DeleteEvaluationJob
func (c * Client
) DeleteEvaluationJob(ctx context
. Context
, req * datalabelingpb
. DeleteEvaluationJobRequest
, opts ... gax
. CallOption
) error
DeleteEvaluationJob stops and deletes an evaluation job.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.DeleteEvaluationJobRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteEvaluationJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) DeleteInstruction
func (c * Client
) DeleteInstruction(ctx context
. Context
, req * datalabelingpb
. DeleteInstructionRequest
, opts ... gax
. CallOption
) error
DeleteInstruction deletes an instruction object by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.DeleteInstructionRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteInstruction(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) ExportData
func (c * Client
) ExportData(ctx context
. Context
, req * datalabelingpb
. ExportDataRequest
, opts ... gax
. CallOption
) (* ExportDataOperation
, error
)
ExportData exports data and annotations from dataset.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ExportDataRequest{
// TODO: Fill request struct fields.
}
op, err := c.ExportData(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ExportDataOperation
func (c * Client
) ExportDataOperation(name string
) * ExportDataOperation
ExportDataOperation returns a new ExportDataOperation from a given name. The name must be that of a previously created ExportDataOperation, possibly from a different process.
func (*Client) GetAnnotatedDataset
func (c * Client
) GetAnnotatedDataset(ctx context
. Context
, req * datalabelingpb
. GetAnnotatedDatasetRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotatedDataset
, error
)
GetAnnotatedDataset gets an annotated dataset by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.GetAnnotatedDatasetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetAnnotatedDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetAnnotationSpecSet
func (c * Client
) GetAnnotationSpecSet(ctx context
. Context
, req * datalabelingpb
. GetAnnotationSpecSetRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotationSpecSet
, error
)
GetAnnotationSpecSet gets an annotation spec set by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.GetAnnotationSpecSetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetAnnotationSpecSet(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetDataItem
func (c * Client
) GetDataItem(ctx context
. Context
, req * datalabelingpb
. GetDataItemRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. DataItem
, error
)
GetDataItem gets a data item in a dataset by resource name. This API can be called after data are imported into dataset.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.GetDataItemRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetDataItem(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetDataset
func (c * Client
) GetDataset(ctx context
. Context
, req * datalabelingpb
. GetDatasetRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. Dataset
, error
)
GetDataset gets dataset by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.GetDatasetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetEvaluation
func (c * Client
) GetEvaluation(ctx context
. Context
, req * datalabelingpb
. GetEvaluationRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. Evaluation
, error
)
GetEvaluation gets an evaluation by resource name (to search, use projects.evaluations.search).
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.GetEvaluationRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetEvaluation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetEvaluationJob
func (c * Client
) GetEvaluationJob(ctx context
. Context
, req * datalabelingpb
. GetEvaluationJobRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. EvaluationJob
, error
)
GetEvaluationJob gets an evaluation job by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.GetEvaluationJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetEvaluationJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetExample
func (c * Client
) GetExample(ctx context
. Context
, req * datalabelingpb
. GetExampleRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. Example
, error
)
GetExample gets an example by resource name, including both data and annotation.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.GetExampleRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetExample(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) GetInstruction
func (c * Client
) GetInstruction(ctx context
. Context
, req * datalabelingpb
. GetInstructionRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. Instruction
, error
)
GetInstruction gets an instruction by resource name.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.GetInstructionRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetInstruction(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ImportData
func (c * Client
) ImportData(ctx context
. Context
, req * datalabelingpb
. ImportDataRequest
, opts ... gax
. CallOption
) (* ImportDataOperation
, error
)
ImportData imports data into dataset based on source locations defined in request. It can be called multiple times for the same dataset. Each dataset can only have one long running operation running on it. For example, no labeling task (also long running operation) can be started while importing is still ongoing. Vice versa.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ImportDataRequest{
// TODO: Fill request struct fields.
}
op, err := c.ImportData(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) ImportDataOperation
func (c * Client
) ImportDataOperation(name string
) * ImportDataOperation
ImportDataOperation returns a new ImportDataOperation from a given name. The name must be that of a previously created ImportDataOperation, possibly from a different process.
func (*Client) LabelImage
func (c * Client
) LabelImage(ctx context
. Context
, req * datalabelingpb
. LabelImageRequest
, opts ... gax
. CallOption
) (* LabelImageOperation
, error
)
LabelImage starts a labeling task for image. The type of image labeling task is configured by feature in the request.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.LabelImageRequest{
// TODO: Fill request struct fields.
}
op, err := c.LabelImage(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) LabelImageOperation
func (c * Client
) LabelImageOperation(name string
) * LabelImageOperation
LabelImageOperation returns a new LabelImageOperation from a given name. The name must be that of a previously created LabelImageOperation, possibly from a different process.
func (*Client) LabelText
func (c * Client
) LabelText(ctx context
. Context
, req * datalabelingpb
. LabelTextRequest
, opts ... gax
. CallOption
) (* LabelTextOperation
, error
)
LabelText starts a labeling task for text. The type of text labeling task is configured by feature in the request.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.LabelTextRequest{
// TODO: Fill request struct fields.
}
op, err := c.LabelText(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) LabelTextOperation
func (c * Client
) LabelTextOperation(name string
) * LabelTextOperation
LabelTextOperation returns a new LabelTextOperation from a given name. The name must be that of a previously created LabelTextOperation, possibly from a different process.
func (*Client) LabelVideo
func (c * Client
) LabelVideo(ctx context
. Context
, req * datalabelingpb
. LabelVideoRequest
, opts ... gax
. CallOption
) (* LabelVideoOperation
, error
)
LabelVideo starts a labeling task for video. The type of video labeling task is configured by feature in the request.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.LabelVideoRequest{
// TODO: Fill request struct fields.
}
op, err := c.LabelVideo(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*Client) LabelVideoOperation
func (c * Client
) LabelVideoOperation(name string
) * LabelVideoOperation
LabelVideoOperation returns a new LabelVideoOperation from a given name. The name must be that of a previously created LabelVideoOperation, possibly from a different process.
func (*Client) ListAnnotatedDatasets
func (c * Client
) ListAnnotatedDatasets(ctx context
. Context
, req * datalabelingpb
. ListAnnotatedDatasetsRequest
, opts ... gax
. CallOption
) * AnnotatedDatasetIterator
ListAnnotatedDatasets lists annotated datasets for a dataset. Pagination is supported.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ListAnnotatedDatasetsRequest{
// TODO: Fill request struct fields.
}
it := c.ListAnnotatedDatasets(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListAnnotationSpecSets
func (c * Client
) ListAnnotationSpecSets(ctx context
. Context
, req * datalabelingpb
. ListAnnotationSpecSetsRequest
, opts ... gax
. CallOption
) * AnnotationSpecSetIterator
ListAnnotationSpecSets lists annotation spec sets for a project. Pagination is supported.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ListAnnotationSpecSetsRequest{
// TODO: Fill request struct fields.
}
it := c.ListAnnotationSpecSets(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListDataItems
func (c * Client
) ListDataItems(ctx context
. Context
, req * datalabelingpb
. ListDataItemsRequest
, opts ... gax
. CallOption
) * DataItemIterator
ListDataItems lists data items in a dataset. This API can be called after data are imported into dataset. Pagination is supported.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ListDataItemsRequest{
// TODO: Fill request struct fields.
}
it := c.ListDataItems(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListDatasets
func (c * Client
) ListDatasets(ctx context
. Context
, req * datalabelingpb
. ListDatasetsRequest
, opts ... gax
. CallOption
) * DatasetIterator
ListDatasets lists datasets under a project. Pagination is supported.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ListDatasetsRequest{
// TODO: Fill request struct fields.
}
it := c.ListDatasets(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListEvaluationJobs
func (c * Client
) ListEvaluationJobs(ctx context
. Context
, req * datalabelingpb
. ListEvaluationJobsRequest
, opts ... gax
. CallOption
) * EvaluationJobIterator
ListEvaluationJobs lists all evaluation jobs within a project with possible filters. Pagination is supported.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ListEvaluationJobsRequest{
// TODO: Fill request struct fields.
}
it := c.ListEvaluationJobs(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListExamples
func (c * Client
) ListExamples(ctx context
. Context
, req * datalabelingpb
. ListExamplesRequest
, opts ... gax
. CallOption
) * ExampleIterator
ListExamples lists examples in an annotated dataset. Pagination is supported.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ListExamplesRequest{
// TODO: Fill request struct fields.
}
it := c.ListExamples(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) ListInstructions
func (c * Client
) ListInstructions(ctx context
. Context
, req * datalabelingpb
. ListInstructionsRequest
, opts ... gax
. CallOption
) * InstructionIterator
ListInstructions lists instructions for a project. Pagination is supported.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ListInstructionsRequest{
// TODO: Fill request struct fields.
}
it := c.ListInstructions(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) PauseEvaluationJob
func (c * Client
) PauseEvaluationJob(ctx context
. Context
, req * datalabelingpb
. PauseEvaluationJobRequest
, opts ... gax
. CallOption
) error
PauseEvaluationJob pauses an evaluation job. Pausing an evaluation job that is already in a PAUSED state is a no-op.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.PauseEvaluationJobRequest{
// TODO: Fill request struct fields.
}
err = c.PauseEvaluationJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) ResumeEvaluationJob
func (c * Client
) ResumeEvaluationJob(ctx context
. Context
, req * datalabelingpb
. ResumeEvaluationJobRequest
, opts ... gax
. CallOption
) error
ResumeEvaluationJob resumes a paused evaluation job. A deleted evaluation job can’t be resumed. Resuming a running or scheduled evaluation job is a no-op.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.ResumeEvaluationJobRequest{
// TODO: Fill request struct fields.
}
err = c.ResumeEvaluationJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*Client) SearchEvaluations
func (c * Client
) SearchEvaluations(ctx context
. Context
, req * datalabelingpb
. SearchEvaluationsRequest
, opts ... gax
. CallOption
) * EvaluationIterator
SearchEvaluations searches evaluations within a project.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.SearchEvaluationsRequest{
// TODO: Fill request struct fields.
}
it := c.SearchEvaluations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) SearchExampleComparisons
func (c * Client
) SearchExampleComparisons(ctx context
. Context
, req * datalabelingpb
. SearchExampleComparisonsRequest
, opts ... gax
. CallOption
) * SearchExampleComparisonsResponse_ExampleComparisonIterator
SearchExampleComparisons searches example comparisons from an evaluation. The return format is a list of example comparisons that show ground truth and prediction(s) for a single input. Search by providing an evaluation ID.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
"google.golang.org/api/iterator"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.SearchExampleComparisonsRequest{
// TODO: Fill request struct fields.
}
it := c.SearchExampleComparisons(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*Client) UpdateEvaluationJob
func (c * Client
) UpdateEvaluationJob(ctx context
. Context
, req * datalabelingpb
. UpdateEvaluationJobRequest
, opts ... gax
. CallOption
) (* datalabelingpb
. EvaluationJob
, error
)
UpdateEvaluationJob updates an evaluation job. You can only update certain fields of the job’s EvaluationJobConfig: humanAnnotationConfig.instruction, exampleCount, and exampleSamplePercentage.
If you want to change any other aspect of the evaluation job, you must delete the job and create a new one.
Example
package main
import (
datalabeling "cloud.google.com/go/datalabeling/apiv1beta1"
"context"
datalabelingpb "google.golang.org/genproto/googleapis/cloud/datalabeling/v1beta1"
)
func main() {
ctx := context.Background()
c, err := datalabeling.NewClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &datalabelingpb.UpdateEvaluationJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateEvaluationJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
CreateInstructionOperation
type CreateInstructionOperation struct {
// contains filtered or unexported fields
}
CreateInstructionOperation manages a long-running operation from CreateInstruction.
func (*CreateInstructionOperation) Done
func (op * CreateInstructionOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateInstructionOperation) Metadata
func (op * CreateInstructionOperation
) Metadata() (* datalabelingpb
. CreateInstructionMetadata
, error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateInstructionOperation) Name
func (op * CreateInstructionOperation
) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateInstructionOperation) Poll
func (op * CreateInstructionOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. Instruction
, error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateInstructionOperation) Wait
func (op * CreateInstructionOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. Instruction
, error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DataItemIterator
type DataItemIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. DataItem
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
DataItemIterator manages a stream of *datalabelingpb.DataItem.
func (*DataItemIterator) Next
func (it * DataItemIterator
) Next() (* datalabelingpb
. DataItem
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DataItemIterator) PageInfo
func (it * DataItemIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
DatasetIterator
type DatasetIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. Dataset
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
DatasetIterator manages a stream of *datalabelingpb.Dataset.
func (*DatasetIterator) Next
func (it * DatasetIterator
) Next() (* datalabelingpb
. Dataset
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*DatasetIterator) PageInfo
func (it * DatasetIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
EvaluationIterator
type EvaluationIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. Evaluation
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
EvaluationIterator manages a stream of *datalabelingpb.Evaluation.
func (*EvaluationIterator) Next
func (it * EvaluationIterator
) Next() (* datalabelingpb
. Evaluation
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EvaluationIterator) PageInfo
func (it * EvaluationIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
EvaluationJobIterator
type EvaluationJobIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. EvaluationJob
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
EvaluationJobIterator manages a stream of *datalabelingpb.EvaluationJob.
func (*EvaluationJobIterator) Next
func (it * EvaluationJobIterator
) Next() (* datalabelingpb
. EvaluationJob
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*EvaluationJobIterator) PageInfo
func (it * EvaluationJobIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ExampleIterator
type ExampleIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. Example
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
ExampleIterator manages a stream of *datalabelingpb.Example.
func (*ExampleIterator) Next
func (it * ExampleIterator
) Next() (* datalabelingpb
. Example
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ExampleIterator) PageInfo
func (it * ExampleIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ExportDataOperation
type ExportDataOperation struct {
// contains filtered or unexported fields
}
ExportDataOperation manages a long-running operation from ExportData.
func (*ExportDataOperation) Done
func (op * ExportDataOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*ExportDataOperation) Metadata
func (op * ExportDataOperation
) Metadata() (* datalabelingpb
. ExportDataOperationMetadata
, error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ExportDataOperation) Name
func (op * ExportDataOperation
) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ExportDataOperation) Poll
func (op * ExportDataOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. ExportDataOperationResponse
, error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ExportDataOperation) Wait
func (op * ExportDataOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. ExportDataOperationResponse
, error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
ImportDataOperation
type ImportDataOperation struct {
// contains filtered or unexported fields
}
ImportDataOperation manages a long-running operation from ImportData.
func (*ImportDataOperation) Done
func (op * ImportDataOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*ImportDataOperation) Metadata
func (op * ImportDataOperation
) Metadata() (* datalabelingpb
. ImportDataOperationMetadata
, error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ImportDataOperation) Name
func (op * ImportDataOperation
) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ImportDataOperation) Poll
func (op * ImportDataOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. ImportDataOperationResponse
, error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ImportDataOperation) Wait
func (op * ImportDataOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. ImportDataOperationResponse
, error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
InstructionIterator
type InstructionIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. Instruction
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
InstructionIterator manages a stream of *datalabelingpb.Instruction.
func (*InstructionIterator) Next
func (it * InstructionIterator
) Next() (* datalabelingpb
. Instruction
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*InstructionIterator) PageInfo
func (it * InstructionIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
LabelImageOperation
type LabelImageOperation struct {
// contains filtered or unexported fields
}
LabelImageOperation manages a long-running operation from LabelImage.
func (*LabelImageOperation) Done
func (op * LabelImageOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*LabelImageOperation) Metadata
func (op * LabelImageOperation
) Metadata() (* datalabelingpb
. LabelOperationMetadata
, error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*LabelImageOperation) Name
func (op * LabelImageOperation
) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*LabelImageOperation) Poll
func (op * LabelImageOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotatedDataset
, error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*LabelImageOperation) Wait
func (op * LabelImageOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotatedDataset
, error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
LabelTextOperation
type LabelTextOperation struct {
// contains filtered or unexported fields
}
LabelTextOperation manages a long-running operation from LabelText.
func (*LabelTextOperation) Done
func (op * LabelTextOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*LabelTextOperation) Metadata
func (op * LabelTextOperation
) Metadata() (* datalabelingpb
. LabelOperationMetadata
, error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*LabelTextOperation) Name
func (op * LabelTextOperation
) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*LabelTextOperation) Poll
func (op * LabelTextOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotatedDataset
, error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*LabelTextOperation) Wait
func (op * LabelTextOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotatedDataset
, error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
LabelVideoOperation
type LabelVideoOperation struct {
// contains filtered or unexported fields
}
LabelVideoOperation manages a long-running operation from LabelVideo.
func (*LabelVideoOperation) Done
func (op * LabelVideoOperation
) Done() bool
Done reports whether the long-running operation has completed.
func (*LabelVideoOperation) Metadata
func (op * LabelVideoOperation
) Metadata() (* datalabelingpb
. LabelOperationMetadata
, error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*LabelVideoOperation) Name
func (op * LabelVideoOperation
) Name() string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*LabelVideoOperation) Poll
func (op * LabelVideoOperation
) Poll(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotatedDataset
, error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*LabelVideoOperation) Wait
func (op * LabelVideoOperation
) Wait(ctx context
. Context
, opts ... gax
. CallOption
) (* datalabelingpb
. AnnotatedDataset
, error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
SearchExampleComparisonsResponse_ExampleComparisonIterator
type SearchExampleComparisonsResponse_ExampleComparisonIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int
, pageToken string
) (results []* datalabelingpb
. SearchExampleComparisonsResponse_ExampleComparison
, nextPageToken string
, err error
)
// contains filtered or unexported fields
}
SearchExampleComparisonsResponse_ExampleComparisonIterator manages a stream of *datalabelingpb.SearchExampleComparisonsResponse_ExampleComparison.
func (*SearchExampleComparisonsResponse_ExampleComparisonIterator) Next
func (it * SearchExampleComparisonsResponse_ExampleComparisonIterator
) Next() (* datalabelingpb
. SearchExampleComparisonsResponse_ExampleComparison
, error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*SearchExampleComparisonsResponse_ExampleComparisonIterator) PageInfo
func (it * SearchExampleComparisonsResponse_ExampleComparisonIterator
) PageInfo() * iterator
. PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
