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.
Functions
func DefaultAuthScopes
func DefaultAuthScopes() []stringDefaultAuthScopes reports the default set of authentication scopes to use with this package.
BackupIterator
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
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
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
func (it *BackupIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
BackupPlanAssociationIterator
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
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
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
func (it *BackupPlanAssociationIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
BackupPlanIterator
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
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
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
func (it *BackupPlanIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
BackupVaultIterator
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
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
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
func (it *BackupVaultIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
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
GetBackupPlan []gax.CallOption
ListBackupPlans []gax.CallOption
DeleteBackupPlan []gax.CallOption
CreateBackupPlanAssociation []gax.CallOption
GetBackupPlanAssociation []gax.CallOption
ListBackupPlanAssociations []gax.CallOption
DeleteBackupPlanAssociation []gax.CallOption
TriggerBackup []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.
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) errorCancelOperation 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.ClientConnConnection 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
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
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
func (c *Client) CreateBackupPlanAssociationOperation(name string) *CreateBackupPlanAssociationOperationCreateBackupPlanAssociationOperation 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
func (c *Client) CreateBackupPlanOperation(name string) *CreateBackupPlanOperationCreateBackupPlanOperation 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
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
func (c *Client) CreateBackupVaultOperation(name string) *CreateBackupVaultOperationCreateBackupVaultOperation 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) *CreateManagementServerOperationCreateManagementServerOperation 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
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
func (c *Client) DeleteBackupOperation(name string) *DeleteBackupOperationDeleteBackupOperation 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
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
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
func (c *Client) DeleteBackupPlanAssociationOperation(name string) *DeleteBackupPlanAssociationOperationDeleteBackupPlanAssociationOperation 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
func (c *Client) DeleteBackupPlanOperation(name string) *DeleteBackupPlanOperationDeleteBackupPlanOperation 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
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
func (c *Client) DeleteBackupVaultOperation(name string) *DeleteBackupVaultOperationDeleteBackupVaultOperation 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) *DeleteManagementServerOperationDeleteManagementServerOperation 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) errorDeleteOperation 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) FetchUsableBackupVaults
func (c *Client) FetchUsableBackupVaults(ctx context.Context, req *backupdrpb.FetchUsableBackupVaultsRequest, opts ...gax.CallOption) *BackupVaultIteratorFetchUsableBackupVaults fetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.
Examples
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)
}
}
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
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
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
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) GetBackupVault
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
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) 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) ListBackupPlanAssociations
func (c *Client) ListBackupPlanAssociations(ctx context.Context, req *backupdrpb.ListBackupPlanAssociationsRequest, opts ...gax.CallOption) *BackupPlanAssociationIteratorListBackupPlanAssociations lists BackupPlanAssociations in a given project and location.
Examples
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)
}
}
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) ListBackupPlans
func (c *Client) ListBackupPlans(ctx context.Context, req *backupdrpb.ListBackupPlansRequest, opts ...gax.CallOption) *BackupPlanIteratorListBackupPlans lists BackupPlans in a given project and location.
Examples
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)
}
}
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
func (c *Client) ListBackupVaults(ctx context.Context, req *backupdrpb.ListBackupVaultsRequest, opts ...gax.CallOption) *BackupVaultIteratorListBackupVaults lists BackupVaults in a given project and location.
Examples
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)
}
}
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
func (c *Client) ListBackups(ctx context.Context, req *backupdrpb.ListBackupsRequest, opts ...gax.CallOption) *BackupIteratorListBackups lists Backups in a given project and location.
Examples
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)
}
}
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
func (c *Client) ListDataSources(ctx context.Context, req *backupdrpb.ListDataSourcesRequest, opts ...gax.CallOption) *DataSourceIteratorListDataSources lists DataSources in a given project and location.
Examples
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)
}
}
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) *LocationIteratorListLocations lists information about the supported locations for this service.
Examples
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)
}
}
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) *ManagementServerIteratorListManagementServers lists ManagementServers in a given project and location.
Examples
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)
}
}
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) *OperationIteratorListOperations is a utility method from google.longrunning.Operations.
Examples
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)
}
}
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
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
func (c *Client) RestoreBackupOperation(name string) *RestoreBackupOperationRestoreBackupOperation 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
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
func (c *Client) TriggerBackupOperation(name string) *TriggerBackupOperationTriggerBackupOperation 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
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
func (c *Client) UpdateBackupOperation(name string) *UpdateBackupOperationUpdateBackupOperation 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) UpdateBackupVault
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
func (c *Client) UpdateBackupVaultOperation(name string) *UpdateBackupVaultOperationUpdateBackupVaultOperation 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
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
func (c *Client) UpdateDataSourceOperation(name string) *UpdateDataSourceOperationUpdateDataSourceOperation returns a new UpdateDataSourceOperation from a given name. The name must be that of a previously created UpdateDataSourceOperation, possibly from a different process.
CreateBackupPlanAssociationOperation
type CreateBackupPlanAssociationOperation struct {
// contains filtered or unexported fields
}CreateBackupPlanAssociationOperation manages a long-running operation from CreateBackupPlanAssociation.
func (*CreateBackupPlanAssociationOperation) Done
func (op *CreateBackupPlanAssociationOperation) Done() boolDone reports whether the long-running operation has completed.
func (*CreateBackupPlanAssociationOperation) Metadata
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
func (op *CreateBackupPlanAssociationOperation) Name() stringName 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
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
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.
CreateBackupPlanOperation
type CreateBackupPlanOperation struct {
// contains filtered or unexported fields
}CreateBackupPlanOperation manages a long-running operation from CreateBackupPlan.
func (*CreateBackupPlanOperation) Done
func (op *CreateBackupPlanOperation) Done() boolDone reports whether the long-running operation has completed.
func (*CreateBackupPlanOperation) Metadata
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
func (op *CreateBackupPlanOperation) Name() stringName 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
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
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.
CreateBackupVaultOperation
type CreateBackupVaultOperation struct {
// contains filtered or unexported fields
}CreateBackupVaultOperation manages a long-running operation from CreateBackupVault.
func (*CreateBackupVaultOperation) Done
func (op *CreateBackupVaultOperation) Done() boolDone reports whether the long-running operation has completed.
func (*CreateBackupVaultOperation) Metadata
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
func (op *CreateBackupVaultOperation) Name() stringName 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
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
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.
CreateManagementServerOperation
type CreateManagementServerOperation struct {
// contains filtered or unexported fields
}CreateManagementServerOperation manages a long-running operation from CreateManagementServer.
func (*CreateManagementServerOperation) Done
func (op *CreateManagementServerOperation) Done() boolDone 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() stringName 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.
DataSourceIterator
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
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
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
func (it *DataSourceIterator) PageInfo() *iterator.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
DeleteBackupOperation
type DeleteBackupOperation struct {
// contains filtered or unexported fields
}DeleteBackupOperation manages a long-running operation from DeleteBackup.
func (*DeleteBackupOperation) Done
func (op *DeleteBackupOperation) Done() boolDone reports whether the long-running operation has completed.
func (*DeleteBackupOperation) Metadata
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
func (op *DeleteBackupOperation) Name() stringName 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
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
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.
DeleteBackupPlanAssociationOperation
type DeleteBackupPlanAssociationOperation struct {
// contains filtered or unexported fields
}DeleteBackupPlanAssociationOperation manages a long-running operation from DeleteBackupPlanAssociation.
func (*DeleteBackupPlanAssociationOperation) Done
func (op *DeleteBackupPlanAssociationOperation) Done() boolDone reports whether the long-running operation has completed.
func (*DeleteBackupPlanAssociationOperation) Metadata
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
func (op *DeleteBackupPlanAssociationOperation) Name() stringName 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
func (op *DeleteBackupPlanAssociationOperation) Poll(ctx context.Context, opts ...gax.CallOption) errorPoll 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
func (op *DeleteBackupPlanAssociationOperation) Wait(ctx context.Context, opts ...gax.CallOption) errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteBackupPlanOperation
type DeleteBackupPlanOperation struct {
// contains filtered or unexported fields
}DeleteBackupPlanOperation manages a long-running operation from DeleteBackupPlan.
func (*DeleteBackupPlanOperation) Done
func (op *DeleteBackupPlanOperation) Done() boolDone reports whether the long-running operation has completed.
func (*DeleteBackupPlanOperation) Metadata
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
func (op *DeleteBackupPlanOperation) Name() stringName 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
func (op *DeleteBackupPlanOperation) Poll(ctx context.Context, opts ...gax.CallOption) errorPoll 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
func (op *DeleteBackupPlanOperation) Wait(ctx context.Context, opts ...gax.CallOption) errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteBackupVaultOperation
type DeleteBackupVaultOperation struct {
// contains filtered or unexported fields
}DeleteBackupVaultOperation manages a long-running operation from DeleteBackupVault.
func (*DeleteBackupVaultOperation) Done
func (op *DeleteBackupVaultOperation) Done() boolDone reports whether the long-running operation has completed.
func (*DeleteBackupVaultOperation) Metadata
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
func (op *DeleteBackupVaultOperation) Name() stringName 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
func (op *DeleteBackupVaultOperation) Poll(ctx context.Context, opts ...gax.CallOption) errorPoll 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
func (op *DeleteBackupVaultOperation) Wait(ctx context.Context, opts ...gax.CallOption) errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteManagementServerOperation
type DeleteManagementServerOperation struct {
// contains filtered or unexported fields
}DeleteManagementServerOperation manages a long-running operation from DeleteManagementServer.
func (*DeleteManagementServerOperation) Done
func (op *DeleteManagementServerOperation) Done() boolDone 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() stringName 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) errorPoll 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) errorWait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
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
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.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
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
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.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
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
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.PageInfoPageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
RestoreBackupOperation
type RestoreBackupOperation struct {
// contains filtered or unexported fields
}RestoreBackupOperation manages a long-running operation from RestoreBackup.
func (*RestoreBackupOperation) Done
func (op *RestoreBackupOperation) Done() boolDone reports whether the long-running operation has completed.
func (*RestoreBackupOperation) Metadata
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
func (op *RestoreBackupOperation) Name() stringName 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
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
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.
TriggerBackupOperation
type TriggerBackupOperation struct {
// contains filtered or unexported fields
}TriggerBackupOperation manages a long-running operation from TriggerBackup.
func (*TriggerBackupOperation) Done
func (op *TriggerBackupOperation) Done() boolDone reports whether the long-running operation has completed.
func (*TriggerBackupOperation) Metadata
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
func (op *TriggerBackupOperation) Name() stringName 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
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
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.
UpdateBackupOperation
type UpdateBackupOperation struct {
// contains filtered or unexported fields
}UpdateBackupOperation manages a long-running operation from UpdateBackup.
func (*UpdateBackupOperation) Done
func (op *UpdateBackupOperation) Done() boolDone reports whether the long-running operation has completed.
func (*UpdateBackupOperation) Metadata
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
func (op *UpdateBackupOperation) Name() stringName 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
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
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.
UpdateBackupVaultOperation
type UpdateBackupVaultOperation struct {
// contains filtered or unexported fields
}UpdateBackupVaultOperation manages a long-running operation from UpdateBackupVault.
func (*UpdateBackupVaultOperation) Done
func (op *UpdateBackupVaultOperation) Done() boolDone reports whether the long-running operation has completed.
func (*UpdateBackupVaultOperation) Metadata
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
func (op *UpdateBackupVaultOperation) Name() stringName 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
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
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.
UpdateDataSourceOperation
type UpdateDataSourceOperation struct {
// contains filtered or unexported fields
}UpdateDataSourceOperation manages a long-running operation from UpdateDataSource.
func (*UpdateDataSourceOperation) Done
func (op *UpdateDataSourceOperation) Done() boolDone reports whether the long-running operation has completed.
func (*UpdateDataSourceOperation) Metadata
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
func (op *UpdateDataSourceOperation) Name() stringName 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
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
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.