Documentation ¶
Overview ¶
Package metastore is an auto-generated package for the Dataproc Metastore API.
The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.
General documentation ¶
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage ¶
To get started with this package, create a client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client ¶
The following is an example of making an API call with the newly created client.
ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.AlterMetadataResourceLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#AlterMetadataResourceLocationRequest. } op, err := c.AlterMetadataResourceLocation(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context ¶
The ctx passed to NewDataprocMetastoreClient 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.
Index ¶
- func DefaultAuthScopes() []string
- type AlterMetadataResourceLocationOperation
- func (op *AlterMetadataResourceLocationOperation) Done() bool
- func (op *AlterMetadataResourceLocationOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *AlterMetadataResourceLocationOperation) Name() string
- func (op *AlterMetadataResourceLocationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.AlterMetadataResourceLocationResponse, error)
- func (op *AlterMetadataResourceLocationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.AlterMetadataResourceLocationResponse, error)
- type BackupIterator
- type CreateBackupOperation
- func (op *CreateBackupOperation) Done() bool
- func (op *CreateBackupOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *CreateBackupOperation) Name() string
- func (op *CreateBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Backup, error)
- func (op *CreateBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Backup, error)
- type CreateFederationOperation
- func (op *CreateFederationOperation) Done() bool
- func (op *CreateFederationOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *CreateFederationOperation) Name() string
- func (op *CreateFederationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Federation, error)
- func (op *CreateFederationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Federation, error)
- type CreateMetadataImportOperation
- func (op *CreateMetadataImportOperation) Done() bool
- func (op *CreateMetadataImportOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *CreateMetadataImportOperation) Name() string
- func (op *CreateMetadataImportOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataImport, error)
- func (op *CreateMetadataImportOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataImport, error)
- type CreateServiceOperation
- func (op *CreateServiceOperation) Done() bool
- func (op *CreateServiceOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *CreateServiceOperation) Name() string
- func (op *CreateServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Service, error)
- func (op *CreateServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Service, error)
- type DataprocMetastoreCallOptions
- type DataprocMetastoreClient
- func (c *DataprocMetastoreClient) AlterMetadataResourceLocation(ctx context.Context, req *metastorepb.AlterMetadataResourceLocationRequest, ...) (*AlterMetadataResourceLocationOperation, error)
- func (c *DataprocMetastoreClient) AlterMetadataResourceLocationOperation(name string) *AlterMetadataResourceLocationOperation
- func (c *DataprocMetastoreClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *DataprocMetastoreClient) Close() error
- func (c *DataprocMetastoreClient) Connection() *grpc.ClientConndeprecated
- func (c *DataprocMetastoreClient) CreateBackup(ctx context.Context, req *metastorepb.CreateBackupRequest, ...) (*CreateBackupOperation, error)
- func (c *DataprocMetastoreClient) CreateBackupOperation(name string) *CreateBackupOperation
- func (c *DataprocMetastoreClient) CreateMetadataImport(ctx context.Context, req *metastorepb.CreateMetadataImportRequest, ...) (*CreateMetadataImportOperation, error)
- func (c *DataprocMetastoreClient) CreateMetadataImportOperation(name string) *CreateMetadataImportOperation
- func (c *DataprocMetastoreClient) CreateService(ctx context.Context, req *metastorepb.CreateServiceRequest, ...) (*CreateServiceOperation, error)
- func (c *DataprocMetastoreClient) CreateServiceOperation(name string) *CreateServiceOperation
- func (c *DataprocMetastoreClient) DeleteBackup(ctx context.Context, req *metastorepb.DeleteBackupRequest, ...) (*DeleteBackupOperation, error)
- func (c *DataprocMetastoreClient) DeleteBackupOperation(name string) *DeleteBackupOperation
- func (c *DataprocMetastoreClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *DataprocMetastoreClient) DeleteService(ctx context.Context, req *metastorepb.DeleteServiceRequest, ...) (*DeleteServiceOperation, error)
- func (c *DataprocMetastoreClient) DeleteServiceOperation(name string) *DeleteServiceOperation
- func (c *DataprocMetastoreClient) ExportMetadata(ctx context.Context, req *metastorepb.ExportMetadataRequest, ...) (*ExportMetadataOperation, error)
- func (c *DataprocMetastoreClient) ExportMetadataOperation(name string) *ExportMetadataOperation
- func (c *DataprocMetastoreClient) GetBackup(ctx context.Context, req *metastorepb.GetBackupRequest, opts ...gax.CallOption) (*metastorepb.Backup, error)
- func (c *DataprocMetastoreClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *DataprocMetastoreClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *DataprocMetastoreClient) GetMetadataImport(ctx context.Context, req *metastorepb.GetMetadataImportRequest, ...) (*metastorepb.MetadataImport, error)
- func (c *DataprocMetastoreClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *DataprocMetastoreClient) GetService(ctx context.Context, req *metastorepb.GetServiceRequest, ...) (*metastorepb.Service, error)
- func (c *DataprocMetastoreClient) ListBackups(ctx context.Context, req *metastorepb.ListBackupsRequest, ...) *BackupIterator
- func (c *DataprocMetastoreClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *DataprocMetastoreClient) ListMetadataImports(ctx context.Context, req *metastorepb.ListMetadataImportsRequest, ...) *MetadataImportIterator
- func (c *DataprocMetastoreClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *DataprocMetastoreClient) ListServices(ctx context.Context, req *metastorepb.ListServicesRequest, ...) *ServiceIterator
- func (c *DataprocMetastoreClient) MoveTableToDatabase(ctx context.Context, req *metastorepb.MoveTableToDatabaseRequest, ...) (*MoveTableToDatabaseOperation, error)
- func (c *DataprocMetastoreClient) MoveTableToDatabaseOperation(name string) *MoveTableToDatabaseOperation
- func (c *DataprocMetastoreClient) QueryMetadata(ctx context.Context, req *metastorepb.QueryMetadataRequest, ...) (*QueryMetadataOperation, error)
- func (c *DataprocMetastoreClient) QueryMetadataOperation(name string) *QueryMetadataOperation
- func (c *DataprocMetastoreClient) RestoreService(ctx context.Context, req *metastorepb.RestoreServiceRequest, ...) (*RestoreServiceOperation, error)
- func (c *DataprocMetastoreClient) RestoreServiceOperation(name string) *RestoreServiceOperation
- func (c *DataprocMetastoreClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *DataprocMetastoreClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, ...) (*iampb.TestIamPermissionsResponse, error)
- func (c *DataprocMetastoreClient) UpdateMetadataImport(ctx context.Context, req *metastorepb.UpdateMetadataImportRequest, ...) (*UpdateMetadataImportOperation, error)
- func (c *DataprocMetastoreClient) UpdateMetadataImportOperation(name string) *UpdateMetadataImportOperation
- func (c *DataprocMetastoreClient) UpdateService(ctx context.Context, req *metastorepb.UpdateServiceRequest, ...) (*UpdateServiceOperation, error)
- func (c *DataprocMetastoreClient) UpdateServiceOperation(name string) *UpdateServiceOperation
- type DataprocMetastoreFederationCallOptions
- type DataprocMetastoreFederationClient
- func (c *DataprocMetastoreFederationClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *DataprocMetastoreFederationClient) Close() error
- func (c *DataprocMetastoreFederationClient) Connection() *grpc.ClientConndeprecated
- func (c *DataprocMetastoreFederationClient) CreateFederation(ctx context.Context, req *metastorepb.CreateFederationRequest, ...) (*CreateFederationOperation, error)
- func (c *DataprocMetastoreFederationClient) CreateFederationOperation(name string) *CreateFederationOperation
- func (c *DataprocMetastoreFederationClient) DeleteFederation(ctx context.Context, req *metastorepb.DeleteFederationRequest, ...) (*DeleteFederationOperation, error)
- func (c *DataprocMetastoreFederationClient) DeleteFederationOperation(name string) *DeleteFederationOperation
- func (c *DataprocMetastoreFederationClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *DataprocMetastoreFederationClient) GetFederation(ctx context.Context, req *metastorepb.GetFederationRequest, ...) (*metastorepb.Federation, error)
- func (c *DataprocMetastoreFederationClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *DataprocMetastoreFederationClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *DataprocMetastoreFederationClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *DataprocMetastoreFederationClient) ListFederations(ctx context.Context, req *metastorepb.ListFederationsRequest, ...) *FederationIterator
- func (c *DataprocMetastoreFederationClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *DataprocMetastoreFederationClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *DataprocMetastoreFederationClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *DataprocMetastoreFederationClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, ...) (*iampb.TestIamPermissionsResponse, error)
- func (c *DataprocMetastoreFederationClient) UpdateFederation(ctx context.Context, req *metastorepb.UpdateFederationRequest, ...) (*UpdateFederationOperation, error)
- func (c *DataprocMetastoreFederationClient) UpdateFederationOperation(name string) *UpdateFederationOperation
- type DeleteBackupOperation
- func (op *DeleteBackupOperation) Done() bool
- func (op *DeleteBackupOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *DeleteBackupOperation) Name() string
- func (op *DeleteBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteFederationOperation
- func (op *DeleteFederationOperation) Done() bool
- func (op *DeleteFederationOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *DeleteFederationOperation) Name() string
- func (op *DeleteFederationOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteFederationOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteServiceOperation
- func (op *DeleteServiceOperation) Done() bool
- func (op *DeleteServiceOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *DeleteServiceOperation) Name() string
- func (op *DeleteServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type ExportMetadataOperation
- func (op *ExportMetadataOperation) Done() bool
- func (op *ExportMetadataOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *ExportMetadataOperation) Name() string
- func (op *ExportMetadataOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataExport, error)
- func (op *ExportMetadataOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataExport, error)
- type FederationIterator
- type LocationIterator
- type MetadataImportIterator
- type MoveTableToDatabaseOperation
- func (op *MoveTableToDatabaseOperation) Done() bool
- func (op *MoveTableToDatabaseOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *MoveTableToDatabaseOperation) Name() string
- func (op *MoveTableToDatabaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MoveTableToDatabaseResponse, error)
- func (op *MoveTableToDatabaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MoveTableToDatabaseResponse, error)
- type OperationIterator
- type QueryMetadataOperation
- func (op *QueryMetadataOperation) Done() bool
- func (op *QueryMetadataOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *QueryMetadataOperation) Name() string
- func (op *QueryMetadataOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.QueryMetadataResponse, error)
- func (op *QueryMetadataOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.QueryMetadataResponse, error)
- type RestoreServiceOperation
- func (op *RestoreServiceOperation) Done() bool
- func (op *RestoreServiceOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *RestoreServiceOperation) Name() string
- func (op *RestoreServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Restore, error)
- func (op *RestoreServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Restore, error)
- type ServiceIterator
- type UpdateFederationOperation
- func (op *UpdateFederationOperation) Done() bool
- func (op *UpdateFederationOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *UpdateFederationOperation) Name() string
- func (op *UpdateFederationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Federation, error)
- func (op *UpdateFederationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Federation, error)
- type UpdateMetadataImportOperation
- func (op *UpdateMetadataImportOperation) Done() bool
- func (op *UpdateMetadataImportOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *UpdateMetadataImportOperation) Name() string
- func (op *UpdateMetadataImportOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataImport, error)
- func (op *UpdateMetadataImportOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataImport, error)
- type UpdateServiceOperation
- func (op *UpdateServiceOperation) Done() bool
- func (op *UpdateServiceOperation) Metadata() (*metastorepb.OperationMetadata, error)
- func (op *UpdateServiceOperation) Name() string
- func (op *UpdateServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Service, error)
- func (op *UpdateServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Service, error)
Examples ¶
- DataprocMetastoreClient.AlterMetadataResourceLocation
- DataprocMetastoreClient.CancelOperation
- DataprocMetastoreClient.CreateBackup
- DataprocMetastoreClient.CreateMetadataImport
- DataprocMetastoreClient.CreateService
- DataprocMetastoreClient.DeleteBackup
- DataprocMetastoreClient.DeleteOperation
- DataprocMetastoreClient.DeleteService
- DataprocMetastoreClient.ExportMetadata
- DataprocMetastoreClient.GetBackup
- DataprocMetastoreClient.GetIamPolicy
- DataprocMetastoreClient.GetLocation
- DataprocMetastoreClient.GetMetadataImport
- DataprocMetastoreClient.GetOperation
- DataprocMetastoreClient.GetService
- DataprocMetastoreClient.ListBackups
- DataprocMetastoreClient.ListBackups (All)
- DataprocMetastoreClient.ListLocations
- DataprocMetastoreClient.ListLocations (All)
- DataprocMetastoreClient.ListMetadataImports
- DataprocMetastoreClient.ListMetadataImports (All)
- DataprocMetastoreClient.ListOperations
- DataprocMetastoreClient.ListOperations (All)
- DataprocMetastoreClient.ListServices
- DataprocMetastoreClient.ListServices (All)
- DataprocMetastoreClient.MoveTableToDatabase
- DataprocMetastoreClient.QueryMetadata
- DataprocMetastoreClient.RestoreService
- DataprocMetastoreClient.SetIamPolicy
- DataprocMetastoreClient.TestIamPermissions
- DataprocMetastoreClient.UpdateMetadataImport
- DataprocMetastoreClient.UpdateService
- DataprocMetastoreFederationClient.CancelOperation
- DataprocMetastoreFederationClient.CreateFederation
- DataprocMetastoreFederationClient.DeleteFederation
- DataprocMetastoreFederationClient.DeleteOperation
- DataprocMetastoreFederationClient.GetFederation
- DataprocMetastoreFederationClient.GetIamPolicy
- DataprocMetastoreFederationClient.GetLocation
- DataprocMetastoreFederationClient.GetOperation
- DataprocMetastoreFederationClient.ListFederations
- DataprocMetastoreFederationClient.ListFederations (All)
- DataprocMetastoreFederationClient.ListLocations
- DataprocMetastoreFederationClient.ListLocations (All)
- DataprocMetastoreFederationClient.ListOperations
- DataprocMetastoreFederationClient.ListOperations (All)
- DataprocMetastoreFederationClient.SetIamPolicy
- DataprocMetastoreFederationClient.TestIamPermissions
- DataprocMetastoreFederationClient.UpdateFederation
- NewDataprocMetastoreClient
- NewDataprocMetastoreFederationClient
- NewDataprocMetastoreFederationRESTClient
- NewDataprocMetastoreRESTClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DefaultAuthScopes ¶
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
Types ¶
type AlterMetadataResourceLocationOperation ¶ added in v1.12.0
type AlterMetadataResourceLocationOperation struct {
// contains filtered or unexported fields
}
AlterMetadataResourceLocationOperation manages a long-running operation from AlterMetadataResourceLocation.
func (*AlterMetadataResourceLocationOperation) Done ¶ added in v1.12.0
func (op *AlterMetadataResourceLocationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*AlterMetadataResourceLocationOperation) Metadata ¶ added in v1.12.0
func (op *AlterMetadataResourceLocationOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*AlterMetadataResourceLocationOperation) Name ¶ added in v1.12.0
func (op *AlterMetadataResourceLocationOperation) 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 (*AlterMetadataResourceLocationOperation) Poll ¶ added in v1.12.0
func (op *AlterMetadataResourceLocationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.AlterMetadataResourceLocationResponse, 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 (*AlterMetadataResourceLocationOperation) Wait ¶ added in v1.12.0
func (op *AlterMetadataResourceLocationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.AlterMetadataResourceLocationResponse, 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.
type BackupIterator ¶ added in v0.2.0
type BackupIterator 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 []*metastorepb.Backup, nextPageToken string, err error) // contains filtered or unexported fields }
BackupIterator manages a stream of *metastorepb.Backup.
func (*BackupIterator) All ¶ added in v1.14.1
func (it *BackupIterator) All() iter.Seq2[*metastorepb.Backup, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BackupIterator) Next ¶ added in v0.2.0
func (it *BackupIterator) Next() (*metastorepb.Backup, 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 (*BackupIterator) PageInfo ¶ added in v0.2.0
func (it *BackupIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type CreateBackupOperation ¶ added in v0.2.0
type CreateBackupOperation struct {
// contains filtered or unexported fields
}
CreateBackupOperation manages a long-running operation from CreateBackup.
func (*CreateBackupOperation) Done ¶ added in v0.2.0
func (op *CreateBackupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateBackupOperation) Metadata ¶ added in v0.2.0
func (op *CreateBackupOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*CreateBackupOperation) Name ¶ added in v0.2.0
func (op *CreateBackupOperation) 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 (*CreateBackupOperation) Poll ¶ added in v0.2.0
func (op *CreateBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Backup, 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 (*CreateBackupOperation) Wait ¶ added in v0.2.0
func (op *CreateBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Backup, 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.
type CreateFederationOperation ¶ added in v1.9.0
type CreateFederationOperation struct {
// contains filtered or unexported fields
}
CreateFederationOperation manages a long-running operation from CreateFederation.
func (*CreateFederationOperation) Done ¶ added in v1.9.0
func (op *CreateFederationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateFederationOperation) Metadata ¶ added in v1.9.0
func (op *CreateFederationOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*CreateFederationOperation) Name ¶ added in v1.9.0
func (op *CreateFederationOperation) 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 (*CreateFederationOperation) Poll ¶ added in v1.9.0
func (op *CreateFederationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Federation, 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 (*CreateFederationOperation) Wait ¶ added in v1.9.0
func (op *CreateFederationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Federation, 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.
type CreateMetadataImportOperation ¶
type CreateMetadataImportOperation struct {
// contains filtered or unexported fields
}
CreateMetadataImportOperation manages a long-running operation from CreateMetadataImport.
func (*CreateMetadataImportOperation) Done ¶
func (op *CreateMetadataImportOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateMetadataImportOperation) Metadata ¶
func (op *CreateMetadataImportOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*CreateMetadataImportOperation) Name ¶
func (op *CreateMetadataImportOperation) 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 (*CreateMetadataImportOperation) Poll ¶
func (op *CreateMetadataImportOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataImport, 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 (*CreateMetadataImportOperation) Wait ¶
func (op *CreateMetadataImportOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataImport, 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.
type CreateServiceOperation ¶
type CreateServiceOperation struct {
// contains filtered or unexported fields
}
CreateServiceOperation manages a long-running operation from CreateService.
func (*CreateServiceOperation) Done ¶
func (op *CreateServiceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateServiceOperation) Metadata ¶
func (op *CreateServiceOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*CreateServiceOperation) Name ¶
func (op *CreateServiceOperation) 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 (*CreateServiceOperation) Poll ¶
func (op *CreateServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Service, 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 (*CreateServiceOperation) Wait ¶
func (op *CreateServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Service, 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.
type DataprocMetastoreCallOptions ¶
type DataprocMetastoreCallOptions struct { ListServices []gax.CallOption GetService []gax.CallOption CreateService []gax.CallOption UpdateService []gax.CallOption DeleteService []gax.CallOption ListMetadataImports []gax.CallOption GetMetadataImport []gax.CallOption CreateMetadataImport []gax.CallOption UpdateMetadataImport []gax.CallOption ExportMetadata []gax.CallOption RestoreService []gax.CallOption ListBackups []gax.CallOption GetBackup []gax.CallOption CreateBackup []gax.CallOption DeleteBackup []gax.CallOption QueryMetadata []gax.CallOption MoveTableToDatabase []gax.CallOption AlterMetadataResourceLocation []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption GetIamPolicy []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
DataprocMetastoreCallOptions contains the retry settings for each method of DataprocMetastoreClient.
type DataprocMetastoreClient ¶
type DataprocMetastoreClient struct { // The call options for this service. CallOptions *DataprocMetastoreCallOptions // 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 }
DataprocMetastoreClient is a client for interacting with Dataproc Metastore API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Configures and manages metastore services. Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.
The Dataproc Metastore API defines the following resource model:
The service works with a collection of Google Cloud projects, named: /projects/* Each project has a collection of available locations, named: /locations/* (a location must refer to a Google Cloud region) Each location has a collection of services, named: /services/* Dataproc Metastore services are resources with names of the form:
/projects/{project_number}/locations/{location_id}/services/{service_id}.
func NewDataprocMetastoreClient ¶
func NewDataprocMetastoreClient(ctx context.Context, opts ...option.ClientOption) (*DataprocMetastoreClient, error)
NewDataprocMetastoreClient creates a new dataproc metastore client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Configures and manages metastore services. Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.
The Dataproc Metastore API defines the following resource model:
The service works with a collection of Google Cloud projects, named: /projects/* Each project has a collection of available locations, named: /locations/* (a location must refer to a Google Cloud region) Each location has a collection of services, named: /services/* Dataproc Metastore services are resources with names of the form:
/projects/{project_number}/locations/{location_id}/services/{service_id}.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func NewDataprocMetastoreRESTClient ¶ added in v1.10.0
func NewDataprocMetastoreRESTClient(ctx context.Context, opts ...option.ClientOption) (*DataprocMetastoreClient, error)
NewDataprocMetastoreRESTClient creates a new dataproc metastore rest client.
Configures and manages metastore services. Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.
The Dataproc Metastore API defines the following resource model:
The service works with a collection of Google Cloud projects, named: /projects/* Each project has a collection of available locations, named: /locations/* (a location must refer to a Google Cloud region) Each location has a collection of services, named: /services/* Dataproc Metastore services are resources with names of the form:
/projects/{project_number}/locations/{location_id}/services/{service_id}.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreRESTClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*DataprocMetastoreClient) AlterMetadataResourceLocation ¶ added in v1.12.0
func (c *DataprocMetastoreClient) AlterMetadataResourceLocation(ctx context.Context, req *metastorepb.AlterMetadataResourceLocationRequest, opts ...gax.CallOption) (*AlterMetadataResourceLocationOperation, error)
AlterMetadataResourceLocation alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.AlterMetadataResourceLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#AlterMetadataResourceLocationRequest. } op, err := c.AlterMetadataResourceLocation(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) AlterMetadataResourceLocationOperation ¶ added in v1.12.0
func (c *DataprocMetastoreClient) AlterMetadataResourceLocationOperation(name string) *AlterMetadataResourceLocationOperation
AlterMetadataResourceLocationOperation returns a new AlterMetadataResourceLocationOperation from a given name. The name must be that of a previously created AlterMetadataResourceLocationOperation, possibly from a different process.
func (*DataprocMetastoreClient) CancelOperation ¶ added in v1.10.1
func (c *DataprocMetastoreClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*DataprocMetastoreClient) Close ¶
func (c *DataprocMetastoreClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*DataprocMetastoreClient) Connection
deprecated
func (c *DataprocMetastoreClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*DataprocMetastoreClient) CreateBackup ¶ added in v0.2.0
func (c *DataprocMetastoreClient) CreateBackup(ctx context.Context, req *metastorepb.CreateBackupRequest, opts ...gax.CallOption) (*CreateBackupOperation, error)
CreateBackup creates a new backup in a given project and location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.CreateBackupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#CreateBackupRequest. } op, err := c.CreateBackup(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) CreateBackupOperation ¶ added in v0.2.0
func (c *DataprocMetastoreClient) CreateBackupOperation(name string) *CreateBackupOperation
CreateBackupOperation returns a new CreateBackupOperation from a given name. The name must be that of a previously created CreateBackupOperation, possibly from a different process.
func (*DataprocMetastoreClient) CreateMetadataImport ¶
func (c *DataprocMetastoreClient) CreateMetadataImport(ctx context.Context, req *metastorepb.CreateMetadataImportRequest, opts ...gax.CallOption) (*CreateMetadataImportOperation, error)
CreateMetadataImport creates a new MetadataImport in a given project and location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.CreateMetadataImportRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#CreateMetadataImportRequest. } op, err := c.CreateMetadataImport(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) CreateMetadataImportOperation ¶
func (c *DataprocMetastoreClient) CreateMetadataImportOperation(name string) *CreateMetadataImportOperation
CreateMetadataImportOperation returns a new CreateMetadataImportOperation from a given name. The name must be that of a previously created CreateMetadataImportOperation, possibly from a different process.
func (*DataprocMetastoreClient) CreateService ¶
func (c *DataprocMetastoreClient) CreateService(ctx context.Context, req *metastorepb.CreateServiceRequest, opts ...gax.CallOption) (*CreateServiceOperation, error)
CreateService creates a metastore service in a project and location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.CreateServiceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#CreateServiceRequest. } op, err := c.CreateService(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) CreateServiceOperation ¶
func (c *DataprocMetastoreClient) CreateServiceOperation(name string) *CreateServiceOperation
CreateServiceOperation returns a new CreateServiceOperation from a given name. The name must be that of a previously created CreateServiceOperation, possibly from a different process.
func (*DataprocMetastoreClient) DeleteBackup ¶ added in v0.2.0
func (c *DataprocMetastoreClient) DeleteBackup(ctx context.Context, req *metastorepb.DeleteBackupRequest, opts ...gax.CallOption) (*DeleteBackupOperation, error)
DeleteBackup deletes a single backup.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.DeleteBackupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#DeleteBackupRequest. } op, err := c.DeleteBackup(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*DataprocMetastoreClient) DeleteBackupOperation ¶ added in v0.2.0
func (c *DataprocMetastoreClient) DeleteBackupOperation(name string) *DeleteBackupOperation
DeleteBackupOperation returns a new DeleteBackupOperation from a given name. The name must be that of a previously created DeleteBackupOperation, possibly from a different process.
func (*DataprocMetastoreClient) DeleteOperation ¶ added in v1.9.0
func (c *DataprocMetastoreClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*DataprocMetastoreClient) DeleteService ¶
func (c *DataprocMetastoreClient) DeleteService(ctx context.Context, req *metastorepb.DeleteServiceRequest, opts ...gax.CallOption) (*DeleteServiceOperation, error)
DeleteService deletes a single service.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.DeleteServiceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#DeleteServiceRequest. } op, err := c.DeleteService(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*DataprocMetastoreClient) DeleteServiceOperation ¶
func (c *DataprocMetastoreClient) DeleteServiceOperation(name string) *DeleteServiceOperation
DeleteServiceOperation returns a new DeleteServiceOperation from a given name. The name must be that of a previously created DeleteServiceOperation, possibly from a different process.
func (*DataprocMetastoreClient) ExportMetadata ¶
func (c *DataprocMetastoreClient) ExportMetadata(ctx context.Context, req *metastorepb.ExportMetadataRequest, opts ...gax.CallOption) (*ExportMetadataOperation, error)
ExportMetadata exports metadata from a service.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ExportMetadataRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ExportMetadataRequest. } op, err := c.ExportMetadata(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) ExportMetadataOperation ¶
func (c *DataprocMetastoreClient) ExportMetadataOperation(name string) *ExportMetadataOperation
ExportMetadataOperation returns a new ExportMetadataOperation from a given name. The name must be that of a previously created ExportMetadataOperation, possibly from a different process.
func (*DataprocMetastoreClient) GetBackup ¶ added in v0.2.0
func (c *DataprocMetastoreClient) GetBackup(ctx context.Context, req *metastorepb.GetBackupRequest, opts ...gax.CallOption) (*metastorepb.Backup, error)
GetBackup gets details of a single backup.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.GetBackupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#GetBackupRequest. } resp, err := c.GetBackup(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) GetIamPolicy ¶ added in v1.9.0
func (c *DataprocMetastoreClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.GetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest. } resp, err := c.GetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) GetLocation ¶ added in v1.9.0
func (c *DataprocMetastoreClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) GetMetadataImport ¶
func (c *DataprocMetastoreClient) GetMetadataImport(ctx context.Context, req *metastorepb.GetMetadataImportRequest, opts ...gax.CallOption) (*metastorepb.MetadataImport, error)
GetMetadataImport gets details of a single import.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.GetMetadataImportRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#GetMetadataImportRequest. } resp, err := c.GetMetadataImport(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) GetOperation ¶ added in v1.9.0
func (c *DataprocMetastoreClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) GetService ¶
func (c *DataprocMetastoreClient) GetService(ctx context.Context, req *metastorepb.GetServiceRequest, opts ...gax.CallOption) (*metastorepb.Service, error)
GetService gets the details of a single service.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.GetServiceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#GetServiceRequest. } resp, err := c.GetService(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) ListBackups ¶ added in v0.2.0
func (c *DataprocMetastoreClient) ListBackups(ctx context.Context, req *metastorepb.ListBackupsRequest, opts ...gax.CallOption) *BackupIterator
ListBackups lists backups in a service.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ListBackupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ListBackupsRequest. } it := c.ListBackups(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*metastorepb.ListBackupsResponse) } }
Output:
Example (All) ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ListBackupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ListBackupsRequest. } for resp, err := range c.ListBackups(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataprocMetastoreClient) ListLocations ¶ added in v1.9.0
func (c *DataprocMetastoreClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*locationpb.ListLocationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } for resp, err := range c.ListLocations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataprocMetastoreClient) ListMetadataImports ¶
func (c *DataprocMetastoreClient) ListMetadataImports(ctx context.Context, req *metastorepb.ListMetadataImportsRequest, opts ...gax.CallOption) *MetadataImportIterator
ListMetadataImports lists imports in a service.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ListMetadataImportsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ListMetadataImportsRequest. } it := c.ListMetadataImports(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*metastorepb.ListMetadataImportsResponse) } }
Output:
Example (All) ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ListMetadataImportsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ListMetadataImportsRequest. } for resp, err := range c.ListMetadataImports(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataprocMetastoreClient) ListOperations ¶ added in v1.9.0
func (c *DataprocMetastoreClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*longrunningpb.ListOperationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } for resp, err := range c.ListOperations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataprocMetastoreClient) ListServices ¶
func (c *DataprocMetastoreClient) ListServices(ctx context.Context, req *metastorepb.ListServicesRequest, opts ...gax.CallOption) *ServiceIterator
ListServices lists services in a project and location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ListServicesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ListServicesRequest. } it := c.ListServices(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*metastorepb.ListServicesResponse) } }
Output:
Example (All) ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ListServicesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ListServicesRequest. } for resp, err := range c.ListServices(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataprocMetastoreClient) MoveTableToDatabase ¶ added in v1.12.0
func (c *DataprocMetastoreClient) MoveTableToDatabase(ctx context.Context, req *metastorepb.MoveTableToDatabaseRequest, opts ...gax.CallOption) (*MoveTableToDatabaseOperation, error)
MoveTableToDatabase move a table to another database.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.MoveTableToDatabaseRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#MoveTableToDatabaseRequest. } op, err := c.MoveTableToDatabase(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) MoveTableToDatabaseOperation ¶ added in v1.12.0
func (c *DataprocMetastoreClient) MoveTableToDatabaseOperation(name string) *MoveTableToDatabaseOperation
MoveTableToDatabaseOperation returns a new MoveTableToDatabaseOperation from a given name. The name must be that of a previously created MoveTableToDatabaseOperation, possibly from a different process.
func (*DataprocMetastoreClient) QueryMetadata ¶ added in v1.12.0
func (c *DataprocMetastoreClient) QueryMetadata(ctx context.Context, req *metastorepb.QueryMetadataRequest, opts ...gax.CallOption) (*QueryMetadataOperation, error)
QueryMetadata query DPMS metadata.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.QueryMetadataRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#QueryMetadataRequest. } op, err := c.QueryMetadata(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) QueryMetadataOperation ¶ added in v1.12.0
func (c *DataprocMetastoreClient) QueryMetadataOperation(name string) *QueryMetadataOperation
QueryMetadataOperation returns a new QueryMetadataOperation from a given name. The name must be that of a previously created QueryMetadataOperation, possibly from a different process.
func (*DataprocMetastoreClient) RestoreService ¶ added in v0.2.0
func (c *DataprocMetastoreClient) RestoreService(ctx context.Context, req *metastorepb.RestoreServiceRequest, opts ...gax.CallOption) (*RestoreServiceOperation, error)
RestoreService restores a service from a backup.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.RestoreServiceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#RestoreServiceRequest. } op, err := c.RestoreService(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) RestoreServiceOperation ¶ added in v0.2.0
func (c *DataprocMetastoreClient) RestoreServiceOperation(name string) *RestoreServiceOperation
RestoreServiceOperation returns a new RestoreServiceOperation from a given name. The name must be that of a previously created RestoreServiceOperation, possibly from a different process.
func (*DataprocMetastoreClient) SetIamPolicy ¶ added in v1.9.0
func (c *DataprocMetastoreClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.SetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest. } resp, err := c.SetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) TestIamPermissions ¶ added in v1.9.0
func (c *DataprocMetastoreClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.TestIamPermissionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest. } resp, err := c.TestIamPermissions(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) UpdateMetadataImport ¶
func (c *DataprocMetastoreClient) UpdateMetadataImport(ctx context.Context, req *metastorepb.UpdateMetadataImportRequest, opts ...gax.CallOption) (*UpdateMetadataImportOperation, error)
UpdateMetadataImport updates a single import. Only the description field of MetadataImport is supported to be updated.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.UpdateMetadataImportRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#UpdateMetadataImportRequest. } op, err := c.UpdateMetadataImport(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) UpdateMetadataImportOperation ¶
func (c *DataprocMetastoreClient) UpdateMetadataImportOperation(name string) *UpdateMetadataImportOperation
UpdateMetadataImportOperation returns a new UpdateMetadataImportOperation from a given name. The name must be that of a previously created UpdateMetadataImportOperation, possibly from a different process.
func (*DataprocMetastoreClient) UpdateService ¶
func (c *DataprocMetastoreClient) UpdateService(ctx context.Context, req *metastorepb.UpdateServiceRequest, opts ...gax.CallOption) (*UpdateServiceOperation, error)
UpdateService updates the parameters of a single service.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.UpdateServiceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#UpdateServiceRequest. } op, err := c.UpdateService(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreClient) UpdateServiceOperation ¶
func (c *DataprocMetastoreClient) UpdateServiceOperation(name string) *UpdateServiceOperation
UpdateServiceOperation returns a new UpdateServiceOperation from a given name. The name must be that of a previously created UpdateServiceOperation, possibly from a different process.
type DataprocMetastoreFederationCallOptions ¶ added in v1.9.0
type DataprocMetastoreFederationCallOptions struct { ListFederations []gax.CallOption GetFederation []gax.CallOption CreateFederation []gax.CallOption UpdateFederation []gax.CallOption DeleteFederation []gax.CallOption GetLocation []gax.CallOption ListLocations []gax.CallOption GetIamPolicy []gax.CallOption SetIamPolicy []gax.CallOption TestIamPermissions []gax.CallOption CancelOperation []gax.CallOption DeleteOperation []gax.CallOption GetOperation []gax.CallOption ListOperations []gax.CallOption }
DataprocMetastoreFederationCallOptions contains the retry settings for each method of DataprocMetastoreFederationClient.
type DataprocMetastoreFederationClient ¶ added in v1.9.0
type DataprocMetastoreFederationClient struct { // The call options for this service. CallOptions *DataprocMetastoreFederationCallOptions // 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 }
DataprocMetastoreFederationClient is a client for interacting with Dataproc Metastore API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.
The Dataproc Metastore Federation API defines the following resource model:
The service works with a collection of Google Cloud projects. Each project has a collection of available locations. Each location has a collection of federations. Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.
func NewDataprocMetastoreFederationClient ¶ added in v1.9.0
func NewDataprocMetastoreFederationClient(ctx context.Context, opts ...option.ClientOption) (*DataprocMetastoreFederationClient, error)
NewDataprocMetastoreFederationClient creates a new dataproc metastore federation client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.
The Dataproc Metastore Federation API defines the following resource model:
The service works with a collection of Google Cloud projects. Each project has a collection of available locations. Each location has a collection of federations. Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func NewDataprocMetastoreFederationRESTClient ¶ added in v1.10.0
func NewDataprocMetastoreFederationRESTClient(ctx context.Context, opts ...option.ClientOption) (*DataprocMetastoreFederationClient, error)
NewDataprocMetastoreFederationRESTClient creates a new dataproc metastore federation rest client.
Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.
The Dataproc Metastore Federation API defines the following resource model:
The service works with a collection of Google Cloud projects. Each project has a collection of available locations. Each location has a collection of federations. Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationRESTClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
Output:
func (*DataprocMetastoreFederationClient) CancelOperation ¶ added in v1.10.1
func (c *DataprocMetastoreFederationClient) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, opts ...gax.CallOption) error
CancelOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.CancelOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest. } err = c.CancelOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*DataprocMetastoreFederationClient) Close ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*DataprocMetastoreFederationClient) Connection
deprecated
added in
v1.9.0
func (c *DataprocMetastoreFederationClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*DataprocMetastoreFederationClient) CreateFederation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) CreateFederation(ctx context.Context, req *metastorepb.CreateFederationRequest, opts ...gax.CallOption) (*CreateFederationOperation, error)
CreateFederation creates a metastore federation in a project and location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.CreateFederationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#CreateFederationRequest. } op, err := c.CreateFederation(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreFederationClient) CreateFederationOperation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) CreateFederationOperation(name string) *CreateFederationOperation
CreateFederationOperation returns a new CreateFederationOperation from a given name. The name must be that of a previously created CreateFederationOperation, possibly from a different process.
func (*DataprocMetastoreFederationClient) DeleteFederation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) DeleteFederation(ctx context.Context, req *metastorepb.DeleteFederationRequest, opts ...gax.CallOption) (*DeleteFederationOperation, error)
DeleteFederation deletes a single federation.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.DeleteFederationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#DeleteFederationRequest. } op, err := c.DeleteFederation(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
Output:
func (*DataprocMetastoreFederationClient) DeleteFederationOperation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) DeleteFederationOperation(name string) *DeleteFederationOperation
DeleteFederationOperation returns a new DeleteFederationOperation from a given name. The name must be that of a previously created DeleteFederationOperation, possibly from a different process.
func (*DataprocMetastoreFederationClient) DeleteOperation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, opts ...gax.CallOption) error
DeleteOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.DeleteOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest. } err = c.DeleteOperation(ctx, req) if err != nil { // TODO: Handle error. } }
Output:
func (*DataprocMetastoreFederationClient) GetFederation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) GetFederation(ctx context.Context, req *metastorepb.GetFederationRequest, opts ...gax.CallOption) (*metastorepb.Federation, error)
GetFederation gets the details of a single federation.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.GetFederationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#GetFederationRequest. } resp, err := c.GetFederation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreFederationClient) GetIamPolicy ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.GetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest. } resp, err := c.GetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreFederationClient) GetLocation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.GetLocationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest. } resp, err := c.GetLocation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreFederationClient) GetOperation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, opts ...gax.CallOption) (*longrunningpb.Operation, error)
GetOperation is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.GetOperationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest. } resp, err := c.GetOperation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreFederationClient) ListFederations ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) ListFederations(ctx context.Context, req *metastorepb.ListFederationsRequest, opts ...gax.CallOption) *FederationIterator
ListFederations lists federations in a project and location.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ListFederationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ListFederationsRequest. } it := c.ListFederations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*metastorepb.ListFederationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.ListFederationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#ListFederationsRequest. } for resp, err := range c.ListFederations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataprocMetastoreFederationClient) ListLocations ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator
ListLocations lists information about the supported locations for this service.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" "google.golang.org/api/iterator" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } it := c.ListLocations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*locationpb.ListLocationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" locationpb "google.golang.org/genproto/googleapis/cloud/location" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &locationpb.ListLocationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest. } for resp, err := range c.ListLocations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataprocMetastoreFederationClient) ListOperations ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, opts ...gax.CallOption) *OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Example ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" "google.golang.org/api/iterator" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } it := c.ListOperations(ctx, req) for { resp, err := it.Next() if err == iterator.Done { break } if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp // If you need to access the underlying RPC response, // you can do so by casting the `Response` as below. // Otherwise, remove this line. Only populated after // first call to Next(). Not safe for concurrent access. _ = it.Response.(*longrunningpb.ListOperationsResponse) } }
Output:
Example (All) ¶
package main import ( "context" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &longrunningpb.ListOperationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest. } for resp, err := range c.ListOperations(ctx, req).All() { if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp } }
Output:
func (*DataprocMetastoreFederationClient) SetIamPolicy ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.SetIamPolicyRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest. } resp, err := c.SetIamPolicy(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreFederationClient) TestIamPermissions ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example ¶
package main import ( "context" iampb "cloud.google.com/go/iam/apiv1/iampb" metastore "cloud.google.com/go/metastore/apiv1" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &iampb.TestIamPermissionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest. } resp, err := c.TestIamPermissions(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreFederationClient) UpdateFederation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) UpdateFederation(ctx context.Context, req *metastorepb.UpdateFederationRequest, opts ...gax.CallOption) (*UpdateFederationOperation, error)
UpdateFederation updates the fields of a federation.
Example ¶
package main import ( "context" metastore "cloud.google.com/go/metastore/apiv1" metastorepb "cloud.google.com/go/metastore/apiv1/metastorepb" ) func main() { ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := metastore.NewDataprocMetastoreFederationClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &metastorepb.UpdateFederationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/metastore/apiv1/metastorepb#UpdateFederationRequest. } op, err := c.UpdateFederation(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
Output:
func (*DataprocMetastoreFederationClient) UpdateFederationOperation ¶ added in v1.9.0
func (c *DataprocMetastoreFederationClient) UpdateFederationOperation(name string) *UpdateFederationOperation
UpdateFederationOperation returns a new UpdateFederationOperation from a given name. The name must be that of a previously created UpdateFederationOperation, possibly from a different process.
type DeleteBackupOperation ¶ added in v0.2.0
type DeleteBackupOperation struct {
// contains filtered or unexported fields
}
DeleteBackupOperation manages a long-running operation from DeleteBackup.
func (*DeleteBackupOperation) Done ¶ added in v0.2.0
func (op *DeleteBackupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteBackupOperation) Metadata ¶ added in v0.2.0
func (op *DeleteBackupOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*DeleteBackupOperation) Name ¶ added in v0.2.0
func (op *DeleteBackupOperation) 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 (*DeleteBackupOperation) Poll ¶ added in v0.2.0
func (op *DeleteBackupOperation) 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 (*DeleteBackupOperation) Wait ¶ added in v0.2.0
func (op *DeleteBackupOperation) 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.
type DeleteFederationOperation ¶ added in v1.9.0
type DeleteFederationOperation struct {
// contains filtered or unexported fields
}
DeleteFederationOperation manages a long-running operation from DeleteFederation.
func (*DeleteFederationOperation) Done ¶ added in v1.9.0
func (op *DeleteFederationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteFederationOperation) Metadata ¶ added in v1.9.0
func (op *DeleteFederationOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*DeleteFederationOperation) Name ¶ added in v1.9.0
func (op *DeleteFederationOperation) 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 (*DeleteFederationOperation) Poll ¶ added in v1.9.0
func (op *DeleteFederationOperation) 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 (*DeleteFederationOperation) Wait ¶ added in v1.9.0
func (op *DeleteFederationOperation) 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.
type DeleteServiceOperation ¶
type DeleteServiceOperation struct {
// contains filtered or unexported fields
}
DeleteServiceOperation manages a long-running operation from DeleteService.
func (*DeleteServiceOperation) Done ¶
func (op *DeleteServiceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteServiceOperation) Metadata ¶
func (op *DeleteServiceOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*DeleteServiceOperation) Name ¶
func (op *DeleteServiceOperation) 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 (*DeleteServiceOperation) Poll ¶
func (op *DeleteServiceOperation) 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 (*DeleteServiceOperation) Wait ¶
func (op *DeleteServiceOperation) 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.
type ExportMetadataOperation ¶
type ExportMetadataOperation struct {
// contains filtered or unexported fields
}
ExportMetadataOperation manages a long-running operation from ExportMetadata.
func (*ExportMetadataOperation) Done ¶
func (op *ExportMetadataOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ExportMetadataOperation) Metadata ¶
func (op *ExportMetadataOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*ExportMetadataOperation) Name ¶
func (op *ExportMetadataOperation) 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 (*ExportMetadataOperation) Poll ¶
func (op *ExportMetadataOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataExport, 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 (*ExportMetadataOperation) Wait ¶
func (op *ExportMetadataOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataExport, 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.
type FederationIterator ¶ added in v1.9.0
type FederationIterator 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 []*metastorepb.Federation, nextPageToken string, err error) // contains filtered or unexported fields }
FederationIterator manages a stream of *metastorepb.Federation.
func (*FederationIterator) All ¶ added in v1.14.1
func (it *FederationIterator) All() iter.Seq2[*metastorepb.Federation, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*FederationIterator) Next ¶ added in v1.9.0
func (it *FederationIterator) Next() (*metastorepb.Federation, 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 (*FederationIterator) PageInfo ¶ added in v1.9.0
func (it *FederationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type LocationIterator ¶ added in v1.9.0
type LocationIterator 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 []*locationpb.Location, nextPageToken string, err error) // contains filtered or unexported fields }
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) All ¶ added in v1.14.1
func (it *LocationIterator) All() iter.Seq2[*locationpb.Location, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*LocationIterator) Next ¶ added in v1.9.0
func (it *LocationIterator) Next() (*locationpb.Location, 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 (*LocationIterator) PageInfo ¶ added in v1.9.0
func (it *LocationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type MetadataImportIterator ¶
type MetadataImportIterator 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 []*metastorepb.MetadataImport, nextPageToken string, err error) // contains filtered or unexported fields }
MetadataImportIterator manages a stream of *metastorepb.MetadataImport.
func (*MetadataImportIterator) All ¶ added in v1.14.1
func (it *MetadataImportIterator) All() iter.Seq2[*metastorepb.MetadataImport, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*MetadataImportIterator) Next ¶
func (it *MetadataImportIterator) Next() (*metastorepb.MetadataImport, 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 (*MetadataImportIterator) PageInfo ¶
func (it *MetadataImportIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type MoveTableToDatabaseOperation ¶ added in v1.12.0
type MoveTableToDatabaseOperation struct {
// contains filtered or unexported fields
}
MoveTableToDatabaseOperation manages a long-running operation from MoveTableToDatabase.
func (*MoveTableToDatabaseOperation) Done ¶ added in v1.12.0
func (op *MoveTableToDatabaseOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*MoveTableToDatabaseOperation) Metadata ¶ added in v1.12.0
func (op *MoveTableToDatabaseOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*MoveTableToDatabaseOperation) Name ¶ added in v1.12.0
func (op *MoveTableToDatabaseOperation) 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 (*MoveTableToDatabaseOperation) Poll ¶ added in v1.12.0
func (op *MoveTableToDatabaseOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MoveTableToDatabaseResponse, 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 (*MoveTableToDatabaseOperation) Wait ¶ added in v1.12.0
func (op *MoveTableToDatabaseOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MoveTableToDatabaseResponse, 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.
type OperationIterator ¶ added in v1.9.0
type OperationIterator 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 []*longrunningpb.Operation, nextPageToken string, err error) // contains filtered or unexported fields }
OperationIterator manages a stream of *longrunningpb.Operation.
func (*OperationIterator) All ¶ added in v1.14.1
func (it *OperationIterator) All() iter.Seq2[*longrunningpb.Operation, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OperationIterator) Next ¶ added in v1.9.0
func (it *OperationIterator) Next() (*longrunningpb.Operation, 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 (*OperationIterator) PageInfo ¶ added in v1.9.0
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type QueryMetadataOperation ¶ added in v1.12.0
type QueryMetadataOperation struct {
// contains filtered or unexported fields
}
QueryMetadataOperation manages a long-running operation from QueryMetadata.
func (*QueryMetadataOperation) Done ¶ added in v1.12.0
func (op *QueryMetadataOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*QueryMetadataOperation) Metadata ¶ added in v1.12.0
func (op *QueryMetadataOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*QueryMetadataOperation) Name ¶ added in v1.12.0
func (op *QueryMetadataOperation) 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 (*QueryMetadataOperation) Poll ¶ added in v1.12.0
func (op *QueryMetadataOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.QueryMetadataResponse, 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 (*QueryMetadataOperation) Wait ¶ added in v1.12.0
func (op *QueryMetadataOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.QueryMetadataResponse, 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.
type RestoreServiceOperation ¶ added in v0.2.0
type RestoreServiceOperation struct {
// contains filtered or unexported fields
}
RestoreServiceOperation manages a long-running operation from RestoreService.
func (*RestoreServiceOperation) Done ¶ added in v0.2.0
func (op *RestoreServiceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*RestoreServiceOperation) Metadata ¶ added in v0.2.0
func (op *RestoreServiceOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*RestoreServiceOperation) Name ¶ added in v0.2.0
func (op *RestoreServiceOperation) 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 (*RestoreServiceOperation) Poll ¶ added in v0.2.0
func (op *RestoreServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Restore, 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 (*RestoreServiceOperation) Wait ¶ added in v0.2.0
func (op *RestoreServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Restore, 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.
type ServiceIterator ¶
type ServiceIterator 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 []*metastorepb.Service, nextPageToken string, err error) // contains filtered or unexported fields }
ServiceIterator manages a stream of *metastorepb.Service.
func (*ServiceIterator) All ¶ added in v1.14.1
func (it *ServiceIterator) All() iter.Seq2[*metastorepb.Service, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ServiceIterator) Next ¶
func (it *ServiceIterator) Next() (*metastorepb.Service, 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 (*ServiceIterator) PageInfo ¶
func (it *ServiceIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type UpdateFederationOperation ¶ added in v1.9.0
type UpdateFederationOperation struct {
// contains filtered or unexported fields
}
UpdateFederationOperation manages a long-running operation from UpdateFederation.
func (*UpdateFederationOperation) Done ¶ added in v1.9.0
func (op *UpdateFederationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateFederationOperation) Metadata ¶ added in v1.9.0
func (op *UpdateFederationOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*UpdateFederationOperation) Name ¶ added in v1.9.0
func (op *UpdateFederationOperation) 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 (*UpdateFederationOperation) Poll ¶ added in v1.9.0
func (op *UpdateFederationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Federation, 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 (*UpdateFederationOperation) Wait ¶ added in v1.9.0
func (op *UpdateFederationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Federation, 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.
type UpdateMetadataImportOperation ¶
type UpdateMetadataImportOperation struct {
// contains filtered or unexported fields
}
UpdateMetadataImportOperation manages a long-running operation from UpdateMetadataImport.
func (*UpdateMetadataImportOperation) Done ¶
func (op *UpdateMetadataImportOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateMetadataImportOperation) Metadata ¶
func (op *UpdateMetadataImportOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*UpdateMetadataImportOperation) Name ¶
func (op *UpdateMetadataImportOperation) 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 (*UpdateMetadataImportOperation) Poll ¶
func (op *UpdateMetadataImportOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataImport, 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 (*UpdateMetadataImportOperation) Wait ¶
func (op *UpdateMetadataImportOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.MetadataImport, 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.
type UpdateServiceOperation ¶
type UpdateServiceOperation struct {
// contains filtered or unexported fields
}
UpdateServiceOperation manages a long-running operation from UpdateService.
func (*UpdateServiceOperation) Done ¶
func (op *UpdateServiceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateServiceOperation) Metadata ¶
func (op *UpdateServiceOperation) Metadata() (*metastorepb.OperationMetadata, 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 (*UpdateServiceOperation) Name ¶
func (op *UpdateServiceOperation) 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 (*UpdateServiceOperation) Poll ¶
func (op *UpdateServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Service, 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 (*UpdateServiceOperation) Wait ¶
func (op *UpdateServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*metastorepb.Service, 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.