Rapid Migration Assessment v1 API - Class RapidMigrationAssessment.RapidMigrationAssessmentClient (1.0.0)

public class RapidMigrationAssessment.RapidMigrationAssessmentClient : ClientBase<RapidMigrationAssessment.RapidMigrationAssessmentClient>

Reference documentation and code samples for the Rapid Migration Assessment v1 API class RapidMigrationAssessment.RapidMigrationAssessmentClient.

Client for RapidMigrationAssessment

Inheritance

object > ClientBase > ClientBaseRapidMigrationAssessmentRapidMigrationAssessmentClient > RapidMigrationAssessment.RapidMigrationAssessmentClient

Namespace

Google.Cloud.RapidMigrationAssessment.V1

Assembly

Google.Cloud.RapidMigrationAssessment.V1.dll

Constructors

RapidMigrationAssessmentClient()

protected RapidMigrationAssessmentClient()

Protected parameterless constructor to allow creation of test doubles.

RapidMigrationAssessmentClient(CallInvoker)

public RapidMigrationAssessmentClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

RapidMigrationAssessmentClient(ChannelBase)

public RapidMigrationAssessmentClient(ChannelBase channel)

Creates a new client for RapidMigrationAssessment

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

RapidMigrationAssessmentClient(ClientBaseConfiguration)

protected RapidMigrationAssessmentClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateAnnotation(CreateAnnotationRequest, CallOptions)

public virtual Operation CreateAnnotation(CreateAnnotationRequest request, CallOptions options)

Creates an Annotation

Parameters
NameDescription
requestCreateAnnotationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateAnnotation(CreateAnnotationRequest, Metadata, DateTime?, CancellationToken)

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

Creates an Annotation

Parameters
NameDescription
requestCreateAnnotationRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateAnnotationAsync(CreateAnnotationRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateAnnotationAsync(CreateAnnotationRequest request, CallOptions options)

Creates an Annotation

Parameters
NameDescription
requestCreateAnnotationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateAnnotationAsync(CreateAnnotationRequest, Metadata, DateTime?, CancellationToken)

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

Creates an Annotation

Parameters
NameDescription
requestCreateAnnotationRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateCollector(CreateCollectorRequest, CallOptions)

public virtual Operation CreateCollector(CreateCollectorRequest request, CallOptions options)

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

Parameters
NameDescription
requestCreateCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateCollector(CreateCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

Parameters
NameDescription
requestCreateCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateCollectorAsync(CreateCollectorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateCollectorAsync(CreateCollectorRequest request, CallOptions options)

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

Parameters
NameDescription
requestCreateCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateCollectorAsync(CreateCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

Parameters
NameDescription
requestCreateCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

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

Returns
TypeDescription
LocationsLocationsClient

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

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
TypeDescription
OperationsOperationsClient

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

DeleteCollector(DeleteCollectorRequest, CallOptions)

public virtual Operation DeleteCollector(DeleteCollectorRequest request, CallOptions options)

Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.

Parameters
NameDescription
requestDeleteCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteCollector(DeleteCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.

Parameters
NameDescription
requestDeleteCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteCollectorAsync(DeleteCollectorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteCollectorAsync(DeleteCollectorRequest request, CallOptions options)

Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.

Parameters
NameDescription
requestDeleteCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteCollectorAsync(DeleteCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single Collector - changes state of collector to "Deleting". Background jobs does final deletion thorugh producer api.

Parameters
NameDescription
requestDeleteCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetAnnotation(GetAnnotationRequest, CallOptions)

public virtual Annotation GetAnnotation(GetAnnotationRequest request, CallOptions options)

Gets details of a single Annotation.

Parameters
NameDescription
requestGetAnnotationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Annotation

The response received from the server.

GetAnnotation(GetAnnotationRequest, Metadata, DateTime?, CancellationToken)

public virtual Annotation GetAnnotation(GetAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Annotation.

Parameters
NameDescription
requestGetAnnotationRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Annotation

The response received from the server.

GetAnnotationAsync(GetAnnotationRequest, CallOptions)

public virtual AsyncUnaryCall<Annotation> GetAnnotationAsync(GetAnnotationRequest request, CallOptions options)

Gets details of a single Annotation.

Parameters
NameDescription
requestGetAnnotationRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallAnnotation

The call object.

GetAnnotationAsync(GetAnnotationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Annotation> GetAnnotationAsync(GetAnnotationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Annotation.

Parameters
NameDescription
requestGetAnnotationRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallAnnotation

The call object.

GetCollector(GetCollectorRequest, CallOptions)

public virtual Collector GetCollector(GetCollectorRequest request, CallOptions options)

Gets details of a single Collector.

Parameters
NameDescription
requestGetCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Collector

The response received from the server.

GetCollector(GetCollectorRequest, Metadata, DateTime?, CancellationToken)

public virtual Collector GetCollector(GetCollectorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Collector.

Parameters
NameDescription
requestGetCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Collector

The response received from the server.

GetCollectorAsync(GetCollectorRequest, CallOptions)

public virtual AsyncUnaryCall<Collector> GetCollectorAsync(GetCollectorRequest request, CallOptions options)

Gets details of a single Collector.

Parameters
NameDescription
requestGetCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallCollector

The call object.

GetCollectorAsync(GetCollectorRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Collector> GetCollectorAsync(GetCollectorRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single Collector.

Parameters
NameDescription
requestGetCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallCollector

The call object.

ListCollectors(ListCollectorsRequest, CallOptions)

public virtual ListCollectorsResponse ListCollectors(ListCollectorsRequest request, CallOptions options)

Lists Collectors in a given project and location.

Parameters
NameDescription
requestListCollectorsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListCollectorsResponse

The response received from the server.

ListCollectors(ListCollectorsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCollectorsResponse ListCollectors(ListCollectorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Collectors in a given project and location.

Parameters
NameDescription
requestListCollectorsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListCollectorsResponse

The response received from the server.

ListCollectorsAsync(ListCollectorsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCollectorsResponse> ListCollectorsAsync(ListCollectorsRequest request, CallOptions options)

Lists Collectors in a given project and location.

Parameters
NameDescription
requestListCollectorsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListCollectorsResponse

The call object.

ListCollectorsAsync(ListCollectorsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCollectorsResponse> ListCollectorsAsync(ListCollectorsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists Collectors in a given project and location.

Parameters
NameDescription
requestListCollectorsRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListCollectorsResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override RapidMigrationAssessment.RapidMigrationAssessmentClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
RapidMigrationAssessmentRapidMigrationAssessmentClient
Overrides

PauseCollector(PauseCollectorRequest, CallOptions)

public virtual Operation PauseCollector(PauseCollectorRequest request, CallOptions options)

Pauses the given collector.

Parameters
NameDescription
requestPauseCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

PauseCollector(PauseCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Pauses the given collector.

Parameters
NameDescription
requestPauseCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

PauseCollectorAsync(PauseCollectorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PauseCollectorAsync(PauseCollectorRequest request, CallOptions options)

Pauses the given collector.

Parameters
NameDescription
requestPauseCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

PauseCollectorAsync(PauseCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Pauses the given collector.

Parameters
NameDescription
requestPauseCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RegisterCollector(RegisterCollectorRequest, CallOptions)

public virtual Operation RegisterCollector(RegisterCollectorRequest request, CallOptions options)

Registers the given collector.

Parameters
NameDescription
requestRegisterCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RegisterCollector(RegisterCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Registers the given collector.

Parameters
NameDescription
requestRegisterCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RegisterCollectorAsync(RegisterCollectorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RegisterCollectorAsync(RegisterCollectorRequest request, CallOptions options)

Registers the given collector.

Parameters
NameDescription
requestRegisterCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RegisterCollectorAsync(RegisterCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Registers the given collector.

Parameters
NameDescription
requestRegisterCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ResumeCollector(ResumeCollectorRequest, CallOptions)

public virtual Operation ResumeCollector(ResumeCollectorRequest request, CallOptions options)

Resumes the given collector.

Parameters
NameDescription
requestResumeCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ResumeCollector(ResumeCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Resumes the given collector.

Parameters
NameDescription
requestResumeCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ResumeCollectorAsync(ResumeCollectorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResumeCollectorAsync(ResumeCollectorRequest request, CallOptions options)

Resumes the given collector.

Parameters
NameDescription
requestResumeCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ResumeCollectorAsync(ResumeCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Resumes the given collector.

Parameters
NameDescription
requestResumeCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateCollector(UpdateCollectorRequest, CallOptions)

public virtual Operation UpdateCollector(UpdateCollectorRequest request, CallOptions options)

Updates the parameters of a single Collector.

Parameters
NameDescription
requestUpdateCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateCollector(UpdateCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single Collector.

Parameters
NameDescription
requestUpdateCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateCollectorAsync(UpdateCollectorRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateCollectorAsync(UpdateCollectorRequest request, CallOptions options)

Updates the parameters of a single Collector.

Parameters
NameDescription
requestUpdateCollectorRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateCollectorAsync(UpdateCollectorRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single Collector.

Parameters
NameDescription
requestUpdateCollectorRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.