public class CloudFtp.CloudFtpClient : ClientBase<CloudFtp.CloudFtpClient>Reference documentation and code samples for the Cloud FTP v1 API class CloudFtp.CloudFtpClient.
Client for CloudFtp
Namespace
Google.Cloud.Ftp.V1Assembly
Google.Cloud.Ftp.V1.dll
Constructors
CloudFtpClient()
protected CloudFtpClient()Protected parameterless constructor to allow creation of test doubles.
CloudFtpClient(CallInvoker)
public CloudFtpClient(CallInvoker callInvoker)Creates a new client for CloudFtp that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker |
CallInvokerThe callInvoker to use to make remote calls. |
CloudFtpClient(ChannelBase)
public CloudFtpClient(ChannelBase channel)Creates a new client for CloudFtp
| Parameter | |
|---|---|
| Name | Description |
channel |
ChannelBaseThe channel to use to make remote calls. |
CloudFtpClient(ClientBaseConfiguration)
protected CloudFtpClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfigurationThe client configuration. |
Methods
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. |
CreateServer(CreateServerRequest, CallOptions)
public virtual Operation CreateServer(CreateServerRequest request, CallOptions options)Creates a new Server in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateServer(CreateServerRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateServer(CreateServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new Server in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateServerAsync(CreateServerRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateServerAsync(CreateServerRequest request, CallOptions options)Creates a new Server in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateServerAsync(CreateServerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateServerAsync(CreateServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new Server in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateUser(CreateUserRequest, CallOptions)
public virtual Operation CreateUser(CreateUserRequest request, CallOptions options)Creates a new User in a given project and location and Server.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateUser(CreateUserRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation CreateUser(CreateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new User in a given project and location and Server.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
CreateUserAsync(CreateUserRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateUserAsync(CreateUserRequest request, CallOptions options)Creates a new User in a given project and location and Server.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
CreateUserAsync(CreateUserRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateUserAsync(CreateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Creates a new User in a given project and location and Server.
| Parameters | |
|---|---|
| Name | Description |
request |
CreateUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteServer(DeleteServerRequest, CallOptions)
public virtual Operation DeleteServer(DeleteServerRequest request, CallOptions options)Deletes a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteServer(DeleteServerRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteServer(DeleteServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteServerAsync(DeleteServerRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteServerAsync(DeleteServerRequest request, CallOptions options)Deletes a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteServerAsync(DeleteServerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteServerAsync(DeleteServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteUser(DeleteUserRequest, CallOptions)
public virtual Operation DeleteUser(DeleteUserRequest request, CallOptions options)Deletes a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteUser(DeleteUserRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation DeleteUser(DeleteUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
DeleteUserAsync(DeleteUserRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> DeleteUserAsync(DeleteUserRequest request, CallOptions options)Deletes a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
DeleteUserAsync(DeleteUserRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> DeleteUserAsync(DeleteUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Deletes a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
DeleteUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
GetServer(GetServerRequest, CallOptions)
public virtual Server GetServer(GetServerRequest request, CallOptions options)Gets details of a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
GetServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Server |
The response received from the server. |
GetServer(GetServerRequest, Metadata, DateTime?, CancellationToken)
public virtual Server GetServer(GetServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
GetServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Server |
The response received from the server. |
GetServerAsync(GetServerRequest, CallOptions)
public virtual AsyncUnaryCall<Server> GetServerAsync(GetServerRequest request, CallOptions options)Gets details of a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
GetServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServer |
The call object. |
GetServerAsync(GetServerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Server> GetServerAsync(GetServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
GetServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallServer |
The call object. |
GetUser(GetUserRequest, CallOptions)
public virtual User GetUser(GetUserRequest request, CallOptions options)Gets details of a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
GetUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
User |
The response received from the server. |
GetUser(GetUserRequest, Metadata, DateTime?, CancellationToken)
public virtual User GetUser(GetUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
GetUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
User |
The response received from the server. |
GetUserAsync(GetUserRequest, CallOptions)
public virtual AsyncUnaryCall<User> GetUserAsync(GetUserRequest request, CallOptions options)Gets details of a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
GetUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallUser |
The call object. |
GetUserAsync(GetUserRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<User> GetUserAsync(GetUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Gets details of a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
GetUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallUser |
The call object. |
ListServers(ListServersRequest, CallOptions)
public virtual ListServersResponse ListServers(ListServersRequest request, CallOptions options)Lists Servers in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListServersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListServersResponse |
The response received from the server. |
ListServers(ListServersRequest, Metadata, DateTime?, CancellationToken)
public virtual ListServersResponse ListServers(ListServersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists Servers in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListServersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListServersResponse |
The response received from the server. |
ListServersAsync(ListServersRequest, CallOptions)
public virtual AsyncUnaryCall<ListServersResponse> ListServersAsync(ListServersRequest request, CallOptions options)Lists Servers in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListServersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListServersResponse |
The call object. |
ListServersAsync(ListServersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListServersResponse> ListServersAsync(ListServersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists Servers in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListServersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListServersResponse |
The call object. |
ListUsers(ListUsersRequest, CallOptions)
public virtual ListUsersResponse ListUsers(ListUsersRequest request, CallOptions options)Lists Users in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListUsersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListUsersResponse |
The response received from the server. |
ListUsers(ListUsersRequest, Metadata, DateTime?, CancellationToken)
public virtual ListUsersResponse ListUsers(ListUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists Users in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListUsersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListUsersResponse |
The response received from the server. |
ListUsersAsync(ListUsersRequest, CallOptions)
public virtual AsyncUnaryCall<ListUsersResponse> ListUsersAsync(ListUsersRequest request, CallOptions options)Lists Users in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListUsersRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListUsersResponse |
The call object. |
ListUsersAsync(ListUsersRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListUsersResponse> ListUsersAsync(ListUsersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Lists Users in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
ListUsersRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallListUsersResponse |
The call object. |
NewInstance(ClientBaseConfiguration)
protected override CloudFtp.CloudFtpClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
CloudFtpCloudFtpClient |
|
StartServer(StartServerRequest, CallOptions)
public virtual Operation StartServer(StartServerRequest request, CallOptions options)Starts a stopping/stopped Server.
| Parameters | |
|---|---|
| Name | Description |
request |
StartServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
StartServer(StartServerRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation StartServer(StartServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Starts a stopping/stopped Server.
| Parameters | |
|---|---|
| Name | Description |
request |
StartServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
StartServerAsync(StartServerRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> StartServerAsync(StartServerRequest request, CallOptions options)Starts a stopping/stopped Server.
| Parameters | |
|---|---|
| Name | Description |
request |
StartServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
StartServerAsync(StartServerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> StartServerAsync(StartServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Starts a stopping/stopped Server.
| Parameters | |
|---|---|
| Name | Description |
request |
StartServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
StopServer(StopServerRequest, CallOptions)
public virtual Operation StopServer(StopServerRequest request, CallOptions options)Stops an active Server.
| Parameters | |
|---|---|
| Name | Description |
request |
StopServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
StopServer(StopServerRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation StopServer(StopServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Stops an active Server.
| Parameters | |
|---|---|
| Name | Description |
request |
StopServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
StopServerAsync(StopServerRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> StopServerAsync(StopServerRequest request, CallOptions options)Stops an active Server.
| Parameters | |
|---|---|
| Name | Description |
request |
StopServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
StopServerAsync(StopServerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> StopServerAsync(StopServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Stops an active Server.
| Parameters | |
|---|---|
| Name | Description |
request |
StopServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateServer(UpdateServerRequest, CallOptions)
public virtual Operation UpdateServer(UpdateServerRequest request, CallOptions options)Updates the parameters of a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateServer(UpdateServerRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateServer(UpdateServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the parameters of a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateServerAsync(UpdateServerRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateServerAsync(UpdateServerRequest request, CallOptions options)Updates the parameters of a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateServerRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateServerAsync(UpdateServerRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateServerAsync(UpdateServerRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the parameters of a single Server.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateServerRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateUser(UpdateUserRequest, CallOptions)
public virtual Operation UpdateUser(UpdateUserRequest request, CallOptions options)Updates the parameters of a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateUser(UpdateUserRequest, Metadata, DateTime?, CancellationToken)
public virtual Operation UpdateUser(UpdateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the parameters of a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation |
The response received from the server. |
UpdateUserAsync(UpdateUserRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateUserAsync(UpdateUserRequest request, CallOptions options)Updates the parameters of a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateUserRequestThe request to send to the server. |
options |
CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |
UpdateUserAsync(UpdateUserRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateUserAsync(UpdateUserRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)Updates the parameters of a single User.
| Parameters | |
|---|---|
| Name | Description |
request |
UpdateUserRequestThe request to send to the server. |
headers |
MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline |
System.DateTimeAn optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken |
CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCallOperation |
The call object. |