Backup and DR Service v1 API - Class BackupDR.BackupDRClient (1.1.0)

public class BackupDR.BackupDRClient : ClientBase<BackupDR.BackupDRClient>

Reference documentation and code samples for the Backup and DR Service v1 API class BackupDR.BackupDRClient.

Client for BackupDR

Inheritance

object > ClientBase > ClientBaseBackupDRBackupDRClient > BackupDR.BackupDRClient

Namespace

Google.Cloud.BackupDR.V1

Assembly

Google.Cloud.BackupDR.V1.dll

Constructors

BackupDRClient()

protected BackupDRClient()

Protected parameterless constructor to allow creation of test doubles.

BackupDRClient(CallInvoker)

public BackupDRClient(CallInvoker callInvoker)

Creates a new client for BackupDR that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

BackupDRClient(ChannelBase)

public BackupDRClient(ChannelBase channel)

Creates a new client for BackupDR

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

BackupDRClient(ClientBaseConfiguration)

protected BackupDRClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateManagementServer(CreateManagementServerRequest, CallOptions)

public virtual Operation CreateManagementServer(CreateManagementServerRequest request, CallOptions options)

Creates a new ManagementServer in a given project and location.

Parameters
Name Description
request CreateManagementServerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateManagementServer(CreateManagementServerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateManagementServer(CreateManagementServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new ManagementServer in a given project and location.

Parameters
Name Description
request CreateManagementServerRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

CreateManagementServerAsync(CreateManagementServerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateManagementServerAsync(CreateManagementServerRequest request, CallOptions options)

Creates a new ManagementServer in a given project and location.

Parameters
Name Description
request CreateManagementServerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateManagementServerAsync(CreateManagementServerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateManagementServerAsync(CreateManagementServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new ManagementServer in a given project and location.

Parameters
Name Description
request CreateManagementServerRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteManagementServer(DeleteManagementServerRequest, CallOptions)

public virtual Operation DeleteManagementServer(DeleteManagementServerRequest request, CallOptions options)

Deletes a single ManagementServer.

Parameters
Name Description
request DeleteManagementServerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteManagementServer(DeleteManagementServerRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteManagementServer(DeleteManagementServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single ManagementServer.

Parameters
Name Description
request DeleteManagementServerRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
Operation

The response received from the server.

DeleteManagementServerAsync(DeleteManagementServerRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteManagementServerAsync(DeleteManagementServerRequest request, CallOptions options)

Deletes a single ManagementServer.

Parameters
Name Description
request DeleteManagementServerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteManagementServerAsync(DeleteManagementServerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteManagementServerAsync(DeleteManagementServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a single ManagementServer.

Parameters
Name Description
request DeleteManagementServerRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

GetManagementServer(GetManagementServerRequest, CallOptions)

public virtual ManagementServer GetManagementServer(GetManagementServerRequest request, CallOptions options)

Gets details of a single ManagementServer.

Parameters
Name Description
request GetManagementServerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ManagementServer

The response received from the server.

GetManagementServer(GetManagementServerRequest, Metadata, DateTime?, CancellationToken)

public virtual ManagementServer GetManagementServer(GetManagementServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single ManagementServer.

Parameters
Name Description
request GetManagementServerRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ManagementServer

The response received from the server.

GetManagementServerAsync(GetManagementServerRequest, CallOptions)

public virtual AsyncUnaryCall<ManagementServer> GetManagementServerAsync(GetManagementServerRequest request, CallOptions options)

Gets details of a single ManagementServer.

Parameters
Name Description
request GetManagementServerRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallManagementServer

The call object.

GetManagementServerAsync(GetManagementServerRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ManagementServer> GetManagementServerAsync(GetManagementServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single ManagementServer.

Parameters
Name Description
request GetManagementServerRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallManagementServer

The call object.

ListManagementServers(ListManagementServersRequest, CallOptions)

public virtual ListManagementServersResponse ListManagementServers(ListManagementServersRequest request, CallOptions options)

Lists ManagementServers in a given project and location.

Parameters
Name Description
request ListManagementServersRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListManagementServersResponse

The response received from the server.

ListManagementServers(ListManagementServersRequest, Metadata, DateTime?, CancellationToken)

public virtual ListManagementServersResponse ListManagementServers(ListManagementServersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ManagementServers in a given project and location.

Parameters
Name Description
request ListManagementServersRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
ListManagementServersResponse

The response received from the server.

ListManagementServersAsync(ListManagementServersRequest, CallOptions)

public virtual AsyncUnaryCall<ListManagementServersResponse> ListManagementServersAsync(ListManagementServersRequest request, CallOptions options)

Lists ManagementServers in a given project and location.

Parameters
Name Description
request ListManagementServersRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListManagementServersResponse

The call object.

ListManagementServersAsync(ListManagementServersRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListManagementServersResponse> ListManagementServersAsync(ListManagementServersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists ManagementServers in a given project and location.

Parameters
Name Description
request ListManagementServersRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallListManagementServersResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override BackupDR.BackupDRClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
BackupDRBackupDRClient
Overrides