Documentation
¶
Overview ¶
Package backupdr is an auto-generated package for the Backup and DR Service API.
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.
// go get cloud.google.com/go/backupdr/apiv1@latest 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 := backupdr.NewClient(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, mentioned above.
req := &backupdrpb.CreateBackupPlanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#CreateBackupPlanRequest. } op, err := c.CreateBackupPlan(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 NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Index ¶
- func DefaultAuthScopes() []string
- type BackupIterator
- type BackupPlanAssociationIterator
- type BackupPlanIterator
- type BackupPlanRevisionIterator
- type BackupVaultIterator
- type CallOptions
- type Client
- func (c *Client) CancelOperation(ctx context.Context, req *longrunningpb.CancelOperationRequest, ...) error
- func (c *Client) Close() error
- func (c *Client) Connection() *grpc.ClientConndeprecated
- func (c *Client) CreateBackupPlan(ctx context.Context, req *backupdrpb.CreateBackupPlanRequest, ...) (*CreateBackupPlanOperation, error)
- func (c *Client) CreateBackupPlanAssociation(ctx context.Context, req *backupdrpb.CreateBackupPlanAssociationRequest, ...) (*CreateBackupPlanAssociationOperation, error)
- func (c *Client) CreateBackupPlanAssociationOperation(name string) *CreateBackupPlanAssociationOperation
- func (c *Client) CreateBackupPlanOperation(name string) *CreateBackupPlanOperation
- func (c *Client) CreateBackupVault(ctx context.Context, req *backupdrpb.CreateBackupVaultRequest, ...) (*CreateBackupVaultOperation, error)
- func (c *Client) CreateBackupVaultOperation(name string) *CreateBackupVaultOperation
- func (c *Client) CreateManagementServer(ctx context.Context, req *backupdrpb.CreateManagementServerRequest, ...) (*CreateManagementServerOperation, error)
- func (c *Client) CreateManagementServerOperation(name string) *CreateManagementServerOperation
- func (c *Client) DeleteBackup(ctx context.Context, req *backupdrpb.DeleteBackupRequest, ...) (*DeleteBackupOperation, error)
- func (c *Client) DeleteBackupOperation(name string) *DeleteBackupOperation
- func (c *Client) DeleteBackupPlan(ctx context.Context, req *backupdrpb.DeleteBackupPlanRequest, ...) (*DeleteBackupPlanOperation, error)
- func (c *Client) DeleteBackupPlanAssociation(ctx context.Context, req *backupdrpb.DeleteBackupPlanAssociationRequest, ...) (*DeleteBackupPlanAssociationOperation, error)
- func (c *Client) DeleteBackupPlanAssociationOperation(name string) *DeleteBackupPlanAssociationOperation
- func (c *Client) DeleteBackupPlanOperation(name string) *DeleteBackupPlanOperation
- func (c *Client) DeleteBackupVault(ctx context.Context, req *backupdrpb.DeleteBackupVaultRequest, ...) (*DeleteBackupVaultOperation, error)
- func (c *Client) DeleteBackupVaultOperation(name string) *DeleteBackupVaultOperation
- func (c *Client) DeleteManagementServer(ctx context.Context, req *backupdrpb.DeleteManagementServerRequest, ...) (*DeleteManagementServerOperation, error)
- func (c *Client) DeleteManagementServerOperation(name string) *DeleteManagementServerOperation
- func (c *Client) DeleteOperation(ctx context.Context, req *longrunningpb.DeleteOperationRequest, ...) error
- func (c *Client) FetchBackupPlanAssociationsForResourceType(ctx context.Context, ...) *BackupPlanAssociationIterator
- func (c *Client) FetchDataSourceReferencesForResourceType(ctx context.Context, ...) *DataSourceReferenceIterator
- func (c *Client) FetchUsableBackupVaults(ctx context.Context, req *backupdrpb.FetchUsableBackupVaultsRequest, ...) *BackupVaultIterator
- func (c *Client) GetBackup(ctx context.Context, req *backupdrpb.GetBackupRequest, opts ...gax.CallOption) (*backupdrpb.Backup, error)
- func (c *Client) GetBackupPlan(ctx context.Context, req *backupdrpb.GetBackupPlanRequest, ...) (*backupdrpb.BackupPlan, error)
- func (c *Client) GetBackupPlanAssociation(ctx context.Context, req *backupdrpb.GetBackupPlanAssociationRequest, ...) (*backupdrpb.BackupPlanAssociation, error)
- func (c *Client) GetBackupPlanRevision(ctx context.Context, req *backupdrpb.GetBackupPlanRevisionRequest, ...) (*backupdrpb.BackupPlanRevision, error)
- func (c *Client) GetBackupVault(ctx context.Context, req *backupdrpb.GetBackupVaultRequest, ...) (*backupdrpb.BackupVault, error)
- func (c *Client) GetDataSource(ctx context.Context, req *backupdrpb.GetDataSourceRequest, ...) (*backupdrpb.DataSource, error)
- func (c *Client) GetDataSourceReference(ctx context.Context, req *backupdrpb.GetDataSourceReferenceRequest, ...) (*backupdrpb.DataSourceReference, error)
- func (c *Client) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, ...) (*locationpb.Location, error)
- func (c *Client) GetManagementServer(ctx context.Context, req *backupdrpb.GetManagementServerRequest, ...) (*backupdrpb.ManagementServer, error)
- func (c *Client) GetOperation(ctx context.Context, req *longrunningpb.GetOperationRequest, ...) (*longrunningpb.Operation, error)
- func (c *Client) InitializeService(ctx context.Context, req *backupdrpb.InitializeServiceRequest, ...) (*InitializeServiceOperation, error)
- func (c *Client) InitializeServiceOperation(name string) *InitializeServiceOperation
- func (c *Client) ListBackupPlanAssociations(ctx context.Context, req *backupdrpb.ListBackupPlanAssociationsRequest, ...) *BackupPlanAssociationIterator
- func (c *Client) ListBackupPlanRevisions(ctx context.Context, req *backupdrpb.ListBackupPlanRevisionsRequest, ...) *BackupPlanRevisionIterator
- func (c *Client) ListBackupPlans(ctx context.Context, req *backupdrpb.ListBackupPlansRequest, ...) *BackupPlanIterator
- func (c *Client) ListBackupVaults(ctx context.Context, req *backupdrpb.ListBackupVaultsRequest, ...) *BackupVaultIterator
- func (c *Client) ListBackups(ctx context.Context, req *backupdrpb.ListBackupsRequest, ...) *BackupIterator
- func (c *Client) ListDataSources(ctx context.Context, req *backupdrpb.ListDataSourcesRequest, ...) *DataSourceIterator
- func (c *Client) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, ...) *LocationIterator
- func (c *Client) ListManagementServers(ctx context.Context, req *backupdrpb.ListManagementServersRequest, ...) *ManagementServerIterator
- func (c *Client) ListOperations(ctx context.Context, req *longrunningpb.ListOperationsRequest, ...) *OperationIterator
- func (c *Client) RestoreBackup(ctx context.Context, req *backupdrpb.RestoreBackupRequest, ...) (*RestoreBackupOperation, error)
- func (c *Client) RestoreBackupOperation(name string) *RestoreBackupOperation
- func (c *Client) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
- func (c *Client) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, ...) (*iampb.TestIamPermissionsResponse, error)
- func (c *Client) TriggerBackup(ctx context.Context, req *backupdrpb.TriggerBackupRequest, ...) (*TriggerBackupOperation, error)
- func (c *Client) TriggerBackupOperation(name string) *TriggerBackupOperation
- func (c *Client) UpdateBackup(ctx context.Context, req *backupdrpb.UpdateBackupRequest, ...) (*UpdateBackupOperation, error)
- func (c *Client) UpdateBackupOperation(name string) *UpdateBackupOperation
- func (c *Client) UpdateBackupPlan(ctx context.Context, req *backupdrpb.UpdateBackupPlanRequest, ...) (*UpdateBackupPlanOperation, error)
- func (c *Client) UpdateBackupPlanAssociation(ctx context.Context, req *backupdrpb.UpdateBackupPlanAssociationRequest, ...) (*UpdateBackupPlanAssociationOperation, error)
- func (c *Client) UpdateBackupPlanAssociationOperation(name string) *UpdateBackupPlanAssociationOperation
- func (c *Client) UpdateBackupPlanOperation(name string) *UpdateBackupPlanOperation
- func (c *Client) UpdateBackupVault(ctx context.Context, req *backupdrpb.UpdateBackupVaultRequest, ...) (*UpdateBackupVaultOperation, error)
- func (c *Client) UpdateBackupVaultOperation(name string) *UpdateBackupVaultOperation
- func (c *Client) UpdateDataSource(ctx context.Context, req *backupdrpb.UpdateDataSourceRequest, ...) (*UpdateDataSourceOperation, error)
- func (c *Client) UpdateDataSourceOperation(name string) *UpdateDataSourceOperation
- type CreateBackupPlanAssociationOperation
- func (op *CreateBackupPlanAssociationOperation) Done() bool
- func (op *CreateBackupPlanAssociationOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *CreateBackupPlanAssociationOperation) Name() string
- func (op *CreateBackupPlanAssociationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, error)
- func (op *CreateBackupPlanAssociationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, error)
- type CreateBackupPlanOperation
- func (op *CreateBackupPlanOperation) Done() bool
- func (op *CreateBackupPlanOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *CreateBackupPlanOperation) Name() string
- func (op *CreateBackupPlanOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlan, error)
- func (op *CreateBackupPlanOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlan, error)
- type CreateBackupVaultOperation
- func (op *CreateBackupVaultOperation) Done() bool
- func (op *CreateBackupVaultOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *CreateBackupVaultOperation) Name() string
- func (op *CreateBackupVaultOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupVault, error)
- func (op *CreateBackupVaultOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupVault, error)
- type CreateManagementServerOperation
- func (op *CreateManagementServerOperation) Done() bool
- func (op *CreateManagementServerOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *CreateManagementServerOperation) Name() string
- func (op *CreateManagementServerOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.ManagementServer, error)
- func (op *CreateManagementServerOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.ManagementServer, error)
- type DataSourceIterator
- type DataSourceReferenceIterator
- type DeleteBackupOperation
- func (op *DeleteBackupOperation) Done() bool
- func (op *DeleteBackupOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *DeleteBackupOperation) Name() string
- func (op *DeleteBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.Backup, error)
- func (op *DeleteBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.Backup, error)
- type DeleteBackupPlanAssociationOperation
- func (op *DeleteBackupPlanAssociationOperation) Done() bool
- func (op *DeleteBackupPlanAssociationOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *DeleteBackupPlanAssociationOperation) Name() string
- func (op *DeleteBackupPlanAssociationOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteBackupPlanAssociationOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteBackupPlanOperation
- func (op *DeleteBackupPlanOperation) Done() bool
- func (op *DeleteBackupPlanOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *DeleteBackupPlanOperation) Name() string
- func (op *DeleteBackupPlanOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteBackupPlanOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteBackupVaultOperation
- func (op *DeleteBackupVaultOperation) Done() bool
- func (op *DeleteBackupVaultOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *DeleteBackupVaultOperation) Name() string
- func (op *DeleteBackupVaultOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteBackupVaultOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type DeleteManagementServerOperation
- func (op *DeleteManagementServerOperation) Done() bool
- func (op *DeleteManagementServerOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *DeleteManagementServerOperation) Name() string
- func (op *DeleteManagementServerOperation) Poll(ctx context.Context, opts ...gax.CallOption) error
- func (op *DeleteManagementServerOperation) Wait(ctx context.Context, opts ...gax.CallOption) error
- type InitializeServiceOperation
- func (op *InitializeServiceOperation) Done() bool
- func (op *InitializeServiceOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *InitializeServiceOperation) Name() string
- func (op *InitializeServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.InitializeServiceResponse, error)
- func (op *InitializeServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.InitializeServiceResponse, error)
- type LocationIterator
- type ManagementServerIterator
- type OperationIterator
- type RestoreBackupOperation
- func (op *RestoreBackupOperation) Done() bool
- func (op *RestoreBackupOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *RestoreBackupOperation) Name() string
- func (op *RestoreBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.RestoreBackupResponse, error)
- func (op *RestoreBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.RestoreBackupResponse, error)
- type TriggerBackupOperation
- func (op *TriggerBackupOperation) Done() bool
- func (op *TriggerBackupOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *TriggerBackupOperation) Name() string
- func (op *TriggerBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, error)
- func (op *TriggerBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, error)
- type UpdateBackupOperation
- func (op *UpdateBackupOperation) Done() bool
- func (op *UpdateBackupOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *UpdateBackupOperation) Name() string
- func (op *UpdateBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.Backup, error)
- func (op *UpdateBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.Backup, error)
- type UpdateBackupPlanAssociationOperation
- func (op *UpdateBackupPlanAssociationOperation) Done() bool
- func (op *UpdateBackupPlanAssociationOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *UpdateBackupPlanAssociationOperation) Name() string
- func (op *UpdateBackupPlanAssociationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, error)
- func (op *UpdateBackupPlanAssociationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, error)
- type UpdateBackupPlanOperation
- func (op *UpdateBackupPlanOperation) Done() bool
- func (op *UpdateBackupPlanOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *UpdateBackupPlanOperation) Name() string
- func (op *UpdateBackupPlanOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlan, error)
- func (op *UpdateBackupPlanOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlan, error)
- type UpdateBackupVaultOperation
- func (op *UpdateBackupVaultOperation) Done() bool
- func (op *UpdateBackupVaultOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *UpdateBackupVaultOperation) Name() string
- func (op *UpdateBackupVaultOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupVault, error)
- func (op *UpdateBackupVaultOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupVault, error)
- type UpdateDataSourceOperation
- func (op *UpdateDataSourceOperation) Done() bool
- func (op *UpdateDataSourceOperation) Metadata() (*backupdrpb.OperationMetadata, error)
- func (op *UpdateDataSourceOperation) Name() string
- func (op *UpdateDataSourceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.DataSource, error)
- func (op *UpdateDataSourceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.DataSource, error)
Examples ¶
- Client.CancelOperation
- Client.CreateBackupPlan
- Client.CreateBackupPlanAssociation
- Client.CreateBackupVault
- Client.CreateManagementServer
- Client.DeleteBackup
- Client.DeleteBackupPlan
- Client.DeleteBackupPlanAssociation
- Client.DeleteBackupVault
- Client.DeleteManagementServer
- Client.DeleteOperation
- Client.FetchBackupPlanAssociationsForResourceType
- Client.FetchBackupPlanAssociationsForResourceType (All)
- Client.FetchDataSourceReferencesForResourceType
- Client.FetchDataSourceReferencesForResourceType (All)
- Client.FetchUsableBackupVaults
- Client.FetchUsableBackupVaults (All)
- Client.GetBackup
- Client.GetBackupPlan
- Client.GetBackupPlanAssociation
- Client.GetBackupPlanRevision
- Client.GetBackupVault
- Client.GetDataSource
- Client.GetDataSourceReference
- Client.GetIamPolicy
- Client.GetLocation
- Client.GetManagementServer
- Client.GetOperation
- Client.InitializeService
- Client.ListBackupPlanAssociations
- Client.ListBackupPlanAssociations (All)
- Client.ListBackupPlanRevisions
- Client.ListBackupPlanRevisions (All)
- Client.ListBackupPlans
- Client.ListBackupPlans (All)
- Client.ListBackupVaults
- Client.ListBackupVaults (All)
- Client.ListBackups
- Client.ListBackups (All)
- Client.ListDataSources
- Client.ListDataSources (All)
- Client.ListLocations
- Client.ListLocations (All)
- Client.ListManagementServers
- Client.ListManagementServers (All)
- Client.ListOperations
- Client.ListOperations (All)
- Client.RestoreBackup
- Client.SetIamPolicy
- Client.TestIamPermissions
- Client.TriggerBackup
- Client.UpdateBackup
- Client.UpdateBackupPlan
- Client.UpdateBackupPlanAssociation
- Client.UpdateBackupVault
- Client.UpdateDataSource
- NewClient
- NewRESTClient
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 BackupIterator ¶ added in v1.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 []*backupdrpb.Backup, nextPageToken string, err error) // contains filtered or unexported fields }
BackupIterator manages a stream of *backupdrpb.Backup.
func (*BackupIterator) All ¶ added in v1.2.0
func (it *BackupIterator) All() iter.Seq2[*backupdrpb.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 v1.2.0
func (it *BackupIterator) Next() (*backupdrpb.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 v1.2.0
func (it *BackupIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type BackupPlanAssociationIterator ¶ added in v1.2.0
type BackupPlanAssociationIterator 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 []*backupdrpb.BackupPlanAssociation, nextPageToken string, err error) // contains filtered or unexported fields }
BackupPlanAssociationIterator manages a stream of *backupdrpb.BackupPlanAssociation.
func (*BackupPlanAssociationIterator) All ¶ added in v1.2.0
func (it *BackupPlanAssociationIterator) All() iter.Seq2[*backupdrpb.BackupPlanAssociation, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BackupPlanAssociationIterator) Next ¶ added in v1.2.0
func (it *BackupPlanAssociationIterator) Next() (*backupdrpb.BackupPlanAssociation, 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 (*BackupPlanAssociationIterator) PageInfo ¶ added in v1.2.0
func (it *BackupPlanAssociationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type BackupPlanIterator ¶ added in v1.2.0
type BackupPlanIterator 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 []*backupdrpb.BackupPlan, nextPageToken string, err error) // contains filtered or unexported fields }
BackupPlanIterator manages a stream of *backupdrpb.BackupPlan.
func (*BackupPlanIterator) All ¶ added in v1.2.0
func (it *BackupPlanIterator) All() iter.Seq2[*backupdrpb.BackupPlan, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BackupPlanIterator) Next ¶ added in v1.2.0
func (it *BackupPlanIterator) Next() (*backupdrpb.BackupPlan, 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 (*BackupPlanIterator) PageInfo ¶ added in v1.2.0
func (it *BackupPlanIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type BackupPlanRevisionIterator ¶ added in v1.4.0
type BackupPlanRevisionIterator 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 []*backupdrpb.BackupPlanRevision, nextPageToken string, err error) // contains filtered or unexported fields }
BackupPlanRevisionIterator manages a stream of *backupdrpb.BackupPlanRevision.
func (*BackupPlanRevisionIterator) All ¶ added in v1.4.0
func (it *BackupPlanRevisionIterator) All() iter.Seq2[*backupdrpb.BackupPlanRevision, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BackupPlanRevisionIterator) Next ¶ added in v1.4.0
func (it *BackupPlanRevisionIterator) Next() (*backupdrpb.BackupPlanRevision, 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 (*BackupPlanRevisionIterator) PageInfo ¶ added in v1.4.0
func (it *BackupPlanRevisionIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type BackupVaultIterator ¶ added in v1.2.0
type BackupVaultIterator 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 []*backupdrpb.BackupVault, nextPageToken string, err error) // contains filtered or unexported fields }
BackupVaultIterator manages a stream of *backupdrpb.BackupVault.
func (*BackupVaultIterator) All ¶ added in v1.2.0
func (it *BackupVaultIterator) All() iter.Seq2[*backupdrpb.BackupVault, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BackupVaultIterator) Next ¶ added in v1.2.0
func (it *BackupVaultIterator) Next() (*backupdrpb.BackupVault, 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 (*BackupVaultIterator) PageInfo ¶ added in v1.2.0
func (it *BackupVaultIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type CallOptions ¶
type CallOptions struct { ListManagementServers []gax.CallOption GetManagementServer []gax.CallOption CreateManagementServer []gax.CallOption DeleteManagementServer []gax.CallOption CreateBackupVault []gax.CallOption ListBackupVaults []gax.CallOption FetchUsableBackupVaults []gax.CallOption GetBackupVault []gax.CallOption UpdateBackupVault []gax.CallOption DeleteBackupVault []gax.CallOption ListDataSources []gax.CallOption GetDataSource []gax.CallOption UpdateDataSource []gax.CallOption ListBackups []gax.CallOption GetBackup []gax.CallOption UpdateBackup []gax.CallOption DeleteBackup []gax.CallOption RestoreBackup []gax.CallOption CreateBackupPlan []gax.CallOption UpdateBackupPlan []gax.CallOption GetBackupPlan []gax.CallOption ListBackupPlans []gax.CallOption DeleteBackupPlan []gax.CallOption GetBackupPlanRevision []gax.CallOption ListBackupPlanRevisions []gax.CallOption CreateBackupPlanAssociation []gax.CallOption UpdateBackupPlanAssociation []gax.CallOption GetBackupPlanAssociation []gax.CallOption ListBackupPlanAssociations []gax.CallOption FetchBackupPlanAssociationsForResourceType []gax.CallOption DeleteBackupPlanAssociation []gax.CallOption TriggerBackup []gax.CallOption GetDataSourceReference []gax.CallOption FetchDataSourceReferencesForResourceType []gax.CallOption InitializeService []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 }
CallOptions contains the retry settings for each method of Client.
type Client ¶
type Client struct { // The call options for this service. CallOptions *CallOptions // LROClient is used internally to handle long-running operations. // It is exposed so that its CallOptions can be modified if required. // Users should not Close this client. LROClient *lroauto.OperationsClient // contains filtered or unexported fields }
Client is a client for interacting with Backup and DR Service API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The BackupDR Service
func NewClient ¶
NewClient creates a new backupdr client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The BackupDR Service
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
func NewRESTClient ¶
NewRESTClient creates a new backupdr rest client.
The BackupDR Service
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/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 := backupdr.NewRESTClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() // TODO: Use client. _ = c }
func (*Client) CancelOperation ¶
func (c *Client) 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" backupdr "cloud.google.com/go/backupdr/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := backupdr.NewClient(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. } }
func (*Client) Close ¶
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection
deprecated
func (c *Client) 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 (*Client) CreateBackupPlan ¶ added in v1.2.0
func (c *Client) CreateBackupPlan(ctx context.Context, req *backupdrpb.CreateBackupPlanRequest, opts ...gax.CallOption) (*CreateBackupPlanOperation, error)
CreateBackupPlan create a BackupPlan
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.CreateBackupPlanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#CreateBackupPlanRequest. } op, err := c.CreateBackupPlan(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) CreateBackupPlanAssociation ¶ added in v1.2.0
func (c *Client) CreateBackupPlanAssociation(ctx context.Context, req *backupdrpb.CreateBackupPlanAssociationRequest, opts ...gax.CallOption) (*CreateBackupPlanAssociationOperation, error)
CreateBackupPlanAssociation create a BackupPlanAssociation
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.CreateBackupPlanAssociationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#CreateBackupPlanAssociationRequest. } op, err := c.CreateBackupPlanAssociation(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) CreateBackupPlanAssociationOperation ¶ added in v1.2.0
func (c *Client) CreateBackupPlanAssociationOperation(name string) *CreateBackupPlanAssociationOperation
CreateBackupPlanAssociationOperation returns a new CreateBackupPlanAssociationOperation from a given name. The name must be that of a previously created CreateBackupPlanAssociationOperation, possibly from a different process.
func (*Client) CreateBackupPlanOperation ¶ added in v1.2.0
func (c *Client) CreateBackupPlanOperation(name string) *CreateBackupPlanOperation
CreateBackupPlanOperation returns a new CreateBackupPlanOperation from a given name. The name must be that of a previously created CreateBackupPlanOperation, possibly from a different process.
func (*Client) CreateBackupVault ¶ added in v1.2.0
func (c *Client) CreateBackupVault(ctx context.Context, req *backupdrpb.CreateBackupVaultRequest, opts ...gax.CallOption) (*CreateBackupVaultOperation, error)
CreateBackupVault creates a new BackupVault in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.CreateBackupVaultRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#CreateBackupVaultRequest. } op, err := c.CreateBackupVault(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) CreateBackupVaultOperation ¶ added in v1.2.0
func (c *Client) CreateBackupVaultOperation(name string) *CreateBackupVaultOperation
CreateBackupVaultOperation returns a new CreateBackupVaultOperation from a given name. The name must be that of a previously created CreateBackupVaultOperation, possibly from a different process.
func (*Client) CreateManagementServer ¶
func (c *Client) CreateManagementServer(ctx context.Context, req *backupdrpb.CreateManagementServerRequest, opts ...gax.CallOption) (*CreateManagementServerOperation, error)
CreateManagementServer creates a new ManagementServer in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.CreateManagementServerRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#CreateManagementServerRequest. } op, err := c.CreateManagementServer(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) CreateManagementServerOperation ¶
func (c *Client) CreateManagementServerOperation(name string) *CreateManagementServerOperation
CreateManagementServerOperation returns a new CreateManagementServerOperation from a given name. The name must be that of a previously created CreateManagementServerOperation, possibly from a different process.
func (*Client) DeleteBackup ¶ added in v1.2.0
func (c *Client) DeleteBackup(ctx context.Context, req *backupdrpb.DeleteBackupRequest, opts ...gax.CallOption) (*DeleteBackupOperation, error)
DeleteBackup deletes a Backup.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.DeleteBackupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#DeleteBackupRequest. } op, err := c.DeleteBackup(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) DeleteBackupOperation ¶ added in v1.2.0
func (c *Client) 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 (*Client) DeleteBackupPlan ¶ added in v1.2.0
func (c *Client) DeleteBackupPlan(ctx context.Context, req *backupdrpb.DeleteBackupPlanRequest, opts ...gax.CallOption) (*DeleteBackupPlanOperation, error)
DeleteBackupPlan deletes a single BackupPlan.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.DeleteBackupPlanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#DeleteBackupPlanRequest. } op, err := c.DeleteBackupPlan(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
func (*Client) DeleteBackupPlanAssociation ¶ added in v1.2.0
func (c *Client) DeleteBackupPlanAssociation(ctx context.Context, req *backupdrpb.DeleteBackupPlanAssociationRequest, opts ...gax.CallOption) (*DeleteBackupPlanAssociationOperation, error)
DeleteBackupPlanAssociation deletes a single BackupPlanAssociation.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.DeleteBackupPlanAssociationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#DeleteBackupPlanAssociationRequest. } op, err := c.DeleteBackupPlanAssociation(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
func (*Client) DeleteBackupPlanAssociationOperation ¶ added in v1.2.0
func (c *Client) DeleteBackupPlanAssociationOperation(name string) *DeleteBackupPlanAssociationOperation
DeleteBackupPlanAssociationOperation returns a new DeleteBackupPlanAssociationOperation from a given name. The name must be that of a previously created DeleteBackupPlanAssociationOperation, possibly from a different process.
func (*Client) DeleteBackupPlanOperation ¶ added in v1.2.0
func (c *Client) DeleteBackupPlanOperation(name string) *DeleteBackupPlanOperation
DeleteBackupPlanOperation returns a new DeleteBackupPlanOperation from a given name. The name must be that of a previously created DeleteBackupPlanOperation, possibly from a different process.
func (*Client) DeleteBackupVault ¶ added in v1.2.0
func (c *Client) DeleteBackupVault(ctx context.Context, req *backupdrpb.DeleteBackupVaultRequest, opts ...gax.CallOption) (*DeleteBackupVaultOperation, error)
DeleteBackupVault deletes a BackupVault.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.DeleteBackupVaultRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#DeleteBackupVaultRequest. } op, err := c.DeleteBackupVault(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
func (*Client) DeleteBackupVaultOperation ¶ added in v1.2.0
func (c *Client) DeleteBackupVaultOperation(name string) *DeleteBackupVaultOperation
DeleteBackupVaultOperation returns a new DeleteBackupVaultOperation from a given name. The name must be that of a previously created DeleteBackupVaultOperation, possibly from a different process.
func (*Client) DeleteManagementServer ¶
func (c *Client) DeleteManagementServer(ctx context.Context, req *backupdrpb.DeleteManagementServerRequest, opts ...gax.CallOption) (*DeleteManagementServerOperation, error)
DeleteManagementServer deletes a single ManagementServer.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.DeleteManagementServerRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#DeleteManagementServerRequest. } op, err := c.DeleteManagementServer(ctx, req) if err != nil { // TODO: Handle error. } err = op.Wait(ctx) if err != nil { // TODO: Handle error. } }
func (*Client) DeleteManagementServerOperation ¶
func (c *Client) DeleteManagementServerOperation(name string) *DeleteManagementServerOperation
DeleteManagementServerOperation returns a new DeleteManagementServerOperation from a given name. The name must be that of a previously created DeleteManagementServerOperation, possibly from a different process.
func (*Client) DeleteOperation ¶
func (c *Client) 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" backupdr "cloud.google.com/go/backupdr/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := backupdr.NewClient(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. } }
func (*Client) FetchBackupPlanAssociationsForResourceType ¶ added in v1.4.0
func (c *Client) FetchBackupPlanAssociationsForResourceType(ctx context.Context, req *backupdrpb.FetchBackupPlanAssociationsForResourceTypeRequest, opts ...gax.CallOption) *BackupPlanAssociationIterator
FetchBackupPlanAssociationsForResourceType list BackupPlanAssociations for a given resource type.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.FetchBackupPlanAssociationsForResourceTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#FetchBackupPlanAssociationsForResourceTypeRequest. } it := c.FetchBackupPlanAssociationsForResourceType(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.(*backupdrpb.FetchBackupPlanAssociationsForResourceTypeResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.FetchBackupPlanAssociationsForResourceTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#FetchBackupPlanAssociationsForResourceTypeRequest. } for resp, err := range c.FetchBackupPlanAssociationsForResourceType(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) FetchDataSourceReferencesForResourceType ¶ added in v1.4.0
func (c *Client) FetchDataSourceReferencesForResourceType(ctx context.Context, req *backupdrpb.FetchDataSourceReferencesForResourceTypeRequest, opts ...gax.CallOption) *DataSourceReferenceIterator
FetchDataSourceReferencesForResourceType fetch DataSourceReferences for a given project, location and resource type.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.FetchDataSourceReferencesForResourceTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#FetchDataSourceReferencesForResourceTypeRequest. } it := c.FetchDataSourceReferencesForResourceType(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.(*backupdrpb.FetchDataSourceReferencesForResourceTypeResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.FetchDataSourceReferencesForResourceTypeRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#FetchDataSourceReferencesForResourceTypeRequest. } for resp, err := range c.FetchDataSourceReferencesForResourceType(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) FetchUsableBackupVaults ¶ added in v1.2.0
func (c *Client) FetchUsableBackupVaults(ctx context.Context, req *backupdrpb.FetchUsableBackupVaultsRequest, opts ...gax.CallOption) *BackupVaultIterator
FetchUsableBackupVaults fetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.FetchUsableBackupVaultsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#FetchUsableBackupVaultsRequest. } it := c.FetchUsableBackupVaults(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.(*backupdrpb.FetchUsableBackupVaultsResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.FetchUsableBackupVaultsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#FetchUsableBackupVaultsRequest. } for resp, err := range c.FetchUsableBackupVaults(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) GetBackup ¶ added in v1.2.0
func (c *Client) GetBackup(ctx context.Context, req *backupdrpb.GetBackupRequest, opts ...gax.CallOption) (*backupdrpb.Backup, error)
GetBackup gets details of a Backup.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.GetBackupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#GetBackupRequest. } resp, err := c.GetBackup(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) GetBackupPlan ¶ added in v1.2.0
func (c *Client) GetBackupPlan(ctx context.Context, req *backupdrpb.GetBackupPlanRequest, opts ...gax.CallOption) (*backupdrpb.BackupPlan, error)
GetBackupPlan gets details of a single BackupPlan.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.GetBackupPlanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#GetBackupPlanRequest. } resp, err := c.GetBackupPlan(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) GetBackupPlanAssociation ¶ added in v1.2.0
func (c *Client) GetBackupPlanAssociation(ctx context.Context, req *backupdrpb.GetBackupPlanAssociationRequest, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, error)
GetBackupPlanAssociation gets details of a single BackupPlanAssociation.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.GetBackupPlanAssociationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#GetBackupPlanAssociationRequest. } resp, err := c.GetBackupPlanAssociation(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) GetBackupPlanRevision ¶ added in v1.4.0
func (c *Client) GetBackupPlanRevision(ctx context.Context, req *backupdrpb.GetBackupPlanRevisionRequest, opts ...gax.CallOption) (*backupdrpb.BackupPlanRevision, error)
GetBackupPlanRevision gets details of a single BackupPlanRevision.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.GetBackupPlanRevisionRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#GetBackupPlanRevisionRequest. } resp, err := c.GetBackupPlanRevision(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) GetBackupVault ¶ added in v1.2.0
func (c *Client) GetBackupVault(ctx context.Context, req *backupdrpb.GetBackupVaultRequest, opts ...gax.CallOption) (*backupdrpb.BackupVault, error)
GetBackupVault gets details of a BackupVault.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.GetBackupVaultRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#GetBackupVaultRequest. } resp, err := c.GetBackupVault(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) GetDataSource ¶ added in v1.2.0
func (c *Client) GetDataSource(ctx context.Context, req *backupdrpb.GetDataSourceRequest, opts ...gax.CallOption) (*backupdrpb.DataSource, error)
GetDataSource gets details of a DataSource.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.GetDataSourceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#GetDataSourceRequest. } resp, err := c.GetDataSource(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) GetDataSourceReference ¶ added in v1.4.0
func (c *Client) GetDataSourceReference(ctx context.Context, req *backupdrpb.GetDataSourceReferenceRequest, opts ...gax.CallOption) (*backupdrpb.DataSourceReference, error)
GetDataSourceReference gets details of a single DataSourceReference.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.GetDataSourceReferenceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#GetDataSourceReferenceRequest. } resp, err := c.GetDataSourceReference(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) GetIamPolicy ¶
func (c *Client) 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" backupdr "cloud.google.com/go/backupdr/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) 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 := backupdr.NewClient(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 }
func (*Client) GetLocation ¶
func (c *Client) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)
GetLocation gets information about a location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/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 := backupdr.NewClient(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 }
func (*Client) GetManagementServer ¶
func (c *Client) GetManagementServer(ctx context.Context, req *backupdrpb.GetManagementServerRequest, opts ...gax.CallOption) (*backupdrpb.ManagementServer, error)
GetManagementServer gets details of a single ManagementServer.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.GetManagementServerRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#GetManagementServerRequest. } resp, err := c.GetManagementServer(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) GetOperation ¶
func (c *Client) 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" backupdr "cloud.google.com/go/backupdr/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := backupdr.NewClient(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 }
func (*Client) InitializeService ¶ added in v1.3.0
func (c *Client) InitializeService(ctx context.Context, req *backupdrpb.InitializeServiceRequest, opts ...gax.CallOption) (*InitializeServiceOperation, error)
InitializeService initializes the service related config for a project.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.InitializeServiceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#InitializeServiceRequest. } op, err := c.InitializeService(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) InitializeServiceOperation ¶ added in v1.3.0
func (c *Client) InitializeServiceOperation(name string) *InitializeServiceOperation
InitializeServiceOperation returns a new InitializeServiceOperation from a given name. The name must be that of a previously created InitializeServiceOperation, possibly from a different process.
func (*Client) ListBackupPlanAssociations ¶ added in v1.2.0
func (c *Client) ListBackupPlanAssociations(ctx context.Context, req *backupdrpb.ListBackupPlanAssociationsRequest, opts ...gax.CallOption) *BackupPlanAssociationIterator
ListBackupPlanAssociations lists BackupPlanAssociations in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupPlanAssociationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupPlanAssociationsRequest. } it := c.ListBackupPlanAssociations(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.(*backupdrpb.ListBackupPlanAssociationsResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupPlanAssociationsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupPlanAssociationsRequest. } for resp, err := range c.ListBackupPlanAssociations(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) ListBackupPlanRevisions ¶ added in v1.4.0
func (c *Client) ListBackupPlanRevisions(ctx context.Context, req *backupdrpb.ListBackupPlanRevisionsRequest, opts ...gax.CallOption) *BackupPlanRevisionIterator
ListBackupPlanRevisions lists BackupPlanRevisions in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupPlanRevisionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupPlanRevisionsRequest. } it := c.ListBackupPlanRevisions(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.(*backupdrpb.ListBackupPlanRevisionsResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupPlanRevisionsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupPlanRevisionsRequest. } for resp, err := range c.ListBackupPlanRevisions(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) ListBackupPlans ¶ added in v1.2.0
func (c *Client) ListBackupPlans(ctx context.Context, req *backupdrpb.ListBackupPlansRequest, opts ...gax.CallOption) *BackupPlanIterator
ListBackupPlans lists BackupPlans in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupPlansRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupPlansRequest. } it := c.ListBackupPlans(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.(*backupdrpb.ListBackupPlansResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupPlansRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupPlansRequest. } for resp, err := range c.ListBackupPlans(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) ListBackupVaults ¶ added in v1.2.0
func (c *Client) ListBackupVaults(ctx context.Context, req *backupdrpb.ListBackupVaultsRequest, opts ...gax.CallOption) *BackupVaultIterator
ListBackupVaults lists BackupVaults in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupVaultsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupVaultsRequest. } it := c.ListBackupVaults(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.(*backupdrpb.ListBackupVaultsResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupVaultsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupVaultsRequest. } for resp, err := range c.ListBackupVaults(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) ListBackups ¶ added in v1.2.0
func (c *Client) ListBackups(ctx context.Context, req *backupdrpb.ListBackupsRequest, opts ...gax.CallOption) *BackupIterator
ListBackups lists Backups in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#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.(*backupdrpb.ListBackupsResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListBackupsRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListBackupsRequest. } for resp, err := range c.ListBackups(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) ListDataSources ¶ added in v1.2.0
func (c *Client) ListDataSources(ctx context.Context, req *backupdrpb.ListDataSourcesRequest, opts ...gax.CallOption) *DataSourceIterator
ListDataSources lists DataSources in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListDataSourcesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListDataSourcesRequest. } it := c.ListDataSources(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.(*backupdrpb.ListDataSourcesResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListDataSourcesRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListDataSourcesRequest. } for resp, err := range c.ListDataSources(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) ListLocations ¶
func (c *Client) 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" backupdr "cloud.google.com/go/backupdr/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 := backupdr.NewClient(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) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/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 := backupdr.NewClient(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 and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) ListManagementServers ¶
func (c *Client) ListManagementServers(ctx context.Context, req *backupdrpb.ListManagementServersRequest, opts ...gax.CallOption) *ManagementServerIterator
ListManagementServers lists ManagementServers in a given project and location.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" "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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListManagementServersRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListManagementServersRequest. } it := c.ListManagementServers(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.(*backupdrpb.ListManagementServersResponse) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.ListManagementServersRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#ListManagementServersRequest. } for resp, err := range c.ListManagementServers(ctx, req).All() { if err != nil { // TODO: Handle error and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) ListOperations ¶
func (c *Client) 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" backupdr "cloud.google.com/go/backupdr/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" "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 := backupdr.NewClient(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) } }
Example (All) ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" longrunningpb "cloud.google.com/go/longrunning/autogen/longrunningpb" ) 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 := backupdr.NewClient(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 and break/return/continue. Iteration will stop after any error. } // TODO: Use resp. _ = resp } }
func (*Client) RestoreBackup ¶ added in v1.2.0
func (c *Client) RestoreBackup(ctx context.Context, req *backupdrpb.RestoreBackupRequest, opts ...gax.CallOption) (*RestoreBackupOperation, error)
RestoreBackup restore from a Backup
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.RestoreBackupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#RestoreBackupRequest. } op, err := c.RestoreBackup(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) RestoreBackupOperation ¶ added in v1.2.0
func (c *Client) RestoreBackupOperation(name string) *RestoreBackupOperation
RestoreBackupOperation returns a new RestoreBackupOperation from a given name. The name must be that of a previously created RestoreBackupOperation, possibly from a different process.
func (*Client) SetIamPolicy ¶
func (c *Client) 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" backupdr "cloud.google.com/go/backupdr/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) 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 := backupdr.NewClient(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 }
func (*Client) TestIamPermissions ¶
func (c *Client) 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" backupdr "cloud.google.com/go/backupdr/apiv1" iampb "cloud.google.com/go/iam/apiv1/iampb" ) 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 := backupdr.NewClient(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 }
func (*Client) TriggerBackup ¶ added in v1.2.0
func (c *Client) TriggerBackup(ctx context.Context, req *backupdrpb.TriggerBackupRequest, opts ...gax.CallOption) (*TriggerBackupOperation, error)
TriggerBackup triggers a new Backup.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.TriggerBackupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#TriggerBackupRequest. } op, err := c.TriggerBackup(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) TriggerBackupOperation ¶ added in v1.2.0
func (c *Client) TriggerBackupOperation(name string) *TriggerBackupOperation
TriggerBackupOperation returns a new TriggerBackupOperation from a given name. The name must be that of a previously created TriggerBackupOperation, possibly from a different process.
func (*Client) UpdateBackup ¶ added in v1.2.0
func (c *Client) UpdateBackup(ctx context.Context, req *backupdrpb.UpdateBackupRequest, opts ...gax.CallOption) (*UpdateBackupOperation, error)
UpdateBackup updates the settings of a Backup.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.UpdateBackupRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#UpdateBackupRequest. } op, err := c.UpdateBackup(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) UpdateBackupOperation ¶ added in v1.2.0
func (c *Client) UpdateBackupOperation(name string) *UpdateBackupOperation
UpdateBackupOperation returns a new UpdateBackupOperation from a given name. The name must be that of a previously created UpdateBackupOperation, possibly from a different process.
func (*Client) UpdateBackupPlan ¶ added in v1.4.0
func (c *Client) UpdateBackupPlan(ctx context.Context, req *backupdrpb.UpdateBackupPlanRequest, opts ...gax.CallOption) (*UpdateBackupPlanOperation, error)
UpdateBackupPlan update a BackupPlan.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.UpdateBackupPlanRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#UpdateBackupPlanRequest. } op, err := c.UpdateBackupPlan(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) UpdateBackupPlanAssociation ¶ added in v1.4.0
func (c *Client) UpdateBackupPlanAssociation(ctx context.Context, req *backupdrpb.UpdateBackupPlanAssociationRequest, opts ...gax.CallOption) (*UpdateBackupPlanAssociationOperation, error)
UpdateBackupPlanAssociation update a BackupPlanAssociation.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.UpdateBackupPlanAssociationRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#UpdateBackupPlanAssociationRequest. } op, err := c.UpdateBackupPlanAssociation(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) UpdateBackupPlanAssociationOperation ¶ added in v1.4.0
func (c *Client) UpdateBackupPlanAssociationOperation(name string) *UpdateBackupPlanAssociationOperation
UpdateBackupPlanAssociationOperation returns a new UpdateBackupPlanAssociationOperation from a given name. The name must be that of a previously created UpdateBackupPlanAssociationOperation, possibly from a different process.
func (*Client) UpdateBackupPlanOperation ¶ added in v1.4.0
func (c *Client) UpdateBackupPlanOperation(name string) *UpdateBackupPlanOperation
UpdateBackupPlanOperation returns a new UpdateBackupPlanOperation from a given name. The name must be that of a previously created UpdateBackupPlanOperation, possibly from a different process.
func (*Client) UpdateBackupVault ¶ added in v1.2.0
func (c *Client) UpdateBackupVault(ctx context.Context, req *backupdrpb.UpdateBackupVaultRequest, opts ...gax.CallOption) (*UpdateBackupVaultOperation, error)
UpdateBackupVault updates the settings of a BackupVault.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.UpdateBackupVaultRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#UpdateBackupVaultRequest. } op, err := c.UpdateBackupVault(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) UpdateBackupVaultOperation ¶ added in v1.2.0
func (c *Client) UpdateBackupVaultOperation(name string) *UpdateBackupVaultOperation
UpdateBackupVaultOperation returns a new UpdateBackupVaultOperation from a given name. The name must be that of a previously created UpdateBackupVaultOperation, possibly from a different process.
func (*Client) UpdateDataSource ¶ added in v1.2.0
func (c *Client) UpdateDataSource(ctx context.Context, req *backupdrpb.UpdateDataSourceRequest, opts ...gax.CallOption) (*UpdateDataSourceOperation, error)
UpdateDataSource updates the settings of a DataSource.
Example ¶
package main import ( "context" backupdr "cloud.google.com/go/backupdr/apiv1" backupdrpb "cloud.google.com/go/backupdr/apiv1/backupdrpb" ) 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 := backupdr.NewClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &backupdrpb.UpdateDataSourceRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/backupdr/apiv1/backupdrpb#UpdateDataSourceRequest. } op, err := c.UpdateDataSource(ctx, req) if err != nil { // TODO: Handle error. } resp, err := op.Wait(ctx) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp }
func (*Client) UpdateDataSourceOperation ¶ added in v1.2.0
func (c *Client) UpdateDataSourceOperation(name string) *UpdateDataSourceOperation
UpdateDataSourceOperation returns a new UpdateDataSourceOperation from a given name. The name must be that of a previously created UpdateDataSourceOperation, possibly from a different process.
type CreateBackupPlanAssociationOperation ¶ added in v1.2.0
type CreateBackupPlanAssociationOperation struct {
// contains filtered or unexported fields
}
CreateBackupPlanAssociationOperation manages a long-running operation from CreateBackupPlanAssociation.
func (*CreateBackupPlanAssociationOperation) Done ¶ added in v1.2.0
func (op *CreateBackupPlanAssociationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateBackupPlanAssociationOperation) Metadata ¶ added in v1.2.0
func (op *CreateBackupPlanAssociationOperation) Metadata() (*backupdrpb.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 (*CreateBackupPlanAssociationOperation) Name ¶ added in v1.2.0
func (op *CreateBackupPlanAssociationOperation) 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 (*CreateBackupPlanAssociationOperation) Poll ¶ added in v1.2.0
func (op *CreateBackupPlanAssociationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, 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 (*CreateBackupPlanAssociationOperation) Wait ¶ added in v1.2.0
func (op *CreateBackupPlanAssociationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, 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 CreateBackupPlanOperation ¶ added in v1.2.0
type CreateBackupPlanOperation struct {
// contains filtered or unexported fields
}
CreateBackupPlanOperation manages a long-running operation from CreateBackupPlan.
func (*CreateBackupPlanOperation) Done ¶ added in v1.2.0
func (op *CreateBackupPlanOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateBackupPlanOperation) Metadata ¶ added in v1.2.0
func (op *CreateBackupPlanOperation) Metadata() (*backupdrpb.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 (*CreateBackupPlanOperation) Name ¶ added in v1.2.0
func (op *CreateBackupPlanOperation) 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 (*CreateBackupPlanOperation) Poll ¶ added in v1.2.0
func (op *CreateBackupPlanOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlan, 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 (*CreateBackupPlanOperation) Wait ¶ added in v1.2.0
func (op *CreateBackupPlanOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlan, 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 CreateBackupVaultOperation ¶ added in v1.2.0
type CreateBackupVaultOperation struct {
// contains filtered or unexported fields
}
CreateBackupVaultOperation manages a long-running operation from CreateBackupVault.
func (*CreateBackupVaultOperation) Done ¶ added in v1.2.0
func (op *CreateBackupVaultOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateBackupVaultOperation) Metadata ¶ added in v1.2.0
func (op *CreateBackupVaultOperation) Metadata() (*backupdrpb.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 (*CreateBackupVaultOperation) Name ¶ added in v1.2.0
func (op *CreateBackupVaultOperation) 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 (*CreateBackupVaultOperation) Poll ¶ added in v1.2.0
func (op *CreateBackupVaultOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupVault, 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 (*CreateBackupVaultOperation) Wait ¶ added in v1.2.0
func (op *CreateBackupVaultOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupVault, 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 CreateManagementServerOperation ¶
type CreateManagementServerOperation struct {
// contains filtered or unexported fields
}
CreateManagementServerOperation manages a long-running operation from CreateManagementServer.
func (*CreateManagementServerOperation) Done ¶
func (op *CreateManagementServerOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CreateManagementServerOperation) Metadata ¶
func (op *CreateManagementServerOperation) Metadata() (*backupdrpb.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 (*CreateManagementServerOperation) Name ¶
func (op *CreateManagementServerOperation) 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 (*CreateManagementServerOperation) Poll ¶
func (op *CreateManagementServerOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.ManagementServer, 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 (*CreateManagementServerOperation) Wait ¶
func (op *CreateManagementServerOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.ManagementServer, 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 DataSourceIterator ¶ added in v1.2.0
type DataSourceIterator 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 []*backupdrpb.DataSource, nextPageToken string, err error) // contains filtered or unexported fields }
DataSourceIterator manages a stream of *backupdrpb.DataSource.
func (*DataSourceIterator) All ¶ added in v1.2.0
func (it *DataSourceIterator) All() iter.Seq2[*backupdrpb.DataSource, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*DataSourceIterator) Next ¶ added in v1.2.0
func (it *DataSourceIterator) Next() (*backupdrpb.DataSource, 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 (*DataSourceIterator) PageInfo ¶ added in v1.2.0
func (it *DataSourceIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type DataSourceReferenceIterator ¶ added in v1.4.0
type DataSourceReferenceIterator 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 []*backupdrpb.DataSourceReference, nextPageToken string, err error) // contains filtered or unexported fields }
DataSourceReferenceIterator manages a stream of *backupdrpb.DataSourceReference.
func (*DataSourceReferenceIterator) All ¶ added in v1.4.0
func (it *DataSourceReferenceIterator) All() iter.Seq2[*backupdrpb.DataSourceReference, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*DataSourceReferenceIterator) Next ¶ added in v1.4.0
func (it *DataSourceReferenceIterator) Next() (*backupdrpb.DataSourceReference, 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 (*DataSourceReferenceIterator) PageInfo ¶ added in v1.4.0
func (it *DataSourceReferenceIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type DeleteBackupOperation ¶ added in v1.2.0
type DeleteBackupOperation struct {
// contains filtered or unexported fields
}
DeleteBackupOperation manages a long-running operation from DeleteBackup.
func (*DeleteBackupOperation) Done ¶ added in v1.2.0
func (op *DeleteBackupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteBackupOperation) Metadata ¶ added in v1.2.0
func (op *DeleteBackupOperation) Metadata() (*backupdrpb.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 v1.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 v1.2.0
func (op *DeleteBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.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 (*DeleteBackupOperation) Wait ¶ added in v1.2.0
func (op *DeleteBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.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 DeleteBackupPlanAssociationOperation ¶ added in v1.2.0
type DeleteBackupPlanAssociationOperation struct {
// contains filtered or unexported fields
}
DeleteBackupPlanAssociationOperation manages a long-running operation from DeleteBackupPlanAssociation.
func (*DeleteBackupPlanAssociationOperation) Done ¶ added in v1.2.0
func (op *DeleteBackupPlanAssociationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteBackupPlanAssociationOperation) Metadata ¶ added in v1.2.0
func (op *DeleteBackupPlanAssociationOperation) Metadata() (*backupdrpb.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 (*DeleteBackupPlanAssociationOperation) Name ¶ added in v1.2.0
func (op *DeleteBackupPlanAssociationOperation) 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 (*DeleteBackupPlanAssociationOperation) Poll ¶ added in v1.2.0
func (op *DeleteBackupPlanAssociationOperation) 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 (*DeleteBackupPlanAssociationOperation) Wait ¶ added in v1.2.0
func (op *DeleteBackupPlanAssociationOperation) 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 DeleteBackupPlanOperation ¶ added in v1.2.0
type DeleteBackupPlanOperation struct {
// contains filtered or unexported fields
}
DeleteBackupPlanOperation manages a long-running operation from DeleteBackupPlan.
func (*DeleteBackupPlanOperation) Done ¶ added in v1.2.0
func (op *DeleteBackupPlanOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteBackupPlanOperation) Metadata ¶ added in v1.2.0
func (op *DeleteBackupPlanOperation) Metadata() (*backupdrpb.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 (*DeleteBackupPlanOperation) Name ¶ added in v1.2.0
func (op *DeleteBackupPlanOperation) 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 (*DeleteBackupPlanOperation) Poll ¶ added in v1.2.0
func (op *DeleteBackupPlanOperation) 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 (*DeleteBackupPlanOperation) Wait ¶ added in v1.2.0
func (op *DeleteBackupPlanOperation) 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 DeleteBackupVaultOperation ¶ added in v1.2.0
type DeleteBackupVaultOperation struct {
// contains filtered or unexported fields
}
DeleteBackupVaultOperation manages a long-running operation from DeleteBackupVault.
func (*DeleteBackupVaultOperation) Done ¶ added in v1.2.0
func (op *DeleteBackupVaultOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteBackupVaultOperation) Metadata ¶ added in v1.2.0
func (op *DeleteBackupVaultOperation) Metadata() (*backupdrpb.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 (*DeleteBackupVaultOperation) Name ¶ added in v1.2.0
func (op *DeleteBackupVaultOperation) 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 (*DeleteBackupVaultOperation) Poll ¶ added in v1.2.0
func (op *DeleteBackupVaultOperation) 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 (*DeleteBackupVaultOperation) Wait ¶ added in v1.2.0
func (op *DeleteBackupVaultOperation) 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 DeleteManagementServerOperation ¶
type DeleteManagementServerOperation struct {
// contains filtered or unexported fields
}
DeleteManagementServerOperation manages a long-running operation from DeleteManagementServer.
func (*DeleteManagementServerOperation) Done ¶
func (op *DeleteManagementServerOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*DeleteManagementServerOperation) Metadata ¶
func (op *DeleteManagementServerOperation) Metadata() (*backupdrpb.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 (*DeleteManagementServerOperation) Name ¶
func (op *DeleteManagementServerOperation) 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 (*DeleteManagementServerOperation) Poll ¶
func (op *DeleteManagementServerOperation) 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 (*DeleteManagementServerOperation) Wait ¶
func (op *DeleteManagementServerOperation) 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 InitializeServiceOperation ¶ added in v1.3.0
type InitializeServiceOperation struct {
// contains filtered or unexported fields
}
InitializeServiceOperation manages a long-running operation from InitializeService.
func (*InitializeServiceOperation) Done ¶ added in v1.3.0
func (op *InitializeServiceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*InitializeServiceOperation) Metadata ¶ added in v1.3.0
func (op *InitializeServiceOperation) Metadata() (*backupdrpb.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 (*InitializeServiceOperation) Name ¶ added in v1.3.0
func (op *InitializeServiceOperation) 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 (*InitializeServiceOperation) Poll ¶ added in v1.3.0
func (op *InitializeServiceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.InitializeServiceResponse, 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 (*InitializeServiceOperation) Wait ¶ added in v1.3.0
func (op *InitializeServiceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.InitializeServiceResponse, 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 LocationIterator ¶
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.1.0
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 ¶
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 ¶
func (it *LocationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type ManagementServerIterator ¶
type ManagementServerIterator 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 []*backupdrpb.ManagementServer, nextPageToken string, err error) // contains filtered or unexported fields }
ManagementServerIterator manages a stream of *backupdrpb.ManagementServer.
func (*ManagementServerIterator) All ¶ added in v1.1.0
func (it *ManagementServerIterator) All() iter.Seq2[*backupdrpb.ManagementServer, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ManagementServerIterator) Next ¶
func (it *ManagementServerIterator) Next() (*backupdrpb.ManagementServer, 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 (*ManagementServerIterator) PageInfo ¶
func (it *ManagementServerIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type OperationIterator ¶
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.1.0
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 ¶
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 ¶
func (it *OperationIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
type RestoreBackupOperation ¶ added in v1.2.0
type RestoreBackupOperation struct {
// contains filtered or unexported fields
}
RestoreBackupOperation manages a long-running operation from RestoreBackup.
func (*RestoreBackupOperation) Done ¶ added in v1.2.0
func (op *RestoreBackupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*RestoreBackupOperation) Metadata ¶ added in v1.2.0
func (op *RestoreBackupOperation) Metadata() (*backupdrpb.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 (*RestoreBackupOperation) Name ¶ added in v1.2.0
func (op *RestoreBackupOperation) 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 (*RestoreBackupOperation) Poll ¶ added in v1.2.0
func (op *RestoreBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.RestoreBackupResponse, 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 (*RestoreBackupOperation) Wait ¶ added in v1.2.0
func (op *RestoreBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.RestoreBackupResponse, 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 TriggerBackupOperation ¶ added in v1.2.0
type TriggerBackupOperation struct {
// contains filtered or unexported fields
}
TriggerBackupOperation manages a long-running operation from TriggerBackup.
func (*TriggerBackupOperation) Done ¶ added in v1.2.0
func (op *TriggerBackupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*TriggerBackupOperation) Metadata ¶ added in v1.2.0
func (op *TriggerBackupOperation) Metadata() (*backupdrpb.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 (*TriggerBackupOperation) Name ¶ added in v1.2.0
func (op *TriggerBackupOperation) 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 (*TriggerBackupOperation) Poll ¶ added in v1.2.0
func (op *TriggerBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, 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 (*TriggerBackupOperation) Wait ¶ added in v1.2.0
func (op *TriggerBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, 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 UpdateBackupOperation ¶ added in v1.2.0
type UpdateBackupOperation struct {
// contains filtered or unexported fields
}
UpdateBackupOperation manages a long-running operation from UpdateBackup.
func (*UpdateBackupOperation) Done ¶ added in v1.2.0
func (op *UpdateBackupOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateBackupOperation) Metadata ¶ added in v1.2.0
func (op *UpdateBackupOperation) Metadata() (*backupdrpb.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 (*UpdateBackupOperation) Name ¶ added in v1.2.0
func (op *UpdateBackupOperation) 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 (*UpdateBackupOperation) Poll ¶ added in v1.2.0
func (op *UpdateBackupOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.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 (*UpdateBackupOperation) Wait ¶ added in v1.2.0
func (op *UpdateBackupOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.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 UpdateBackupPlanAssociationOperation ¶ added in v1.4.0
type UpdateBackupPlanAssociationOperation struct {
// contains filtered or unexported fields
}
UpdateBackupPlanAssociationOperation manages a long-running operation from UpdateBackupPlanAssociation.
func (*UpdateBackupPlanAssociationOperation) Done ¶ added in v1.4.0
func (op *UpdateBackupPlanAssociationOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateBackupPlanAssociationOperation) Metadata ¶ added in v1.4.0
func (op *UpdateBackupPlanAssociationOperation) Metadata() (*backupdrpb.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 (*UpdateBackupPlanAssociationOperation) Name ¶ added in v1.4.0
func (op *UpdateBackupPlanAssociationOperation) 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 (*UpdateBackupPlanAssociationOperation) Poll ¶ added in v1.4.0
func (op *UpdateBackupPlanAssociationOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, 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 (*UpdateBackupPlanAssociationOperation) Wait ¶ added in v1.4.0
func (op *UpdateBackupPlanAssociationOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlanAssociation, 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 UpdateBackupPlanOperation ¶ added in v1.4.0
type UpdateBackupPlanOperation struct {
// contains filtered or unexported fields
}
UpdateBackupPlanOperation manages a long-running operation from UpdateBackupPlan.
func (*UpdateBackupPlanOperation) Done ¶ added in v1.4.0
func (op *UpdateBackupPlanOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateBackupPlanOperation) Metadata ¶ added in v1.4.0
func (op *UpdateBackupPlanOperation) Metadata() (*backupdrpb.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 (*UpdateBackupPlanOperation) Name ¶ added in v1.4.0
func (op *UpdateBackupPlanOperation) 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 (*UpdateBackupPlanOperation) Poll ¶ added in v1.4.0
func (op *UpdateBackupPlanOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlan, 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 (*UpdateBackupPlanOperation) Wait ¶ added in v1.4.0
func (op *UpdateBackupPlanOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupPlan, 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 UpdateBackupVaultOperation ¶ added in v1.2.0
type UpdateBackupVaultOperation struct {
// contains filtered or unexported fields
}
UpdateBackupVaultOperation manages a long-running operation from UpdateBackupVault.
func (*UpdateBackupVaultOperation) Done ¶ added in v1.2.0
func (op *UpdateBackupVaultOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateBackupVaultOperation) Metadata ¶ added in v1.2.0
func (op *UpdateBackupVaultOperation) Metadata() (*backupdrpb.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 (*UpdateBackupVaultOperation) Name ¶ added in v1.2.0
func (op *UpdateBackupVaultOperation) 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 (*UpdateBackupVaultOperation) Poll ¶ added in v1.2.0
func (op *UpdateBackupVaultOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupVault, 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 (*UpdateBackupVaultOperation) Wait ¶ added in v1.2.0
func (op *UpdateBackupVaultOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.BackupVault, 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 UpdateDataSourceOperation ¶ added in v1.2.0
type UpdateDataSourceOperation struct {
// contains filtered or unexported fields
}
UpdateDataSourceOperation manages a long-running operation from UpdateDataSource.
func (*UpdateDataSourceOperation) Done ¶ added in v1.2.0
func (op *UpdateDataSourceOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*UpdateDataSourceOperation) Metadata ¶ added in v1.2.0
func (op *UpdateDataSourceOperation) Metadata() (*backupdrpb.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 (*UpdateDataSourceOperation) Name ¶ added in v1.2.0
func (op *UpdateDataSourceOperation) 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 (*UpdateDataSourceOperation) Poll ¶ added in v1.2.0
func (op *UpdateDataSourceOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.DataSource, 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 (*UpdateDataSourceOperation) Wait ¶ added in v1.2.0
func (op *UpdateDataSourceOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*backupdrpb.DataSource, 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.