- 0.116.0 (latest)
- 0.115.1
- 0.114.0
- 0.113.0
- 0.112.2
- 0.111.0
- 0.110.10
- 0.109.0
- 0.108.0
- 0.107.0
- 0.106.0
- 0.105.0
- 0.104.0
- 0.103.0
- 0.102.1
- 0.101.1
- 0.100.2
- 0.99.0
- 0.98.0
- 0.97.0
- 0.96.0
- 0.95.0
- 0.94.1
- 0.93.3
- 0.92.3
- 0.91.1
- 0.90.0
- 0.89.0
- 0.88.0
- 0.87.0
- 0.86.0
- 0.85.0
- 0.84.0
- 0.83.0
- 0.82.0
- 0.81.0
- 0.80.0
- 0.79.0
- 0.78.0
- 0.77.0
- 0.76.0
- 0.75.0
Package aiplatform is an auto-generated package for the Vertex AI API.
Train high-quality custom machine learning models with minimal machine learning expertise and effort.
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.
AnnotationIterator
type AnnotationIterator 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 []*aiplatformpb.Annotation, nextPageToken string, err error)
// contains filtered or unexported fields
}
AnnotationIterator manages a stream of *aiplatformpb.Annotation.
func (*AnnotationIterator) Next
func (it *AnnotationIterator) Next() (*aiplatformpb.Annotation, 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 (*AnnotationIterator) PageInfo
func (it *AnnotationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
BatchMigrateResourcesOperation
type BatchMigrateResourcesOperation struct {
// contains filtered or unexported fields
}
BatchMigrateResourcesOperation manages a long-running operation from BatchMigrateResources.
func (*BatchMigrateResourcesOperation) Done
func (op *BatchMigrateResourcesOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*BatchMigrateResourcesOperation) Metadata
func (op *BatchMigrateResourcesOperation) Metadata() (*aiplatformpb.BatchMigrateResourcesOperationMetadata, 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 (*BatchMigrateResourcesOperation) Name
func (op *BatchMigrateResourcesOperation) 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 (*BatchMigrateResourcesOperation) Poll
func (op *BatchMigrateResourcesOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.BatchMigrateResourcesResponse, 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 (*BatchMigrateResourcesOperation) Wait
func (op *BatchMigrateResourcesOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.BatchMigrateResourcesResponse, 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.
BatchPredictionJobIterator
type BatchPredictionJobIterator 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 []*aiplatformpb.BatchPredictionJob, nextPageToken string, err error)
// contains filtered or unexported fields
}
BatchPredictionJobIterator manages a stream of *aiplatformpb.BatchPredictionJob.
func (*BatchPredictionJobIterator) Next
func (it *BatchPredictionJobIterator) Next() (*aiplatformpb.BatchPredictionJob, 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 (*BatchPredictionJobIterator) PageInfo
func (it *BatchPredictionJobIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CreateDatasetOperation
type CreateDatasetOperation struct {
// contains filtered or unexported fields
}
CreateDatasetOperation manages a long-running operation from CreateDataset.
func (*CreateDatasetOperation) Done
func (op *CreateDatasetOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateDatasetOperation) Metadata
func (op *CreateDatasetOperation) Metadata() (*aiplatformpb.CreateDatasetOperationMetadata, 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 (*CreateDatasetOperation) Name
func (op *CreateDatasetOperation) 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 (*CreateDatasetOperation) Poll
func (op *CreateDatasetOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.Dataset, 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 (*CreateDatasetOperation) Wait
func (op *CreateDatasetOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.Dataset, 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.
CreateEndpointOperation
type CreateEndpointOperation struct {
// contains filtered or unexported fields
}
CreateEndpointOperation manages a long-running operation from CreateEndpoint.
func (*CreateEndpointOperation) Done
func (op *CreateEndpointOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateEndpointOperation) Metadata
func (op *CreateEndpointOperation) Metadata() (*aiplatformpb.CreateEndpointOperationMetadata, 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 (*CreateEndpointOperation) Name
func (op *CreateEndpointOperation) 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 (*CreateEndpointOperation) Poll
func (op *CreateEndpointOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.Endpoint, 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 (*CreateEndpointOperation) Wait
func (op *CreateEndpointOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.Endpoint, 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.
CreateSpecialistPoolOperation
type CreateSpecialistPoolOperation struct {
// contains filtered or unexported fields
}
CreateSpecialistPoolOperation manages a long-running operation from CreateSpecialistPool.
func (*CreateSpecialistPoolOperation) Done
func (op *CreateSpecialistPoolOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateSpecialistPoolOperation) Metadata
func (op *CreateSpecialistPoolOperation) Metadata() (*aiplatformpb.CreateSpecialistPoolOperationMetadata, 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 (*CreateSpecialistPoolOperation) Name
func (op *CreateSpecialistPoolOperation) 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 (*CreateSpecialistPoolOperation) Poll
func (op *CreateSpecialistPoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.SpecialistPool, 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 (*CreateSpecialistPoolOperation) Wait
func (op *CreateSpecialistPoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.SpecialistPool, 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.
CustomJobIterator
type CustomJobIterator 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 []*aiplatformpb.CustomJob, nextPageToken string, err error)
// contains filtered or unexported fields
}
CustomJobIterator manages a stream of *aiplatformpb.CustomJob.
func (*CustomJobIterator) Next
func (it *CustomJobIterator) Next() (*aiplatformpb.CustomJob, 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 (*CustomJobIterator) PageInfo
func (it *CustomJobIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
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 []*aiplatformpb.DataItem, nextPageToken string, err error)
// contains filtered or unexported fields
}
DataItemIterator manages a stream of *aiplatformpb.DataItem.
func (*DataItemIterator) Next
func (it *DataItemIterator) Next() (*aiplatformpb.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.
DataLabelingJobIterator
type DataLabelingJobIterator 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 []*aiplatformpb.DataLabelingJob, nextPageToken string, err error)
// contains filtered or unexported fields
}
DataLabelingJobIterator manages a stream of *aiplatformpb.DataLabelingJob.
func (*DataLabelingJobIterator) Next
func (it *DataLabelingJobIterator) Next() (*aiplatformpb.DataLabelingJob, 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 (*DataLabelingJobIterator) PageInfo
func (it *DataLabelingJobIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
DatasetCallOptions
type DatasetCallOptions struct {
CreateDataset []gax.CallOption
GetDataset []gax.CallOption
UpdateDataset []gax.CallOption
ListDatasets []gax.CallOption
DeleteDataset []gax.CallOption
ImportData []gax.CallOption
ExportData []gax.CallOption
ListDataItems []gax.CallOption
GetAnnotationSpec []gax.CallOption
ListAnnotations []gax.CallOption
}
DatasetCallOptions contains the retry settings for each method of DatasetClient.
DatasetClient
type DatasetClient struct {
// The call options for this service.
CallOptions *DatasetCallOptions
// 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
}
DatasetClient is a client for interacting with Vertex AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
func NewDatasetClient
func NewDatasetClient(ctx context.Context, opts ...option.ClientOption) (*DatasetClient, error)
NewDatasetClient creates a new dataset service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*DatasetClient) Close
func (c *DatasetClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*DatasetClient) Connection
func (c *DatasetClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*DatasetClient) CreateDataset
func (c *DatasetClient) CreateDataset(ctx context.Context, req *aiplatformpb.CreateDatasetRequest, opts ...gax.CallOption) (*CreateDatasetOperation, error)
CreateDataset creates a Dataset.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreateDatasetRequest{
// TODO: Fill request struct fields.
}
op, err := c.CreateDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*DatasetClient) CreateDatasetOperation
func (c *DatasetClient) CreateDatasetOperation(name string) *CreateDatasetOperation
CreateDatasetOperation returns a new CreateDatasetOperation from a given name. The name must be that of a previously created CreateDatasetOperation, possibly from a different process.
func (*DatasetClient) DeleteDataset
func (c *DatasetClient) DeleteDataset(ctx context.Context, req *aiplatformpb.DeleteDatasetRequest, opts ...gax.CallOption) (*DeleteDatasetOperation, error)
DeleteDataset deletes a Dataset.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteDatasetRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*DatasetClient) DeleteDatasetOperation
func (c *DatasetClient) DeleteDatasetOperation(name string) *DeleteDatasetOperation
DeleteDatasetOperation returns a new DeleteDatasetOperation from a given name. The name must be that of a previously created DeleteDatasetOperation, possibly from a different process.
func (*DatasetClient) ExportData
func (c *DatasetClient) ExportData(ctx context.Context, req *aiplatformpb.ExportDataRequest, opts ...gax.CallOption) (*ExportDataOperation, error)
ExportData exports data from a Dataset.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.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 (*DatasetClient) ExportDataOperation
func (c *DatasetClient) 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 (*DatasetClient) GetAnnotationSpec
func (c *DatasetClient) GetAnnotationSpec(ctx context.Context, req *aiplatformpb.GetAnnotationSpecRequest, opts ...gax.CallOption) (*aiplatformpb.AnnotationSpec, error)
GetAnnotationSpec gets an AnnotationSpec.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetAnnotationSpecRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetAnnotationSpec(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*DatasetClient) GetDataset
func (c *DatasetClient) GetDataset(ctx context.Context, req *aiplatformpb.GetDatasetRequest, opts ...gax.CallOption) (*aiplatformpb.Dataset, error)
GetDataset gets a Dataset.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetDatasetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*DatasetClient) ImportData
func (c *DatasetClient) ImportData(ctx context.Context, req *aiplatformpb.ImportDataRequest, opts ...gax.CallOption) (*ImportDataOperation, error)
ImportData imports data into a Dataset.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.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 (*DatasetClient) ImportDataOperation
func (c *DatasetClient) 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 (*DatasetClient) ListAnnotations
func (c *DatasetClient) ListAnnotations(ctx context.Context, req *aiplatformpb.ListAnnotationsRequest, opts ...gax.CallOption) *AnnotationIterator
ListAnnotations lists Annotations belongs to a dataitem
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListAnnotationsRequest{
// TODO: Fill request struct fields.
}
it := c.ListAnnotations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*DatasetClient) ListDataItems
func (c *DatasetClient) ListDataItems(ctx context.Context, req *aiplatformpb.ListDataItemsRequest, opts ...gax.CallOption) *DataItemIterator
ListDataItems lists DataItems in a Dataset.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.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 (*DatasetClient) ListDatasets
func (c *DatasetClient) ListDatasets(ctx context.Context, req *aiplatformpb.ListDatasetsRequest, opts ...gax.CallOption) *DatasetIterator
ListDatasets lists Datasets in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.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 (*DatasetClient) UpdateDataset
func (c *DatasetClient) UpdateDataset(ctx context.Context, req *aiplatformpb.UpdateDatasetRequest, opts ...gax.CallOption) (*aiplatformpb.Dataset, error)
UpdateDataset updates a Dataset.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewDatasetClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.UpdateDatasetRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateDataset(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
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 []*aiplatformpb.Dataset, nextPageToken string, err error)
// contains filtered or unexported fields
}
DatasetIterator manages a stream of *aiplatformpb.Dataset.
func (*DatasetIterator) Next
func (it *DatasetIterator) Next() (*aiplatformpb.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.
DeleteBatchPredictionJobOperation
type DeleteBatchPredictionJobOperation struct {
// contains filtered or unexported fields
}
DeleteBatchPredictionJobOperation manages a long-running operation from DeleteBatchPredictionJob.
func (*DeleteBatchPredictionJobOperation) Done
func (op *DeleteBatchPredictionJobOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteBatchPredictionJobOperation) Metadata
func (op *DeleteBatchPredictionJobOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteBatchPredictionJobOperation) Name
func (op *DeleteBatchPredictionJobOperation) 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 (*DeleteBatchPredictionJobOperation) Poll
func (op *DeleteBatchPredictionJobOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteBatchPredictionJobOperation) Wait
func (op *DeleteBatchPredictionJobOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeleteCustomJobOperation
type DeleteCustomJobOperation struct {
// contains filtered or unexported fields
}
DeleteCustomJobOperation manages a long-running operation from DeleteCustomJob.
func (*DeleteCustomJobOperation) Done
func (op *DeleteCustomJobOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteCustomJobOperation) Metadata
func (op *DeleteCustomJobOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteCustomJobOperation) Name
func (op *DeleteCustomJobOperation) 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 (*DeleteCustomJobOperation) Poll
func (op *DeleteCustomJobOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteCustomJobOperation) Wait
func (op *DeleteCustomJobOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeleteDataLabelingJobOperation
type DeleteDataLabelingJobOperation struct {
// contains filtered or unexported fields
}
DeleteDataLabelingJobOperation manages a long-running operation from DeleteDataLabelingJob.
func (*DeleteDataLabelingJobOperation) Done
func (op *DeleteDataLabelingJobOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteDataLabelingJobOperation) Metadata
func (op *DeleteDataLabelingJobOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteDataLabelingJobOperation) Name
func (op *DeleteDataLabelingJobOperation) 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 (*DeleteDataLabelingJobOperation) Poll
func (op *DeleteDataLabelingJobOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteDataLabelingJobOperation) Wait
func (op *DeleteDataLabelingJobOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeleteDatasetOperation
type DeleteDatasetOperation struct {
// contains filtered or unexported fields
}
DeleteDatasetOperation manages a long-running operation from DeleteDataset.
func (*DeleteDatasetOperation) Done
func (op *DeleteDatasetOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteDatasetOperation) Metadata
func (op *DeleteDatasetOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteDatasetOperation) Name
func (op *DeleteDatasetOperation) 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 (*DeleteDatasetOperation) Poll
func (op *DeleteDatasetOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteDatasetOperation) Wait
func (op *DeleteDatasetOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeleteEndpointOperation
type DeleteEndpointOperation struct {
// contains filtered or unexported fields
}
DeleteEndpointOperation manages a long-running operation from DeleteEndpoint.
func (*DeleteEndpointOperation) Done
func (op *DeleteEndpointOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteEndpointOperation) Metadata
func (op *DeleteEndpointOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteEndpointOperation) Name
func (op *DeleteEndpointOperation) 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 (*DeleteEndpointOperation) Poll
func (op *DeleteEndpointOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteEndpointOperation) Wait
func (op *DeleteEndpointOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeleteHyperparameterTuningJobOperation
type DeleteHyperparameterTuningJobOperation struct {
// contains filtered or unexported fields
}
DeleteHyperparameterTuningJobOperation manages a long-running operation from DeleteHyperparameterTuningJob.
func (*DeleteHyperparameterTuningJobOperation) Done
func (op *DeleteHyperparameterTuningJobOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteHyperparameterTuningJobOperation) Metadata
func (op *DeleteHyperparameterTuningJobOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteHyperparameterTuningJobOperation) Name
func (op *DeleteHyperparameterTuningJobOperation) 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 (*DeleteHyperparameterTuningJobOperation) Poll
func (op *DeleteHyperparameterTuningJobOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteHyperparameterTuningJobOperation) Wait
func (op *DeleteHyperparameterTuningJobOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeleteModelOperation
type DeleteModelOperation struct {
// contains filtered or unexported fields
}
DeleteModelOperation manages a long-running operation from DeleteModel.
func (*DeleteModelOperation) Done
func (op *DeleteModelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteModelOperation) Metadata
func (op *DeleteModelOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteModelOperation) Name
func (op *DeleteModelOperation) 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 (*DeleteModelOperation) Poll
func (op *DeleteModelOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteModelOperation) Wait
func (op *DeleteModelOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeletePipelineJobOperation
type DeletePipelineJobOperation struct {
// contains filtered or unexported fields
}
DeletePipelineJobOperation manages a long-running operation from DeletePipelineJob.
func (*DeletePipelineJobOperation) Done
func (op *DeletePipelineJobOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeletePipelineJobOperation) Metadata
func (op *DeletePipelineJobOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeletePipelineJobOperation) Name
func (op *DeletePipelineJobOperation) 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 (*DeletePipelineJobOperation) Poll
func (op *DeletePipelineJobOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeletePipelineJobOperation) Wait
func (op *DeletePipelineJobOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeleteSpecialistPoolOperation
type DeleteSpecialistPoolOperation struct {
// contains filtered or unexported fields
}
DeleteSpecialistPoolOperation manages a long-running operation from DeleteSpecialistPool.
func (*DeleteSpecialistPoolOperation) Done
func (op *DeleteSpecialistPoolOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteSpecialistPoolOperation) Metadata
func (op *DeleteSpecialistPoolOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteSpecialistPoolOperation) Name
func (op *DeleteSpecialistPoolOperation) 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 (*DeleteSpecialistPoolOperation) Poll
func (op *DeleteSpecialistPoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteSpecialistPoolOperation) Wait
func (op *DeleteSpecialistPoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeleteTrainingPipelineOperation
type DeleteTrainingPipelineOperation struct {
// contains filtered or unexported fields
}
DeleteTrainingPipelineOperation manages a long-running operation from DeleteTrainingPipeline.
func (*DeleteTrainingPipelineOperation) Done
func (op *DeleteTrainingPipelineOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteTrainingPipelineOperation) Metadata
func (op *DeleteTrainingPipelineOperation) Metadata() (*aiplatformpb.DeleteOperationMetadata, 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 (*DeleteTrainingPipelineOperation) Name
func (op *DeleteTrainingPipelineOperation) 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 (*DeleteTrainingPipelineOperation) Poll
func (op *DeleteTrainingPipelineOperation) Poll(ctx context.Context, opts ...gax.CallOption) 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 (*DeleteTrainingPipelineOperation) Wait
func (op *DeleteTrainingPipelineOperation) Wait(ctx context.Context, opts ...gax.CallOption) 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.
DeployModelOperation
type DeployModelOperation struct {
// contains filtered or unexported fields
}
DeployModelOperation manages a long-running operation from DeployModel.
func (*DeployModelOperation) Done
func (op *DeployModelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeployModelOperation) Metadata
func (op *DeployModelOperation) Metadata() (*aiplatformpb.DeployModelOperationMetadata, 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 (*DeployModelOperation) Name
func (op *DeployModelOperation) 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 (*DeployModelOperation) Poll
func (op *DeployModelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.DeployModelResponse, 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 (*DeployModelOperation) Wait
func (op *DeployModelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.DeployModelResponse, 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.
EndpointCallOptions
type EndpointCallOptions struct {
CreateEndpoint []gax.CallOption
GetEndpoint []gax.CallOption
ListEndpoints []gax.CallOption
UpdateEndpoint []gax.CallOption
DeleteEndpoint []gax.CallOption
DeployModel []gax.CallOption
UndeployModel []gax.CallOption
}
EndpointCallOptions contains the retry settings for each method of EndpointClient.
EndpointClient
type EndpointClient struct {
// The call options for this service.
CallOptions *EndpointCallOptions
// 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
}
EndpointClient is a client for interacting with Vertex AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
func NewEndpointClient
func NewEndpointClient(ctx context.Context, opts ...option.ClientOption) (*EndpointClient, error)
NewEndpointClient creates a new endpoint service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewEndpointClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*EndpointClient) Close
func (c *EndpointClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*EndpointClient) Connection
func (c *EndpointClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*EndpointClient) CreateEndpoint
func (c *EndpointClient) CreateEndpoint(ctx context.Context, req *aiplatformpb.CreateEndpointRequest, opts ...gax.CallOption) (*CreateEndpointOperation, error)
CreateEndpoint creates an Endpoint.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewEndpointClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreateEndpointRequest{
// TODO: Fill request struct fields.
}
op, err := c.CreateEndpoint(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*EndpointClient) CreateEndpointOperation
func (c *EndpointClient) CreateEndpointOperation(name string) *CreateEndpointOperation
CreateEndpointOperation returns a new CreateEndpointOperation from a given name. The name must be that of a previously created CreateEndpointOperation, possibly from a different process.
func (*EndpointClient) DeleteEndpoint
func (c *EndpointClient) DeleteEndpoint(ctx context.Context, req *aiplatformpb.DeleteEndpointRequest, opts ...gax.CallOption) (*DeleteEndpointOperation, error)
DeleteEndpoint deletes an Endpoint.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewEndpointClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteEndpointRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteEndpoint(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*EndpointClient) DeleteEndpointOperation
func (c *EndpointClient) DeleteEndpointOperation(name string) *DeleteEndpointOperation
DeleteEndpointOperation returns a new DeleteEndpointOperation from a given name. The name must be that of a previously created DeleteEndpointOperation, possibly from a different process.
func (*EndpointClient) DeployModel
func (c *EndpointClient) DeployModel(ctx context.Context, req *aiplatformpb.DeployModelRequest, opts ...gax.CallOption) (*DeployModelOperation, error)
DeployModel deploys a Model into this Endpoint, creating a DeployedModel within it.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewEndpointClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeployModelRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeployModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*EndpointClient) DeployModelOperation
func (c *EndpointClient) DeployModelOperation(name string) *DeployModelOperation
DeployModelOperation returns a new DeployModelOperation from a given name. The name must be that of a previously created DeployModelOperation, possibly from a different process.
func (*EndpointClient) GetEndpoint
func (c *EndpointClient) GetEndpoint(ctx context.Context, req *aiplatformpb.GetEndpointRequest, opts ...gax.CallOption) (*aiplatformpb.Endpoint, error)
GetEndpoint gets an Endpoint.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewEndpointClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetEndpointRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetEndpoint(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*EndpointClient) ListEndpoints
func (c *EndpointClient) ListEndpoints(ctx context.Context, req *aiplatformpb.ListEndpointsRequest, opts ...gax.CallOption) *EndpointIterator
ListEndpoints lists Endpoints in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewEndpointClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListEndpointsRequest{
// TODO: Fill request struct fields.
}
it := c.ListEndpoints(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*EndpointClient) UndeployModel
func (c *EndpointClient) UndeployModel(ctx context.Context, req *aiplatformpb.UndeployModelRequest, opts ...gax.CallOption) (*UndeployModelOperation, error)
UndeployModel undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it’s using.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewEndpointClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.UndeployModelRequest{
// TODO: Fill request struct fields.
}
op, err := c.UndeployModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*EndpointClient) UndeployModelOperation
func (c *EndpointClient) UndeployModelOperation(name string) *UndeployModelOperation
UndeployModelOperation returns a new UndeployModelOperation from a given name. The name must be that of a previously created UndeployModelOperation, possibly from a different process.
func (*EndpointClient) UpdateEndpoint
func (c *EndpointClient) UpdateEndpoint(ctx context.Context, req *aiplatformpb.UpdateEndpointRequest, opts ...gax.CallOption) (*aiplatformpb.Endpoint, error)
UpdateEndpoint updates an Endpoint.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewEndpointClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.UpdateEndpointRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateEndpoint(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
EndpointIterator
type EndpointIterator 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 []*aiplatformpb.Endpoint, nextPageToken string, err error)
// contains filtered or unexported fields
}
EndpointIterator manages a stream of *aiplatformpb.Endpoint.
func (*EndpointIterator) Next
func (it *EndpointIterator) Next() (*aiplatformpb.Endpoint, 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 (*EndpointIterator) PageInfo
func (it *EndpointIterator) 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() (*aiplatformpb.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) (*aiplatformpb.ExportDataResponse, 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) (*aiplatformpb.ExportDataResponse, 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.
ExportModelOperation
type ExportModelOperation struct {
// contains filtered or unexported fields
}
ExportModelOperation manages a long-running operation from ExportModel.
func (*ExportModelOperation) Done
func (op *ExportModelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ExportModelOperation) Metadata
func (op *ExportModelOperation) Metadata() (*aiplatformpb.ExportModelOperationMetadata, 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 (*ExportModelOperation) Name
func (op *ExportModelOperation) 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 (*ExportModelOperation) Poll
func (op *ExportModelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.ExportModelResponse, 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 (*ExportModelOperation) Wait
func (op *ExportModelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.ExportModelResponse, 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.
HyperparameterTuningJobIterator
type HyperparameterTuningJobIterator 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 []*aiplatformpb.HyperparameterTuningJob, nextPageToken string, err error)
// contains filtered or unexported fields
}
HyperparameterTuningJobIterator manages a stream of *aiplatformpb.HyperparameterTuningJob.
func (*HyperparameterTuningJobIterator) Next
func (it *HyperparameterTuningJobIterator) Next() (*aiplatformpb.HyperparameterTuningJob, 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 (*HyperparameterTuningJobIterator) PageInfo
func (it *HyperparameterTuningJobIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
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() (*aiplatformpb.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) (*aiplatformpb.ImportDataResponse, 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) (*aiplatformpb.ImportDataResponse, 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.
JobCallOptions
type JobCallOptions struct {
CreateCustomJob []gax.CallOption
GetCustomJob []gax.CallOption
ListCustomJobs []gax.CallOption
DeleteCustomJob []gax.CallOption
CancelCustomJob []gax.CallOption
CreateDataLabelingJob []gax.CallOption
GetDataLabelingJob []gax.CallOption
ListDataLabelingJobs []gax.CallOption
DeleteDataLabelingJob []gax.CallOption
CancelDataLabelingJob []gax.CallOption
CreateHyperparameterTuningJob []gax.CallOption
GetHyperparameterTuningJob []gax.CallOption
ListHyperparameterTuningJobs []gax.CallOption
DeleteHyperparameterTuningJob []gax.CallOption
CancelHyperparameterTuningJob []gax.CallOption
CreateBatchPredictionJob []gax.CallOption
GetBatchPredictionJob []gax.CallOption
ListBatchPredictionJobs []gax.CallOption
DeleteBatchPredictionJob []gax.CallOption
CancelBatchPredictionJob []gax.CallOption
}
JobCallOptions contains the retry settings for each method of JobClient.
JobClient
type JobClient struct {
// The call options for this service.
CallOptions *JobCallOptions
// 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
}
JobClient is a client for interacting with Vertex AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
A service for creating and managing Vertex AI’s jobs.
func NewJobClient
NewJobClient creates a new job service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
A service for creating and managing Vertex AI’s jobs.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*JobClient) CancelBatchPredictionJob
func (c *JobClient) CancelBatchPredictionJob(ctx context.Context, req *aiplatformpb.CancelBatchPredictionJobRequest, opts ...gax.CallOption) error
CancelBatchPredictionJob cancels a BatchPredictionJob.
Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to CANCELLED. Any files already outputted by the job are not deleted.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CancelBatchPredictionJobRequest{
// TODO: Fill request struct fields.
}
err = c.CancelBatchPredictionJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*JobClient) CancelCustomJob
func (c *JobClient) CancelCustomJob(ctx context.Context, req *aiplatformpb.CancelCustomJobRequest, opts ...gax.CallOption) error
CancelCustomJob cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CancelCustomJobRequest{
// TODO: Fill request struct fields.
}
err = c.CancelCustomJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*JobClient) CancelDataLabelingJob
func (c *JobClient) CancelDataLabelingJob(ctx context.Context, req *aiplatformpb.CancelDataLabelingJobRequest, opts ...gax.CallOption) error
CancelDataLabelingJob cancels a DataLabelingJob. Success of cancellation is not guaranteed.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CancelDataLabelingJobRequest{
// TODO: Fill request struct fields.
}
err = c.CancelDataLabelingJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*JobClient) CancelHyperparameterTuningJob
func (c *JobClient) CancelHyperparameterTuningJob(ctx context.Context, req *aiplatformpb.CancelHyperparameterTuningJobRequest, opts ...gax.CallOption) error
CancelHyperparameterTuningJob cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is set to CANCELLED.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CancelHyperparameterTuningJobRequest{
// TODO: Fill request struct fields.
}
err = c.CancelHyperparameterTuningJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*JobClient) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*JobClient) Connection
func (c *JobClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*JobClient) CreateBatchPredictionJob
func (c *JobClient) CreateBatchPredictionJob(ctx context.Context, req *aiplatformpb.CreateBatchPredictionJobRequest, opts ...gax.CallOption) (*aiplatformpb.BatchPredictionJob, error)
CreateBatchPredictionJob creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreateBatchPredictionJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateBatchPredictionJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*JobClient) CreateCustomJob
func (c *JobClient) CreateCustomJob(ctx context.Context, req *aiplatformpb.CreateCustomJobRequest, opts ...gax.CallOption) (*aiplatformpb.CustomJob, error)
CreateCustomJob creates a CustomJob. A created CustomJob right away will be attempted to be run.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreateCustomJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateCustomJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*JobClient) CreateDataLabelingJob
func (c *JobClient) CreateDataLabelingJob(ctx context.Context, req *aiplatformpb.CreateDataLabelingJobRequest, opts ...gax.CallOption) (*aiplatformpb.DataLabelingJob, error)
CreateDataLabelingJob creates a DataLabelingJob.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreateDataLabelingJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateDataLabelingJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*JobClient) CreateHyperparameterTuningJob
func (c *JobClient) CreateHyperparameterTuningJob(ctx context.Context, req *aiplatformpb.CreateHyperparameterTuningJobRequest, opts ...gax.CallOption) (*aiplatformpb.HyperparameterTuningJob, error)
CreateHyperparameterTuningJob creates a HyperparameterTuningJob
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreateHyperparameterTuningJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateHyperparameterTuningJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*JobClient) DeleteBatchPredictionJob
func (c *JobClient) DeleteBatchPredictionJob(ctx context.Context, req *aiplatformpb.DeleteBatchPredictionJobRequest, opts ...gax.CallOption) (*DeleteBatchPredictionJobOperation, error)
DeleteBatchPredictionJob deletes a BatchPredictionJob. Can only be called on jobs that already finished.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteBatchPredictionJobRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteBatchPredictionJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*JobClient) DeleteBatchPredictionJobOperation
func (c *JobClient) DeleteBatchPredictionJobOperation(name string) *DeleteBatchPredictionJobOperation
DeleteBatchPredictionJobOperation returns a new DeleteBatchPredictionJobOperation from a given name. The name must be that of a previously created DeleteBatchPredictionJobOperation, possibly from a different process.
func (*JobClient) DeleteCustomJob
func (c *JobClient) DeleteCustomJob(ctx context.Context, req *aiplatformpb.DeleteCustomJobRequest, opts ...gax.CallOption) (*DeleteCustomJobOperation, error)
DeleteCustomJob deletes a CustomJob.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteCustomJobRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteCustomJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*JobClient) DeleteCustomJobOperation
func (c *JobClient) DeleteCustomJobOperation(name string) *DeleteCustomJobOperation
DeleteCustomJobOperation returns a new DeleteCustomJobOperation from a given name. The name must be that of a previously created DeleteCustomJobOperation, possibly from a different process.
func (*JobClient) DeleteDataLabelingJob
func (c *JobClient) DeleteDataLabelingJob(ctx context.Context, req *aiplatformpb.DeleteDataLabelingJobRequest, opts ...gax.CallOption) (*DeleteDataLabelingJobOperation, error)
DeleteDataLabelingJob deletes a DataLabelingJob.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteDataLabelingJobRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteDataLabelingJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*JobClient) DeleteDataLabelingJobOperation
func (c *JobClient) DeleteDataLabelingJobOperation(name string) *DeleteDataLabelingJobOperation
DeleteDataLabelingJobOperation returns a new DeleteDataLabelingJobOperation from a given name. The name must be that of a previously created DeleteDataLabelingJobOperation, possibly from a different process.
func (*JobClient) DeleteHyperparameterTuningJob
func (c *JobClient) DeleteHyperparameterTuningJob(ctx context.Context, req *aiplatformpb.DeleteHyperparameterTuningJobRequest, opts ...gax.CallOption) (*DeleteHyperparameterTuningJobOperation, error)
DeleteHyperparameterTuningJob deletes a HyperparameterTuningJob.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteHyperparameterTuningJobRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteHyperparameterTuningJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*JobClient) DeleteHyperparameterTuningJobOperation
func (c *JobClient) DeleteHyperparameterTuningJobOperation(name string) *DeleteHyperparameterTuningJobOperation
DeleteHyperparameterTuningJobOperation returns a new DeleteHyperparameterTuningJobOperation from a given name. The name must be that of a previously created DeleteHyperparameterTuningJobOperation, possibly from a different process.
func (*JobClient) GetBatchPredictionJob
func (c *JobClient) GetBatchPredictionJob(ctx context.Context, req *aiplatformpb.GetBatchPredictionJobRequest, opts ...gax.CallOption) (*aiplatformpb.BatchPredictionJob, error)
GetBatchPredictionJob gets a BatchPredictionJob
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetBatchPredictionJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetBatchPredictionJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*JobClient) GetCustomJob
func (c *JobClient) GetCustomJob(ctx context.Context, req *aiplatformpb.GetCustomJobRequest, opts ...gax.CallOption) (*aiplatformpb.CustomJob, error)
GetCustomJob gets a CustomJob.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetCustomJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetCustomJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*JobClient) GetDataLabelingJob
func (c *JobClient) GetDataLabelingJob(ctx context.Context, req *aiplatformpb.GetDataLabelingJobRequest, opts ...gax.CallOption) (*aiplatformpb.DataLabelingJob, error)
GetDataLabelingJob gets a DataLabelingJob.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetDataLabelingJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetDataLabelingJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*JobClient) GetHyperparameterTuningJob
func (c *JobClient) GetHyperparameterTuningJob(ctx context.Context, req *aiplatformpb.GetHyperparameterTuningJobRequest, opts ...gax.CallOption) (*aiplatformpb.HyperparameterTuningJob, error)
GetHyperparameterTuningJob gets a HyperparameterTuningJob
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetHyperparameterTuningJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetHyperparameterTuningJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*JobClient) ListBatchPredictionJobs
func (c *JobClient) ListBatchPredictionJobs(ctx context.Context, req *aiplatformpb.ListBatchPredictionJobsRequest, opts ...gax.CallOption) *BatchPredictionJobIterator
ListBatchPredictionJobs lists BatchPredictionJobs in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListBatchPredictionJobsRequest{
// TODO: Fill request struct fields.
}
it := c.ListBatchPredictionJobs(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*JobClient) ListCustomJobs
func (c *JobClient) ListCustomJobs(ctx context.Context, req *aiplatformpb.ListCustomJobsRequest, opts ...gax.CallOption) *CustomJobIterator
ListCustomJobs lists CustomJobs in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListCustomJobsRequest{
// TODO: Fill request struct fields.
}
it := c.ListCustomJobs(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*JobClient) ListDataLabelingJobs
func (c *JobClient) ListDataLabelingJobs(ctx context.Context, req *aiplatformpb.ListDataLabelingJobsRequest, opts ...gax.CallOption) *DataLabelingJobIterator
ListDataLabelingJobs lists DataLabelingJobs in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListDataLabelingJobsRequest{
// TODO: Fill request struct fields.
}
it := c.ListDataLabelingJobs(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*JobClient) ListHyperparameterTuningJobs
func (c *JobClient) ListHyperparameterTuningJobs(ctx context.Context, req *aiplatformpb.ListHyperparameterTuningJobsRequest, opts ...gax.CallOption) *HyperparameterTuningJobIterator
ListHyperparameterTuningJobs lists HyperparameterTuningJobs in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewJobClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListHyperparameterTuningJobsRequest{
// TODO: Fill request struct fields.
}
it := c.ListHyperparameterTuningJobs(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
MigratableResourceIterator
type MigratableResourceIterator 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 []*aiplatformpb.MigratableResource, nextPageToken string, err error)
// contains filtered or unexported fields
}
MigratableResourceIterator manages a stream of *aiplatformpb.MigratableResource.
func (*MigratableResourceIterator) Next
func (it *MigratableResourceIterator) Next() (*aiplatformpb.MigratableResource, 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 (*MigratableResourceIterator) PageInfo
func (it *MigratableResourceIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
MigrationCallOptions
type MigrationCallOptions struct {
SearchMigratableResources []gax.CallOption
BatchMigrateResources []gax.CallOption
}
MigrationCallOptions contains the retry settings for each method of MigrationClient.
MigrationClient
type MigrationClient struct {
// The call options for this service.
CallOptions *MigrationCallOptions
// 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
}
MigrationClient is a client for interacting with Vertex AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
A service that migrates resources from automl.googleapis.com (at http://automl.googleapis.com), datalabeling.googleapis.com (at http://datalabeling.googleapis.com) and ml.googleapis.com (at http://ml.googleapis.com) to Vertex AI.
func NewMigrationClient
func NewMigrationClient(ctx context.Context, opts ...option.ClientOption) (*MigrationClient, error)
NewMigrationClient creates a new migration service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
A service that migrates resources from automl.googleapis.com (at http://automl.googleapis.com), datalabeling.googleapis.com (at http://datalabeling.googleapis.com) and ml.googleapis.com (at http://ml.googleapis.com) to Vertex AI.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewMigrationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*MigrationClient) BatchMigrateResources
func (c *MigrationClient) BatchMigrateResources(ctx context.Context, req *aiplatformpb.BatchMigrateResourcesRequest, opts ...gax.CallOption) (*BatchMigrateResourcesOperation, error)
BatchMigrateResources batch migrates resources from ml.googleapis.com (at http://ml.googleapis.com), automl.googleapis.com (at http://automl.googleapis.com), and datalabeling.googleapis.com (at http://datalabeling.googleapis.com) to Vertex AI.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewMigrationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.BatchMigrateResourcesRequest{
// TODO: Fill request struct fields.
}
op, err := c.BatchMigrateResources(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*MigrationClient) BatchMigrateResourcesOperation
func (c *MigrationClient) BatchMigrateResourcesOperation(name string) *BatchMigrateResourcesOperation
BatchMigrateResourcesOperation returns a new BatchMigrateResourcesOperation from a given name. The name must be that of a previously created BatchMigrateResourcesOperation, possibly from a different process.
func (*MigrationClient) Close
func (c *MigrationClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*MigrationClient) Connection
func (c *MigrationClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*MigrationClient) SearchMigratableResources
func (c *MigrationClient) SearchMigratableResources(ctx context.Context, req *aiplatformpb.SearchMigratableResourcesRequest, opts ...gax.CallOption) *MigratableResourceIterator
SearchMigratableResources searches all of the resources in automl.googleapis.com (at http://automl.googleapis.com), datalabeling.googleapis.com (at http://datalabeling.googleapis.com) and ml.googleapis.com (at http://ml.googleapis.com) that can be migrated to Vertex AI’s given location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewMigrationClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.SearchMigratableResourcesRequest{
// TODO: Fill request struct fields.
}
it := c.SearchMigratableResources(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
ModelCallOptions
type ModelCallOptions struct {
UploadModel []gax.CallOption
GetModel []gax.CallOption
ListModels []gax.CallOption
UpdateModel []gax.CallOption
DeleteModel []gax.CallOption
ExportModel []gax.CallOption
GetModelEvaluation []gax.CallOption
ListModelEvaluations []gax.CallOption
GetModelEvaluationSlice []gax.CallOption
ListModelEvaluationSlices []gax.CallOption
}
ModelCallOptions contains the retry settings for each method of ModelClient.
ModelClient
type ModelClient struct {
// The call options for this service.
CallOptions *ModelCallOptions
// 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
}
ModelClient is a client for interacting with Vertex AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
A service for managing Vertex AI’s machine learning Models.
func NewModelClient
func NewModelClient(ctx context.Context, opts ...option.ClientOption) (*ModelClient, error)
NewModelClient creates a new model service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
A service for managing Vertex AI’s machine learning Models.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*ModelClient) Close
func (c *ModelClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*ModelClient) Connection
func (c *ModelClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*ModelClient) DeleteModel
func (c *ModelClient) DeleteModel(ctx context.Context, req *aiplatformpb.DeleteModelRequest, opts ...gax.CallOption) (*DeleteModelOperation, error)
DeleteModel deletes a Model. Note: Model can only be deleted if there are no DeployedModels created from it.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteModelRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*ModelClient) DeleteModelOperation
func (c *ModelClient) DeleteModelOperation(name string) *DeleteModelOperation
DeleteModelOperation returns a new DeleteModelOperation from a given name. The name must be that of a previously created DeleteModelOperation, possibly from a different process.
func (*ModelClient) ExportModel
func (c *ModelClient) ExportModel(ctx context.Context, req *aiplatformpb.ExportModelRequest, opts ...gax.CallOption) (*ExportModelOperation, error)
ExportModel exports a trained, exportable, Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ExportModelRequest{
// TODO: Fill request struct fields.
}
op, err := c.ExportModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) ExportModelOperation
func (c *ModelClient) ExportModelOperation(name string) *ExportModelOperation
ExportModelOperation returns a new ExportModelOperation from a given name. The name must be that of a previously created ExportModelOperation, possibly from a different process.
func (*ModelClient) GetModel
func (c *ModelClient) GetModel(ctx context.Context, req *aiplatformpb.GetModelRequest, opts ...gax.CallOption) (*aiplatformpb.Model, error)
GetModel gets a Model.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetModelRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) GetModelEvaluation
func (c *ModelClient) GetModelEvaluation(ctx context.Context, req *aiplatformpb.GetModelEvaluationRequest, opts ...gax.CallOption) (*aiplatformpb.ModelEvaluation, error)
GetModelEvaluation gets a ModelEvaluation.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetModelEvaluationRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetModelEvaluation(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) GetModelEvaluationSlice
func (c *ModelClient) GetModelEvaluationSlice(ctx context.Context, req *aiplatformpb.GetModelEvaluationSliceRequest, opts ...gax.CallOption) (*aiplatformpb.ModelEvaluationSlice, error)
GetModelEvaluationSlice gets a ModelEvaluationSlice.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetModelEvaluationSliceRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetModelEvaluationSlice(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) ListModelEvaluationSlices
func (c *ModelClient) ListModelEvaluationSlices(ctx context.Context, req *aiplatformpb.ListModelEvaluationSlicesRequest, opts ...gax.CallOption) *ModelEvaluationSliceIterator
ListModelEvaluationSlices lists ModelEvaluationSlices in a ModelEvaluation.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListModelEvaluationSlicesRequest{
// TODO: Fill request struct fields.
}
it := c.ListModelEvaluationSlices(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ModelClient) ListModelEvaluations
func (c *ModelClient) ListModelEvaluations(ctx context.Context, req *aiplatformpb.ListModelEvaluationsRequest, opts ...gax.CallOption) *ModelEvaluationIterator
ListModelEvaluations lists ModelEvaluations in a Model.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListModelEvaluationsRequest{
// TODO: Fill request struct fields.
}
it := c.ListModelEvaluations(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ModelClient) ListModels
func (c *ModelClient) ListModels(ctx context.Context, req *aiplatformpb.ListModelsRequest, opts ...gax.CallOption) *ModelIterator
ListModels lists Models in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListModelsRequest{
// TODO: Fill request struct fields.
}
it := c.ListModels(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ModelClient) UpdateModel
func (c *ModelClient) UpdateModel(ctx context.Context, req *aiplatformpb.UpdateModelRequest, opts ...gax.CallOption) (*aiplatformpb.Model, error)
UpdateModel updates a Model.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.UpdateModelRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) UploadModel
func (c *ModelClient) UploadModel(ctx context.Context, req *aiplatformpb.UploadModelRequest, opts ...gax.CallOption) (*UploadModelOperation, error)
UploadModel uploads a Model artifact into Vertex AI.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewModelClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.UploadModelRequest{
// TODO: Fill request struct fields.
}
op, err := c.UploadModel(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ModelClient) UploadModelOperation
func (c *ModelClient) UploadModelOperation(name string) *UploadModelOperation
UploadModelOperation returns a new UploadModelOperation from a given name. The name must be that of a previously created UploadModelOperation, possibly from a different process.
ModelEvaluationIterator
type ModelEvaluationIterator 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 []*aiplatformpb.ModelEvaluation, nextPageToken string, err error)
// contains filtered or unexported fields
}
ModelEvaluationIterator manages a stream of *aiplatformpb.ModelEvaluation.
func (*ModelEvaluationIterator) Next
func (it *ModelEvaluationIterator) Next() (*aiplatformpb.ModelEvaluation, 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 (*ModelEvaluationIterator) PageInfo
func (it *ModelEvaluationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ModelEvaluationSliceIterator
type ModelEvaluationSliceIterator 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 []*aiplatformpb.ModelEvaluationSlice, nextPageToken string, err error)
// contains filtered or unexported fields
}
ModelEvaluationSliceIterator manages a stream of *aiplatformpb.ModelEvaluationSlice.
func (*ModelEvaluationSliceIterator) Next
func (it *ModelEvaluationSliceIterator) Next() (*aiplatformpb.ModelEvaluationSlice, 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 (*ModelEvaluationSliceIterator) PageInfo
func (it *ModelEvaluationSliceIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ModelIterator
type ModelIterator 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 []*aiplatformpb.Model, nextPageToken string, err error)
// contains filtered or unexported fields
}
ModelIterator manages a stream of *aiplatformpb.Model.
func (*ModelIterator) Next
func (it *ModelIterator) Next() (*aiplatformpb.Model, 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 (*ModelIterator) PageInfo
func (it *ModelIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
PipelineCallOptions
type PipelineCallOptions struct {
CreateTrainingPipeline []gax.CallOption
GetTrainingPipeline []gax.CallOption
ListTrainingPipelines []gax.CallOption
DeleteTrainingPipeline []gax.CallOption
CancelTrainingPipeline []gax.CallOption
CreatePipelineJob []gax.CallOption
GetPipelineJob []gax.CallOption
ListPipelineJobs []gax.CallOption
DeletePipelineJob []gax.CallOption
CancelPipelineJob []gax.CallOption
}
PipelineCallOptions contains the retry settings for each method of PipelineClient.
PipelineClient
type PipelineClient struct {
// The call options for this service.
CallOptions *PipelineCallOptions
// 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
}
PipelineClient is a client for interacting with Vertex AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
A service for creating and managing Vertex AI’s pipelines. This includes both TrainingPipeline resources (used for AutoML and custom training) and PipelineJob resources (used for Vertex Pipelines).
func NewPipelineClient
func NewPipelineClient(ctx context.Context, opts ...option.ClientOption) (*PipelineClient, error)
NewPipelineClient creates a new pipeline service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
A service for creating and managing Vertex AI’s pipelines. This includes both TrainingPipeline resources (used for AutoML and custom training) and PipelineJob resources (used for Vertex Pipelines).
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*PipelineClient) CancelPipelineJob
func (c *PipelineClient) CancelPipelineJob(ctx context.Context, req *aiplatformpb.CancelPipelineJobRequest, opts ...gax.CallOption) error
CancelPipelineJob cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and PipelineJob.state is set to CANCELLED.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CancelPipelineJobRequest{
// TODO: Fill request struct fields.
}
err = c.CancelPipelineJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*PipelineClient) CancelTrainingPipeline
func (c *PipelineClient) CancelTrainingPipeline(ctx context.Context, req *aiplatformpb.CancelTrainingPipelineRequest, opts ...gax.CallOption) error
CancelTrainingPipeline cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and TrainingPipeline.state is set to CANCELLED.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CancelTrainingPipelineRequest{
// TODO: Fill request struct fields.
}
err = c.CancelTrainingPipeline(ctx, req)
if err != nil {
// TODO: Handle error.
}
}
func (*PipelineClient) Close
func (c *PipelineClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*PipelineClient) Connection
func (c *PipelineClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*PipelineClient) CreatePipelineJob
func (c *PipelineClient) CreatePipelineJob(ctx context.Context, req *aiplatformpb.CreatePipelineJobRequest, opts ...gax.CallOption) (*aiplatformpb.PipelineJob, error)
CreatePipelineJob creates a PipelineJob. A PipelineJob will run immediately when created.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreatePipelineJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreatePipelineJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PipelineClient) CreateTrainingPipeline
func (c *PipelineClient) CreateTrainingPipeline(ctx context.Context, req *aiplatformpb.CreateTrainingPipelineRequest, opts ...gax.CallOption) (*aiplatformpb.TrainingPipeline, error)
CreateTrainingPipeline creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreateTrainingPipelineRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateTrainingPipeline(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PipelineClient) DeletePipelineJob
func (c *PipelineClient) DeletePipelineJob(ctx context.Context, req *aiplatformpb.DeletePipelineJobRequest, opts ...gax.CallOption) (*DeletePipelineJobOperation, error)
DeletePipelineJob deletes a PipelineJob.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeletePipelineJobRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeletePipelineJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*PipelineClient) DeletePipelineJobOperation
func (c *PipelineClient) DeletePipelineJobOperation(name string) *DeletePipelineJobOperation
DeletePipelineJobOperation returns a new DeletePipelineJobOperation from a given name. The name must be that of a previously created DeletePipelineJobOperation, possibly from a different process.
func (*PipelineClient) DeleteTrainingPipeline
func (c *PipelineClient) DeleteTrainingPipeline(ctx context.Context, req *aiplatformpb.DeleteTrainingPipelineRequest, opts ...gax.CallOption) (*DeleteTrainingPipelineOperation, error)
DeleteTrainingPipeline deletes a TrainingPipeline.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteTrainingPipelineRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteTrainingPipeline(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*PipelineClient) DeleteTrainingPipelineOperation
func (c *PipelineClient) DeleteTrainingPipelineOperation(name string) *DeleteTrainingPipelineOperation
DeleteTrainingPipelineOperation returns a new DeleteTrainingPipelineOperation from a given name. The name must be that of a previously created DeleteTrainingPipelineOperation, possibly from a different process.
func (*PipelineClient) GetPipelineJob
func (c *PipelineClient) GetPipelineJob(ctx context.Context, req *aiplatformpb.GetPipelineJobRequest, opts ...gax.CallOption) (*aiplatformpb.PipelineJob, error)
GetPipelineJob gets a PipelineJob.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetPipelineJobRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetPipelineJob(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PipelineClient) GetTrainingPipeline
func (c *PipelineClient) GetTrainingPipeline(ctx context.Context, req *aiplatformpb.GetTrainingPipelineRequest, opts ...gax.CallOption) (*aiplatformpb.TrainingPipeline, error)
GetTrainingPipeline gets a TrainingPipeline.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetTrainingPipelineRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetTrainingPipeline(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*PipelineClient) ListPipelineJobs
func (c *PipelineClient) ListPipelineJobs(ctx context.Context, req *aiplatformpb.ListPipelineJobsRequest, opts ...gax.CallOption) *PipelineJobIterator
ListPipelineJobs lists PipelineJobs in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListPipelineJobsRequest{
// TODO: Fill request struct fields.
}
it := c.ListPipelineJobs(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*PipelineClient) ListTrainingPipelines
func (c *PipelineClient) ListTrainingPipelines(ctx context.Context, req *aiplatformpb.ListTrainingPipelinesRequest, opts ...gax.CallOption) *TrainingPipelineIterator
ListTrainingPipelines lists TrainingPipelines in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPipelineClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListTrainingPipelinesRequest{
// TODO: Fill request struct fields.
}
it := c.ListTrainingPipelines(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
PipelineJobIterator
type PipelineJobIterator 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 []*aiplatformpb.PipelineJob, nextPageToken string, err error)
// contains filtered or unexported fields
}
PipelineJobIterator manages a stream of *aiplatformpb.PipelineJob.
func (*PipelineJobIterator) Next
func (it *PipelineJobIterator) Next() (*aiplatformpb.PipelineJob, 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 (*PipelineJobIterator) PageInfo
func (it *PipelineJobIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
PredictionCallOptions
type PredictionCallOptions struct {
Predict []gax.CallOption
}
PredictionCallOptions contains the retry settings for each method of PredictionClient.
PredictionClient
type PredictionClient struct {
// The call options for this service.
CallOptions *PredictionCallOptions
// contains filtered or unexported fields
}
PredictionClient is a client for interacting with Vertex AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
A service for online predictions and explanations.
func NewPredictionClient
func NewPredictionClient(ctx context.Context, opts ...option.ClientOption) (*PredictionClient, error)
NewPredictionClient creates a new prediction service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
A service for online predictions and explanations.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPredictionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*PredictionClient) Close
func (c *PredictionClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*PredictionClient) Connection
func (c *PredictionClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*PredictionClient) Predict
func (c *PredictionClient) Predict(ctx context.Context, req *aiplatformpb.PredictRequest, opts ...gax.CallOption) (*aiplatformpb.PredictResponse, error)
Predict perform an online prediction.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewPredictionClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.PredictRequest{
// TODO: Fill request struct fields.
}
resp, err := c.Predict(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
SpecialistPoolCallOptions
type SpecialistPoolCallOptions struct {
CreateSpecialistPool []gax.CallOption
GetSpecialistPool []gax.CallOption
ListSpecialistPools []gax.CallOption
DeleteSpecialistPool []gax.CallOption
UpdateSpecialistPool []gax.CallOption
}
SpecialistPoolCallOptions contains the retry settings for each method of SpecialistPoolClient.
SpecialistPoolClient
type SpecialistPoolClient struct {
// The call options for this service.
CallOptions *SpecialistPoolCallOptions
// 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
}
SpecialistPoolClient is a client for interacting with Vertex AI API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
A service for creating and managing Customer SpecialistPools. When customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud console, then Managers will get email notifications to manage Specialists and tasks on CrowdCompute console.
func NewSpecialistPoolClient
func NewSpecialistPoolClient(ctx context.Context, opts ...option.ClientOption) (*SpecialistPoolClient, error)
NewSpecialistPoolClient creates a new specialist pool service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
A service for creating and managing Customer SpecialistPools. When customers start Data Labeling jobs, they can reuse/create Specialist Pools to bring their own Specialists to label the data. Customers can add/remove Managers for the Specialist Pool on Cloud console, then Managers will get email notifications to manage Specialists and tasks on CrowdCompute console.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewSpecialistPoolClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*SpecialistPoolClient) Close
func (c *SpecialistPoolClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*SpecialistPoolClient) Connection
func (c *SpecialistPoolClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*SpecialistPoolClient) CreateSpecialistPool
func (c *SpecialistPoolClient) CreateSpecialistPool(ctx context.Context, req *aiplatformpb.CreateSpecialistPoolRequest, opts ...gax.CallOption) (*CreateSpecialistPoolOperation, error)
CreateSpecialistPool creates a SpecialistPool.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewSpecialistPoolClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.CreateSpecialistPoolRequest{
// TODO: Fill request struct fields.
}
op, err := c.CreateSpecialistPool(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*SpecialistPoolClient) CreateSpecialistPoolOperation
func (c *SpecialistPoolClient) CreateSpecialistPoolOperation(name string) *CreateSpecialistPoolOperation
CreateSpecialistPoolOperation returns a new CreateSpecialistPoolOperation from a given name. The name must be that of a previously created CreateSpecialistPoolOperation, possibly from a different process.
func (*SpecialistPoolClient) DeleteSpecialistPool
func (c *SpecialistPoolClient) DeleteSpecialistPool(ctx context.Context, req *aiplatformpb.DeleteSpecialistPoolRequest, opts ...gax.CallOption) (*DeleteSpecialistPoolOperation, error)
DeleteSpecialistPool deletes a SpecialistPool as well as all Specialists in the pool.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewSpecialistPoolClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.DeleteSpecialistPoolRequest{
// TODO: Fill request struct fields.
}
op, err := c.DeleteSpecialistPool(ctx, req)
if err != nil {
// TODO: Handle error.
}
err = op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
}
func (*SpecialistPoolClient) DeleteSpecialistPoolOperation
func (c *SpecialistPoolClient) DeleteSpecialistPoolOperation(name string) *DeleteSpecialistPoolOperation
DeleteSpecialistPoolOperation returns a new DeleteSpecialistPoolOperation from a given name. The name must be that of a previously created DeleteSpecialistPoolOperation, possibly from a different process.
func (*SpecialistPoolClient) GetSpecialistPool
func (c *SpecialistPoolClient) GetSpecialistPool(ctx context.Context, req *aiplatformpb.GetSpecialistPoolRequest, opts ...gax.CallOption) (*aiplatformpb.SpecialistPool, error)
GetSpecialistPool gets a SpecialistPool.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewSpecialistPoolClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.GetSpecialistPoolRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetSpecialistPool(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*SpecialistPoolClient) ListSpecialistPools
func (c *SpecialistPoolClient) ListSpecialistPools(ctx context.Context, req *aiplatformpb.ListSpecialistPoolsRequest, opts ...gax.CallOption) *SpecialistPoolIterator
ListSpecialistPools lists SpecialistPools in a Location.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
"google.golang.org/api/iterator"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewSpecialistPoolClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.ListSpecialistPoolsRequest{
// TODO: Fill request struct fields.
}
it := c.ListSpecialistPools(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*SpecialistPoolClient) UpdateSpecialistPool
func (c *SpecialistPoolClient) UpdateSpecialistPool(ctx context.Context, req *aiplatformpb.UpdateSpecialistPoolRequest, opts ...gax.CallOption) (*UpdateSpecialistPoolOperation, error)
UpdateSpecialistPool updates a SpecialistPool.
Example
package main
import (
aiplatform "cloud.google.com/go/aiplatform/apiv1"
"context"
aiplatformpb "google.golang.org/genproto/googleapis/cloud/aiplatform/v1"
)
func main() {
ctx := context.Background()
c, err := aiplatform.NewSpecialistPoolClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &aiplatformpb.UpdateSpecialistPoolRequest{
// TODO: Fill request struct fields.
}
op, err := c.UpdateSpecialistPool(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*SpecialistPoolClient) UpdateSpecialistPoolOperation
func (c *SpecialistPoolClient) UpdateSpecialistPoolOperation(name string) *UpdateSpecialistPoolOperation
UpdateSpecialistPoolOperation returns a new UpdateSpecialistPoolOperation from a given name. The name must be that of a previously created UpdateSpecialistPoolOperation, possibly from a different process.
SpecialistPoolIterator
type SpecialistPoolIterator 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 []*aiplatformpb.SpecialistPool, nextPageToken string, err error)
// contains filtered or unexported fields
}
SpecialistPoolIterator manages a stream of *aiplatformpb.SpecialistPool.
func (*SpecialistPoolIterator) Next
func (it *SpecialistPoolIterator) Next() (*aiplatformpb.SpecialistPool, 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 (*SpecialistPoolIterator) PageInfo
func (it *SpecialistPoolIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
TrainingPipelineIterator
type TrainingPipelineIterator 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 []*aiplatformpb.TrainingPipeline, nextPageToken string, err error)
// contains filtered or unexported fields
}
TrainingPipelineIterator manages a stream of *aiplatformpb.TrainingPipeline.
func (*TrainingPipelineIterator) Next
func (it *TrainingPipelineIterator) Next() (*aiplatformpb.TrainingPipeline, 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 (*TrainingPipelineIterator) PageInfo
func (it *TrainingPipelineIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
UndeployModelOperation
type UndeployModelOperation struct {
// contains filtered or unexported fields
}
UndeployModelOperation manages a long-running operation from UndeployModel.
func (*UndeployModelOperation) Done
func (op *UndeployModelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UndeployModelOperation) Metadata
func (op *UndeployModelOperation) Metadata() (*aiplatformpb.UndeployModelOperationMetadata, 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 (*UndeployModelOperation) Name
func (op *UndeployModelOperation) 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 (*UndeployModelOperation) Poll
func (op *UndeployModelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.UndeployModelResponse, 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 (*UndeployModelOperation) Wait
func (op *UndeployModelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.UndeployModelResponse, 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.
UpdateSpecialistPoolOperation
type UpdateSpecialistPoolOperation struct {
// contains filtered or unexported fields
}
UpdateSpecialistPoolOperation manages a long-running operation from UpdateSpecialistPool.
func (*UpdateSpecialistPoolOperation) Done
func (op *UpdateSpecialistPoolOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateSpecialistPoolOperation) Metadata
func (op *UpdateSpecialistPoolOperation) Metadata() (*aiplatformpb.UpdateSpecialistPoolOperationMetadata, 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 (*UpdateSpecialistPoolOperation) Name
func (op *UpdateSpecialistPoolOperation) 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 (*UpdateSpecialistPoolOperation) Poll
func (op *UpdateSpecialistPoolOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.SpecialistPool, 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 (*UpdateSpecialistPoolOperation) Wait
func (op *UpdateSpecialistPoolOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.SpecialistPool, 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.
UploadModelOperation
type UploadModelOperation struct {
// contains filtered or unexported fields
}
UploadModelOperation manages a long-running operation from UploadModel.
func (*UploadModelOperation) Done
func (op *UploadModelOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UploadModelOperation) Metadata
func (op *UploadModelOperation) Metadata() (*aiplatformpb.UploadModelOperationMetadata, 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 (*UploadModelOperation) Name
func (op *UploadModelOperation) 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 (*UploadModelOperation) Poll
func (op *UploadModelOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.UploadModelResponse, 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 (*UploadModelOperation) Wait
func (op *UploadModelOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*aiplatformpb.UploadModelResponse, 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.