Parallelstore v1 API - Class Parallelstore.ParallelstoreClient (1.1.0)

public class Parallelstore.ParallelstoreClient : ClientBase<Parallelstore.ParallelstoreClient>

Reference documentation and code samples for the Parallelstore v1 API class Parallelstore.ParallelstoreClient.

Client for Parallelstore

Inheritance

object > ClientBase > ClientBase Parallelstore ParallelstoreClient > Parallelstore.ParallelstoreClient

Inherited Members

ClientBase<Parallelstore.ParallelstoreClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Parallelstore.V1

Assembly

Google.Cloud.Parallelstore.V1.dll

Constructors

ParallelstoreClient()

protected ParallelstoreClient()

Protected parameterless constructor to allow creation of test doubles.

ParallelstoreClient(CallInvoker)

public ParallelstoreClient(CallInvoker callInvoker)

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

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

ParallelstoreClient(ChannelBase)

public ParallelstoreClient(ChannelBase channel)

Creates a new client for Parallelstore

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

ParallelstoreClient(ClientBaseConfiguration)

protected ParallelstoreClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CreateInstance(CreateInstanceRequest, CallOptions)

public virtual Operation CreateInstance(CreateInstanceRequest request, CallOptions options)

Creates a Parallelstore instance in a given project and location.

Parameters
Name	Description
`request`	`CreateInstanceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateInstance(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Parallelstore instance in a given project and location.

Parameters
Name	Description
`request`	`CreateInstanceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

CreateInstanceAsync(CreateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateInstanceAsync(CreateInstanceRequest request, CallOptions options)

Creates a Parallelstore instance in a given project and location.

Parameters
Name	Description
`request`	`CreateInstanceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

CreateInstanceAsync(CreateInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Parallelstore instance in a given project and location.

Parameters
Name	Description
`request`	`CreateInstanceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

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.

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.

DeleteInstance(DeleteInstanceRequest, CallOptions)

public virtual Operation DeleteInstance(DeleteInstanceRequest request, CallOptions options)

Deletes a single instance.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteInstance(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single instance.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

DeleteInstanceAsync(DeleteInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteInstanceAsync(DeleteInstanceRequest request, CallOptions options)

Deletes a single instance.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

DeleteInstanceAsync(DeleteInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a single instance.

Parameters
Name	Description
`request`	`DeleteInstanceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

ExportData(ExportDataRequest, CallOptions)

public virtual Operation ExportData(ExportDataRequest request, CallOptions options)

Copies data from Parallelstore to Cloud Storage.

Parameters
Name	Description
`request`	`ExportDataRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

ExportData(ExportDataRequest, Metadata, DateTime?, CancellationToken)

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

Copies data from Parallelstore to Cloud Storage.

Parameters
Name	Description
`request`	`ExportDataRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

ExportDataAsync(ExportDataRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportDataAsync(ExportDataRequest request, CallOptions options)

Copies data from Parallelstore to Cloud Storage.

Parameters
Name	Description
`request`	`ExportDataRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

ExportDataAsync(ExportDataRequest, Metadata, DateTime?, CancellationToken)

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

Copies data from Parallelstore to Cloud Storage.

Parameters
Name	Description
`request`	`ExportDataRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

GetInstance(GetInstanceRequest, CallOptions)

public virtual Instance GetInstance(GetInstanceRequest request, CallOptions options)

Gets details of a single instance.

Parameters
Name	Description
`request`	`GetInstanceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Instance`	The response received from the server.

GetInstance(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual Instance GetInstance(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single instance.

Parameters
Name	Description
`request`	`GetInstanceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`Instance`	The response received from the server.

GetInstanceAsync(GetInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, CallOptions options)

Gets details of a single instance.

Parameters
Name	Description
`request`	`GetInstanceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallInstance`	The call object.

GetInstanceAsync(GetInstanceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Instance> GetInstanceAsync(GetInstanceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single instance.

Parameters
Name	Description
`request`	`GetInstanceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallInstance`	The call object.

ImportData(ImportDataRequest, CallOptions)

public virtual Operation ImportData(ImportDataRequest request, CallOptions options)

Copies data from Cloud Storage to Parallelstore.

Parameters
Name	Description
`request`	`ImportDataRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

ImportData(ImportDataRequest, Metadata, DateTime?, CancellationToken)

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

Copies data from Cloud Storage to Parallelstore.

Parameters
Name	Description
`request`	`ImportDataRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

ImportDataAsync(ImportDataRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportDataAsync(ImportDataRequest request, CallOptions options)

Copies data from Cloud Storage to Parallelstore.

Parameters
Name	Description
`request`	`ImportDataRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

ImportDataAsync(ImportDataRequest, Metadata, DateTime?, CancellationToken)

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

Copies data from Cloud Storage to Parallelstore.

Parameters
Name	Description
`request`	`ImportDataRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

ListInstances(ListInstancesRequest, CallOptions)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, CallOptions options)

Lists all instances in a given project and location.

Parameters
Name	Description
`request`	`ListInstancesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListInstancesResponse`	The response received from the server.

ListInstances(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListInstancesResponse ListInstances(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all instances in a given project and location.

Parameters
Name	Description
`request`	`ListInstancesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`ListInstancesResponse`	The response received from the server.

ListInstancesAsync(ListInstancesRequest, CallOptions)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, CallOptions options)

Lists all instances in a given project and location.

Parameters
Name	Description
`request`	`ListInstancesRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListInstancesResponse`	The call object.

ListInstancesAsync(ListInstancesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListInstancesResponse> ListInstancesAsync(ListInstancesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all instances in a given project and location.

Parameters
Name	Description
`request`	`ListInstancesRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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
`AsyncUnaryCallListInstancesResponse`	The call object.

NewInstance(ClientBaseConfiguration)

protected override Parallelstore.ParallelstoreClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`ParallelstoreParallelstoreClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Parallelstore.V1.Parallelstore.ParallelstoreClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateInstance(UpdateInstanceRequest, CallOptions)

public virtual Operation UpdateInstance(UpdateInstanceRequest request, CallOptions options)

Updates the parameters of a single instance.

Parameters
Name	Description
`request`	`UpdateInstanceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateInstance(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single instance.

Parameters
Name	Description
`request`	`UpdateInstanceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.

UpdateInstanceAsync(UpdateInstanceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateInstanceAsync(UpdateInstanceRequest request, CallOptions options)

Updates the parameters of a single instance.

Parameters
Name	Description
`request`	`UpdateInstanceRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallOperation`	The call object.

UpdateInstanceAsync(UpdateInstanceRequest, Metadata, DateTime?, CancellationToken)

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

Updates the parameters of a single instance.

Parameters
Name	Description
`request`	`UpdateInstanceRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`System.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.