Cloud FTP v1 API - Class CloudFtpClient (1.0.0-beta01)

public abstract class CloudFtpClient

Reference documentation and code samples for the Cloud FTP v1 API class CloudFtpClient.

CloudFtp client wrapper, for convenient use.

Inheritance

object > CloudFtpClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

CloudFtpClientImpl

Namespace

Google.Cloud.Ftp.V1

Assembly

Google.Cloud.Ftp.V1.dll

Remarks

Service describing handlers for resources

Properties

CreateServerOperationsClient

public virtual OperationsClient CreateServerOperationsClient { get; }

The long-running operations client for CreateServer.

Property Value
Type	Description
OperationsClient

CreateUserOperationsClient

public virtual OperationsClient CreateUserOperationsClient { get; }

The long-running operations client for CreateUser.

Property Value
Type	Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the CloudFtp service, which is a host of "ftp.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default CloudFtp scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default CloudFtp scopes are:

• https://www.googleapis.com/auth/cloud-platform

DeleteServerOperationsClient

public virtual OperationsClient DeleteServerOperationsClient { get; }

The long-running operations client for DeleteServer.

Property Value
Type	Description
OperationsClient

DeleteUserOperationsClient

public virtual OperationsClient DeleteUserOperationsClient { get; }

The long-running operations client for DeleteUser.

Property Value
Type	Description
OperationsClient

GrpcClient

public virtual CloudFtp.CloudFtpClient GrpcClient { get; }

The underlying gRPC CloudFtp client

Property Value
Type	Description
CloudFtpCloudFtpClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

StartServerOperationsClient

public virtual OperationsClient StartServerOperationsClient { get; }

The long-running operations client for StartServer.

Property Value
Type	Description
OperationsClient

StopServerOperationsClient

public virtual OperationsClient StopServerOperationsClient { get; }

The long-running operations client for StopServer.

Property Value
Type	Description
OperationsClient

UpdateServerOperationsClient

public virtual OperationsClient UpdateServerOperationsClient { get; }

The long-running operations client for UpdateServer.

Property Value
Type	Description
OperationsClient

UpdateUserOperationsClient

public virtual OperationsClient UpdateUserOperationsClient { get; }

The long-running operations client for UpdateUser.

Property Value
Type	Description
OperationsClient

Methods

Create()

public static CloudFtpClient Create()

Synchronously creates a CloudFtpClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudFtpClientBuilder.

Returns
Type	Description
CloudFtpClient	The created CloudFtpClient.

CreateAsync(CancellationToken)

public static Task<CloudFtpClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a CloudFtpClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use CloudFtpClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskCloudFtpClient	The task representing the created CloudFtpClient.

CreateServer(LocationName, Server, string, CallSettings)

public virtual Operation<Server, OperationMetadata> CreateServer(LocationName parent, Server server, string serverId, CallSettings callSettings = null)

Creates a new Server in a given project and location.

Parameters
Name	Description
parent	LocationName Required. Value for parent.
server	Server Required. The resource being created
serverId	string Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Server server = new Server();
string serverId = "";
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.CreateServer(parent, server, serverId);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceCreateServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateServer(CreateServerRequest, CallSettings)

public virtual Operation<Server, OperationMetadata> CreateServer(CreateServerRequest request, CallSettings callSettings = null)

Creates a new Server in a given project and location.

Parameters
Name	Description
request	CreateServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
CreateServerRequest request = new CreateServerRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ServerId = "",
    Server = new Server(),
    RequestId = "",
};
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.CreateServer(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceCreateServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateServer(string, Server, string, CallSettings)

public virtual Operation<Server, OperationMetadata> CreateServer(string parent, Server server, string serverId, CallSettings callSettings = null)

Creates a new Server in a given project and location.

Parameters
Name	Description
parent	string Required. Value for parent.
server	Server Required. The resource being created
serverId	string Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Server server = new Server();
string serverId = "";
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.CreateServer(parent, server, serverId);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceCreateServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateServerAsync(LocationName, Server, string, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> CreateServerAsync(LocationName parent, Server server, string serverId, CallSettings callSettings = null)

Creates a new Server in a given project and location.

Parameters
Name	Description
parent	LocationName Required. Value for parent.
server	Server Required. The resource being created
serverId	string Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Server server = new Server();
string serverId = "";
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.CreateServerAsync(parent, server, serverId);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateServerAsync(LocationName, Server, string, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> CreateServerAsync(LocationName parent, Server server, string serverId, CancellationToken cancellationToken)

Creates a new Server in a given project and location.

Parameters
Name	Description
parent	LocationName Required. Value for parent.
server	Server Required. The resource being created
serverId	string Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
Server server = new Server();
string serverId = "";
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.CreateServerAsync(parent, server, serverId);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateServerAsync(CreateServerRequest, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> CreateServerAsync(CreateServerRequest request, CallSettings callSettings = null)

Creates a new Server in a given project and location.

Parameters
Name	Description
request	CreateServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
CreateServerRequest request = new CreateServerRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ServerId = "",
    Server = new Server(),
    RequestId = "",
};
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.CreateServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateServerAsync(CreateServerRequest, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> CreateServerAsync(CreateServerRequest request, CancellationToken cancellationToken)

Creates a new Server in a given project and location.

Parameters
Name	Description
request	CreateServerRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
CreateServerRequest request = new CreateServerRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ServerId = "",
    Server = new Server(),
    RequestId = "",
};
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.CreateServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateServerAsync(string, Server, string, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> CreateServerAsync(string parent, Server server, string serverId, CallSettings callSettings = null)

Creates a new Server in a given project and location.

Parameters
Name	Description
parent	string Required. Value for parent.
server	Server Required. The resource being created
serverId	string Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Server server = new Server();
string serverId = "";
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.CreateServerAsync(parent, server, serverId);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateServerAsync(string, Server, string, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> CreateServerAsync(string parent, Server server, string serverId, CancellationToken cancellationToken)

Creates a new Server in a given project and location.

Parameters
Name	Description
parent	string Required. Value for parent.
server	Server Required. The resource being created
serverId	string Required. A unique ID for the server. Must start with a lowercase letter, and end with a lowercase letter or number. Can contain lowercase letters, numbers, and hyphens. Maximum length is 30 characters.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
Server server = new Server();
string serverId = "";
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.CreateServerAsync(parent, server, serverId);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

CreateUser(CreateUserRequest, CallSettings)

public virtual Operation<User, OperationMetadata> CreateUser(CreateUserRequest request, CallSettings callSettings = null)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
request	CreateUserRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUserOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
CreateUserRequest request = new CreateUserRequest
{
    ParentAsServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
    UserId = "",
    User = new User(),
    RequestId = "",
};
// Make the request
Operation<User, OperationMetadata> response = cloudFtpClient.CreateUser(request);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceCreateUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

CreateUser(ServerName, User, string, CallSettings)

public virtual Operation<User, OperationMetadata> CreateUser(ServerName parent, User user, string userId, CallSettings callSettings = null)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
parent	ServerName Required. Value for parent.
user	User Required. The resource being created
userId	string Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUserOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
ServerName parent = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
User user = new User();
string userId = "";
// Make the request
Operation<User, OperationMetadata> response = cloudFtpClient.CreateUser(parent, user, userId);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceCreateUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

CreateUser(string, User, string, CallSettings)

public virtual Operation<User, OperationMetadata> CreateUser(string parent, User user, string userId, CallSettings callSettings = null)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
parent	string Required. Value for parent.
user	User Required. The resource being created
userId	string Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUserOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
User user = new User();
string userId = "";
// Make the request
Operation<User, OperationMetadata> response = cloudFtpClient.CreateUser(parent, user, userId);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceCreateUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

CreateUserAsync(CreateUserRequest, CallSettings)

public virtual Task<Operation<User, OperationMetadata>> CreateUserAsync(CreateUserRequest request, CallSettings callSettings = null)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
request	CreateUserRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
CreateUserRequest request = new CreateUserRequest
{
    ParentAsServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
    UserId = "",
    User = new User(),
    RequestId = "",
};
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.CreateUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

CreateUserAsync(CreateUserRequest, CancellationToken)

public virtual Task<Operation<User, OperationMetadata>> CreateUserAsync(CreateUserRequest request, CancellationToken cancellationToken)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
request	CreateUserRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
CreateUserRequest request = new CreateUserRequest
{
    ParentAsServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
    UserId = "",
    User = new User(),
    RequestId = "",
};
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.CreateUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

CreateUserAsync(ServerName, User, string, CallSettings)

public virtual Task<Operation<User, OperationMetadata>> CreateUserAsync(ServerName parent, User user, string userId, CallSettings callSettings = null)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
parent	ServerName Required. Value for parent.
user	User Required. The resource being created
userId	string Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName parent = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
User user = new User();
string userId = "";
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.CreateUserAsync(parent, user, userId);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

CreateUserAsync(ServerName, User, string, CancellationToken)

public virtual Task<Operation<User, OperationMetadata>> CreateUserAsync(ServerName parent, User user, string userId, CancellationToken cancellationToken)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
parent	ServerName Required. Value for parent.
user	User Required. The resource being created
userId	string Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName parent = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
User user = new User();
string userId = "";
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.CreateUserAsync(parent, user, userId);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

CreateUserAsync(string, User, string, CallSettings)

public virtual Task<Operation<User, OperationMetadata>> CreateUserAsync(string parent, User user, string userId, CallSettings callSettings = null)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
parent	string Required. Value for parent.
user	User Required. The resource being created
userId	string Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
User user = new User();
string userId = "";
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.CreateUserAsync(parent, user, userId);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

CreateUserAsync(string, User, string, CancellationToken)

public virtual Task<Operation<User, OperationMetadata>> CreateUserAsync(string parent, User user, string userId, CancellationToken cancellationToken)

Creates a new User in a given project and location and Server.

Parameters
Name	Description
parent	string Required. Value for parent.
user	User Required. The resource being created
userId	string Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
User user = new User();
string userId = "";
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.CreateUserAsync(parent, user, userId);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceCreateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

DeleteServer(DeleteServerRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteServer(DeleteServerRequest request, CallSettings callSettings = null)

Deletes a single Server.

Parameters
Name	Description
request	DeleteServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
DeleteServerRequest request = new DeleteServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = cloudFtpClient.DeleteServer(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceDeleteServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteServer(ServerName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteServer(ServerName name, CallSettings callSettings = null)

Deletes a single Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Empty, OperationMetadata> response = cloudFtpClient.DeleteServer(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceDeleteServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteServer(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteServer(string name, CallSettings callSettings = null)

Deletes a single Server.

Parameters
Name	Description
name	string Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Empty, OperationMetadata> response = cloudFtpClient.DeleteServer(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceDeleteServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteServerAsync(DeleteServerRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteServerAsync(DeleteServerRequest request, CallSettings callSettings = null)

Deletes a single Server.

Parameters
Name	Description
request	DeleteServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
DeleteServerRequest request = new DeleteServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteServerAsync(DeleteServerRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteServerAsync(DeleteServerRequest request, CancellationToken cancellationToken)

Deletes a single Server.

Parameters
Name	Description
request	DeleteServerRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
DeleteServerRequest request = new DeleteServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteServerAsync(ServerName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteServerAsync(ServerName name, CallSettings callSettings = null)

Deletes a single Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteServerAsync(ServerName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteServerAsync(ServerName name, CancellationToken cancellationToken)

Deletes a single Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteServerAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteServerAsync(string name, CallSettings callSettings = null)

Deletes a single Server.

Parameters
Name	Description
name	string Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteServerAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteServerAsync(string name, CancellationToken cancellationToken)

Deletes a single Server.

Parameters
Name	Description
name	string Required. Name of the resource
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUser(DeleteUserRequest, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteUser(DeleteUserRequest request, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
DeleteUserRequest request = new DeleteUserRequest
{
    UserName = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]"),
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = cloudFtpClient.DeleteUser(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceDeleteUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUser(UserName, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteUser(UserName name, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name	Description
name	UserName Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
UserName name = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]");
// Make the request
Operation<Empty, OperationMetadata> response = cloudFtpClient.DeleteUser(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceDeleteUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUser(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> DeleteUser(string name, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name	Description
name	string Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]/users/[USER]";
// Make the request
Operation<Empty, OperationMetadata> response = cloudFtpClient.DeleteUser(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceDeleteUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUserAsync(DeleteUserRequest, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteUserAsync(DeleteUserRequest request, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
DeleteUserRequest request = new DeleteUserRequest
{
    UserName = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]"),
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUserAsync(DeleteUserRequest, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteUserAsync(DeleteUserRequest request, CancellationToken cancellationToken)

Deletes a single User.

Parameters
Name	Description
request	DeleteUserRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
DeleteUserRequest request = new DeleteUserRequest
{
    UserName = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]"),
    Force = false,
};
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUserAsync(UserName, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteUserAsync(UserName name, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name	Description
name	UserName Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
UserName name = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteUserAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUserAsync(UserName, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteUserAsync(UserName name, CancellationToken cancellationToken)

Deletes a single User.

Parameters
Name	Description
name	UserName Required. Name of the resource
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
UserName name = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]");
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteUserAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUserAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteUserAsync(string name, CallSettings callSettings = null)

Deletes a single User.

Parameters
Name	Description
name	string Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]/users/[USER]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteUserAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

DeleteUserAsync(string, CancellationToken)

public virtual Task<Operation<Empty, OperationMetadata>> DeleteUserAsync(string name, CancellationToken cancellationToken)

Deletes a single User.

Parameters
Name	Description
name	string Required. Name of the resource
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]/users/[USER]";
// Make the request
Operation<Empty, OperationMetadata> response = await cloudFtpClient.DeleteUserAsync(name);

// Poll until the returned long-running operation is complete
Operation<Empty, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Empty result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Empty, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceDeleteUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Empty retrievedResult = retrievedResponse.Result;
}

GetServer(GetServerRequest, CallSettings)

public virtual Server GetServer(GetServerRequest request, CallSettings callSettings = null)

Gets details of a single Server.

Parameters
Name	Description
request	GetServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Server	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
GetServerRequest request = new GetServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
    View = ServerView.Unspecified,
};
// Make the request
Server response = cloudFtpClient.GetServer(request);

GetServer(ServerName, CallSettings)

public virtual Server GetServer(ServerName name, CallSettings callSettings = null)

Gets details of a single Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Server	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Server response = cloudFtpClient.GetServer(name);

GetServer(string, CallSettings)

public virtual Server GetServer(string name, CallSettings callSettings = null)

Gets details of a single Server.

Parameters
Name	Description
name	string Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Server	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Server response = cloudFtpClient.GetServer(name);

GetServerAsync(GetServerRequest, CallSettings)

public virtual Task<Server> GetServerAsync(GetServerRequest request, CallSettings callSettings = null)

Gets details of a single Server.

Parameters
Name	Description
request	GetServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskServer	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
GetServerRequest request = new GetServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
    View = ServerView.Unspecified,
};
// Make the request
Server response = await cloudFtpClient.GetServerAsync(request);

GetServerAsync(GetServerRequest, CancellationToken)

public virtual Task<Server> GetServerAsync(GetServerRequest request, CancellationToken cancellationToken)

Gets details of a single Server.

Parameters
Name	Description
request	GetServerRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskServer	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
GetServerRequest request = new GetServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
    View = ServerView.Unspecified,
};
// Make the request
Server response = await cloudFtpClient.GetServerAsync(request);

GetServerAsync(ServerName, CallSettings)

public virtual Task<Server> GetServerAsync(ServerName name, CallSettings callSettings = null)

Gets details of a single Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskServer	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Server response = await cloudFtpClient.GetServerAsync(name);

GetServerAsync(ServerName, CancellationToken)

public virtual Task<Server> GetServerAsync(ServerName name, CancellationToken cancellationToken)

Gets details of a single Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskServer	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Server response = await cloudFtpClient.GetServerAsync(name);

GetServerAsync(string, CallSettings)

public virtual Task<Server> GetServerAsync(string name, CallSettings callSettings = null)

Gets details of a single Server.

Parameters
Name	Description
name	string Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskServer	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Server response = await cloudFtpClient.GetServerAsync(name);

GetServerAsync(string, CancellationToken)

public virtual Task<Server> GetServerAsync(string name, CancellationToken cancellationToken)

Gets details of a single Server.

Parameters
Name	Description
name	string Required. Name of the resource
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskServer	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Server response = await cloudFtpClient.GetServerAsync(name);

GetUser(GetUserRequest, CallSettings)

public virtual User GetUser(GetUserRequest request, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
User	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
GetUserRequest request = new GetUserRequest
{
    UserName = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]"),
    View = UserView.Unspecified,
};
// Make the request
User response = cloudFtpClient.GetUser(request);

GetUser(UserName, CallSettings)

public virtual User GetUser(UserName name, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name	Description
name	UserName Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
User	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
UserName name = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]");
// Make the request
User response = cloudFtpClient.GetUser(name);

GetUser(string, CallSettings)

public virtual User GetUser(string name, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name	Description
name	string Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
User	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]/users/[USER]";
// Make the request
User response = cloudFtpClient.GetUser(name);

GetUserAsync(GetUserRequest, CallSettings)

public virtual Task<User> GetUserAsync(GetUserRequest request, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUser	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
GetUserRequest request = new GetUserRequest
{
    UserName = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]"),
    View = UserView.Unspecified,
};
// Make the request
User response = await cloudFtpClient.GetUserAsync(request);

GetUserAsync(GetUserRequest, CancellationToken)

public virtual Task<User> GetUserAsync(GetUserRequest request, CancellationToken cancellationToken)

Gets details of a single User.

Parameters
Name	Description
request	GetUserRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskUser	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
GetUserRequest request = new GetUserRequest
{
    UserName = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]"),
    View = UserView.Unspecified,
};
// Make the request
User response = await cloudFtpClient.GetUserAsync(request);

GetUserAsync(UserName, CallSettings)

public virtual Task<User> GetUserAsync(UserName name, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name	Description
name	UserName Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUser	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
UserName name = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]");
// Make the request
User response = await cloudFtpClient.GetUserAsync(name);

GetUserAsync(UserName, CancellationToken)

public virtual Task<User> GetUserAsync(UserName name, CancellationToken cancellationToken)

Gets details of a single User.

Parameters
Name	Description
name	UserName Required. Name of the resource
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskUser	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
UserName name = UserName.FromProjectLocationServerUser("[PROJECT]", "[LOCATION]", "[SERVER]", "[USER]");
// Make the request
User response = await cloudFtpClient.GetUserAsync(name);

GetUserAsync(string, CallSettings)

public virtual Task<User> GetUserAsync(string name, CallSettings callSettings = null)

Gets details of a single User.

Parameters
Name	Description
name	string Required. Name of the resource
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskUser	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]/users/[USER]";
// Make the request
User response = await cloudFtpClient.GetUserAsync(name);

GetUserAsync(string, CancellationToken)

public virtual Task<User> GetUserAsync(string name, CancellationToken cancellationToken)

Gets details of a single User.

Parameters
Name	Description
name	string Required. Name of the resource
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskUser	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]/users/[USER]";
// Make the request
User response = await cloudFtpClient.GetUserAsync(name);

ListServers(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListServersResponse, Server> ListServers(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Servers in a given project and location.

Parameters
Name	Description
parent	LocationName Required. Parent value for ListServersRequest
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListServersResponseServer	A pageable sequence of Server resources.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListServersResponse, Server> response = cloudFtpClient.ListServers(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Server item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListServersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Server item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Server> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Server item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServers(ListServersRequest, CallSettings)

public virtual PagedEnumerable<ListServersResponse, Server> ListServers(ListServersRequest request, CallSettings callSettings = null)

Lists Servers in a given project and location.

Parameters
Name	Description
request	ListServersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListServersResponseServer	A pageable sequence of Server resources.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
ListServersRequest request = new ListServersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    View = ServerView.Unspecified,
};
// Make the request
PagedEnumerable<ListServersResponse, Server> response = cloudFtpClient.ListServers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Server item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListServersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Server item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Server> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Server item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServers(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListServersResponse, Server> ListServers(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Servers in a given project and location.

Parameters
Name	Description
parent	string Required. Parent value for ListServersRequest
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListServersResponseServer	A pageable sequence of Server resources.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListServersResponse, Server> response = cloudFtpClient.ListServers(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Server item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListServersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Server item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Server> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Server item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServersAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListServersResponse, Server> ListServersAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Servers in a given project and location.

Parameters
Name	Description
parent	LocationName Required. Parent value for ListServersRequest
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListServersResponseServer	A pageable asynchronous sequence of Server resources.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListServersResponse, Server> response = cloudFtpClient.ListServersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Server item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListServersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Server item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Server> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Server item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServersAsync(ListServersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListServersResponse, Server> ListServersAsync(ListServersRequest request, CallSettings callSettings = null)

Lists Servers in a given project and location.

Parameters
Name	Description
request	ListServersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListServersResponseServer	A pageable asynchronous sequence of Server resources.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ListServersRequest request = new ListServersRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
    OrderBy = "",
    View = ServerView.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListServersResponse, Server> response = cloudFtpClient.ListServersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Server item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListServersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Server item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Server> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Server item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListServersAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListServersResponse, Server> ListServersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Servers in a given project and location.

Parameters
Name	Description
parent	string Required. Parent value for ListServersRequest
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListServersResponseServer	A pageable asynchronous sequence of Server resources.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListServersResponse, Server> response = cloudFtpClient.ListServersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (Server item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListServersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Server item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<Server> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (Server item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUsers(ListUsersRequest, CallSettings)

public virtual PagedEnumerable<ListUsersResponse, User> ListUsers(ListUsersRequest request, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name	Description
request	ListUsersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListUsersResponseUser	A pageable sequence of User resources.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
ListUsersRequest request = new ListUsersRequest
{
    ParentAsServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
    Filter = "",
    OrderBy = "",
    View = UserView.Unspecified,
};
// Make the request
PagedEnumerable<ListUsersResponse, User> response = cloudFtpClient.ListUsers(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (User item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (User item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<User> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (User item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUsers(ServerName, string, int?, CallSettings)

public virtual PagedEnumerable<ListUsersResponse, User> ListUsers(ServerName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name	Description
parent	ServerName Required. Parent value for ListUsersRequest
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListUsersResponseUser	A pageable sequence of User resources.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
ServerName parent = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
PagedEnumerable<ListUsersResponse, User> response = cloudFtpClient.ListUsers(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (User item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (User item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<User> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (User item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUsers(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListUsersResponse, User> ListUsers(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name	Description
parent	string Required. Parent value for ListUsersRequest
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListUsersResponseUser	A pageable sequence of User resources.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
PagedEnumerable<ListUsersResponse, User> response = cloudFtpClient.ListUsers(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (User item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (ListUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (User item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<User> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (User item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUsersAsync(ListUsersRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListUsersResponse, User> ListUsersAsync(ListUsersRequest request, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name	Description
request	ListUsersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListUsersResponseUser	A pageable asynchronous sequence of User resources.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ListUsersRequest request = new ListUsersRequest
{
    ParentAsServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
    Filter = "",
    OrderBy = "",
    View = UserView.Unspecified,
};
// Make the request
PagedAsyncEnumerable<ListUsersResponse, User> response = cloudFtpClient.ListUsersAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await foreach (User item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (User item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<User> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (User item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUsersAsync(ServerName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListUsersResponse, User> ListUsersAsync(ServerName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name	Description
parent	ServerName Required. Parent value for ListUsersRequest
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListUsersResponseUser	A pageable asynchronous sequence of User resources.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName parent = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
PagedAsyncEnumerable<ListUsersResponse, User> response = cloudFtpClient.ListUsersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (User item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (User item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<User> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (User item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ListUsersAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListUsersResponse, User> ListUsersAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists Users in a given project and location.

Parameters
Name	Description
parent	string Required. Parent value for ListUsersRequest
pageToken	string The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize	int The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListUsersResponseUser	A pageable asynchronous sequence of User resources.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
PagedAsyncEnumerable<ListUsersResponse, User> response = cloudFtpClient.ListUsersAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await foreach (User item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
await foreach (ListUsersResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (User item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<User> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (User item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

PollOnceCreateServer(string, CallSettings)

public virtual Operation<Server, OperationMetadata> PollOnceCreateServer(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The result of polling the operation.

PollOnceCreateServerAsync(string, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> PollOnceCreateServerAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A task representing the result of polling the operation.

PollOnceCreateUser(string, CallSettings)

public virtual Operation<User, OperationMetadata> PollOnceCreateUser(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of CreateUser.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUserOperationMetadata	The result of polling the operation.

PollOnceCreateUserAsync(string, CallSettings)

public virtual Task<Operation<User, OperationMetadata>> PollOnceCreateUserAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of CreateUser.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUserOperationMetadata	A task representing the result of polling the operation.

PollOnceDeleteServer(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteServer(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The result of polling the operation.

PollOnceDeleteServerAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteServerAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A task representing the result of polling the operation.

PollOnceDeleteUser(string, CallSettings)

public virtual Operation<Empty, OperationMetadata> PollOnceDeleteUser(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of DeleteUser.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationEmptyOperationMetadata	The result of polling the operation.

PollOnceDeleteUserAsync(string, CallSettings)

public virtual Task<Operation<Empty, OperationMetadata>> PollOnceDeleteUserAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of DeleteUser.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationEmptyOperationMetadata	A task representing the result of polling the operation.

PollOnceStartServer(string, CallSettings)

public virtual Operation<Server, OperationMetadata> PollOnceStartServer(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of StartServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The result of polling the operation.

PollOnceStartServerAsync(string, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> PollOnceStartServerAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of StartServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A task representing the result of polling the operation.

PollOnceStopServer(string, CallSettings)

public virtual Operation<Server, OperationMetadata> PollOnceStopServer(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of StopServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The result of polling the operation.

PollOnceStopServerAsync(string, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> PollOnceStopServerAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of StopServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A task representing the result of polling the operation.

PollOnceUpdateServer(string, CallSettings)

public virtual Operation<Server, OperationMetadata> PollOnceUpdateServer(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The result of polling the operation.

PollOnceUpdateServerAsync(string, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> PollOnceUpdateServerAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateServer.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A task representing the result of polling the operation.

PollOnceUpdateUser(string, CallSettings)

public virtual Operation<User, OperationMetadata> PollOnceUpdateUser(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of UpdateUser.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUserOperationMetadata	The result of polling the operation.

PollOnceUpdateUserAsync(string, CallSettings)

public virtual Task<Operation<User, OperationMetadata>> PollOnceUpdateUserAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of UpdateUser.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUserOperationMetadata	A task representing the result of polling the operation.

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

StartServer(ServerName, CallSettings)

public virtual Operation<Server, OperationMetadata> StartServer(ServerName name, CallSettings callSettings = null)

Starts a stopping/stopped Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource Format: projects/{project}/locations/{location}/servers/{server}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.StartServer(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceStartServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StartServer(StartServerRequest, CallSettings)

public virtual Operation<Server, OperationMetadata> StartServer(StartServerRequest request, CallSettings callSettings = null)

Starts a stopping/stopped Server.

Parameters
Name	Description
request	StartServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
StartServerRequest request = new StartServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.StartServer(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceStartServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StartServer(string, CallSettings)

public virtual Operation<Server, OperationMetadata> StartServer(string name, CallSettings callSettings = null)

Starts a stopping/stopped Server.

Parameters
Name	Description
name	string Required. Name of the resource Format: projects/{project}/locations/{location}/servers/{server}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.StartServer(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceStartServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StartServerAsync(ServerName, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> StartServerAsync(ServerName name, CallSettings callSettings = null)

Starts a stopping/stopped Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource Format: projects/{project}/locations/{location}/servers/{server}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StartServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStartServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StartServerAsync(ServerName, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> StartServerAsync(ServerName name, CancellationToken cancellationToken)

Starts a stopping/stopped Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource Format: projects/{project}/locations/{location}/servers/{server}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StartServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStartServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StartServerAsync(StartServerRequest, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> StartServerAsync(StartServerRequest request, CallSettings callSettings = null)

Starts a stopping/stopped Server.

Parameters
Name	Description
request	StartServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
StartServerRequest request = new StartServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StartServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStartServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StartServerAsync(StartServerRequest, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> StartServerAsync(StartServerRequest request, CancellationToken cancellationToken)

Starts a stopping/stopped Server.

Parameters
Name	Description
request	StartServerRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
StartServerRequest request = new StartServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StartServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStartServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StartServerAsync(string, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> StartServerAsync(string name, CallSettings callSettings = null)

Starts a stopping/stopped Server.

Parameters
Name	Description
name	string Required. Name of the resource Format: projects/{project}/locations/{location}/servers/{server}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StartServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStartServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StartServerAsync(string, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> StartServerAsync(string name, CancellationToken cancellationToken)

Starts a stopping/stopped Server.

Parameters
Name	Description
name	string Required. Name of the resource Format: projects/{project}/locations/{location}/servers/{server}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StartServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStartServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServer(ServerName, CallSettings)

public virtual Operation<Server, OperationMetadata> StopServer(ServerName name, CallSettings callSettings = null)

Stops an active Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource. Format: projects/{project}/locations/{location}/servers/{server}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.StopServer(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceStopServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServer(StopServerRequest, CallSettings)

public virtual Operation<Server, OperationMetadata> StopServer(StopServerRequest request, CallSettings callSettings = null)

Stops an active Server.

Parameters
Name	Description
request	StopServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
StopServerRequest request = new StopServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.StopServer(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceStopServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServer(string, CallSettings)

public virtual Operation<Server, OperationMetadata> StopServer(string name, CallSettings callSettings = null)

Stops an active Server.

Parameters
Name	Description
name	string Required. Name of the resource. Format: projects/{project}/locations/{location}/servers/{server}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.StopServer(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceStopServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServerAsync(ServerName, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> StopServerAsync(ServerName name, CallSettings callSettings = null)

Stops an active Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource. Format: projects/{project}/locations/{location}/servers/{server}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StopServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStopServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServerAsync(ServerName, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> StopServerAsync(ServerName name, CancellationToken cancellationToken)

Stops an active Server.

Parameters
Name	Description
name	ServerName Required. Name of the resource. Format: projects/{project}/locations/{location}/servers/{server}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
ServerName name = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]");
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StopServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStopServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServerAsync(StopServerRequest, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> StopServerAsync(StopServerRequest request, CallSettings callSettings = null)

Stops an active Server.

Parameters
Name	Description
request	StopServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
StopServerRequest request = new StopServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StopServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStopServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServerAsync(StopServerRequest, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> StopServerAsync(StopServerRequest request, CancellationToken cancellationToken)

Stops an active Server.

Parameters
Name	Description
request	StopServerRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
StopServerRequest request = new StopServerRequest
{
    ServerName = ServerName.FromProjectLocationServer("[PROJECT]", "[LOCATION]", "[SERVER]"),
};
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StopServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStopServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServerAsync(string, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> StopServerAsync(string name, CallSettings callSettings = null)

Stops an active Server.

Parameters
Name	Description
name	string Required. Name of the resource. Format: projects/{project}/locations/{location}/servers/{server}
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StopServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStopServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

StopServerAsync(string, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> StopServerAsync(string name, CancellationToken cancellationToken)

Stops an active Server.

Parameters
Name	Description
name	string Required. Name of the resource. Format: projects/{project}/locations/{location}/servers/{server}
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/servers/[SERVER]";
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.StopServerAsync(name);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceStopServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

UpdateServer(Server, FieldMask, CallSettings)

public virtual Operation<Server, OperationMetadata> UpdateServer(Server server, FieldMask updateMask, CallSettings callSettings = null)

Updates the parameters of a single Server.

Parameters
Name	Description
server	Server Required. The resource being updated
updateMask	FieldMask Optional. Field mask is used to specify the fields to be overwritten in the Server resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
Server server = new Server();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.UpdateServer(server, updateMask);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceUpdateServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

UpdateServer(UpdateServerRequest, CallSettings)

public virtual Operation<Server, OperationMetadata> UpdateServer(UpdateServerRequest request, CallSettings callSettings = null)

Updates the parameters of a single Server.

Parameters
Name	Description
request	UpdateServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationServerOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
UpdateServerRequest request = new UpdateServerRequest
{
    UpdateMask = new FieldMask(),
    Server = new Server(),
    RequestId = "",
};
// Make the request
Operation<Server, OperationMetadata> response = cloudFtpClient.UpdateServer(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceUpdateServer(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

UpdateServerAsync(Server, FieldMask, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> UpdateServerAsync(Server server, FieldMask updateMask, CallSettings callSettings = null)

Updates the parameters of a single Server.

Parameters
Name	Description
server	Server Required. The resource being updated
updateMask	FieldMask Optional. Field mask is used to specify the fields to be overwritten in the Server resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
Server server = new Server();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.UpdateServerAsync(server, updateMask);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceUpdateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

UpdateServerAsync(Server, FieldMask, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> UpdateServerAsync(Server server, FieldMask updateMask, CancellationToken cancellationToken)

Updates the parameters of a single Server.

Parameters
Name	Description
server	Server Required. The resource being updated
updateMask	FieldMask Optional. Field mask is used to specify the fields to be overwritten in the Server resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
Server server = new Server();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.UpdateServerAsync(server, updateMask);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceUpdateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

UpdateServerAsync(UpdateServerRequest, CallSettings)

public virtual Task<Operation<Server, OperationMetadata>> UpdateServerAsync(UpdateServerRequest request, CallSettings callSettings = null)

Updates the parameters of a single Server.

Parameters
Name	Description
request	UpdateServerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
UpdateServerRequest request = new UpdateServerRequest
{
    UpdateMask = new FieldMask(),
    Server = new Server(),
    RequestId = "",
};
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.UpdateServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceUpdateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

UpdateServerAsync(UpdateServerRequest, CancellationToken)

public virtual Task<Operation<Server, OperationMetadata>> UpdateServerAsync(UpdateServerRequest request, CancellationToken cancellationToken)

Updates the parameters of a single Server.

Parameters
Name	Description
request	UpdateServerRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationServerOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
UpdateServerRequest request = new UpdateServerRequest
{
    UpdateMask = new FieldMask(),
    Server = new Server(),
    RequestId = "",
};
// Make the request
Operation<Server, OperationMetadata> response = await cloudFtpClient.UpdateServerAsync(request);

// Poll until the returned long-running operation is complete
Operation<Server, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
Server result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<Server, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceUpdateServerAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    Server retrievedResult = retrievedResponse.Result;
}

UpdateUser(UpdateUserRequest, CallSettings)

public virtual Operation<User, OperationMetadata> UpdateUser(UpdateUserRequest request, CallSettings callSettings = null)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUserOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
UpdateUserRequest request = new UpdateUserRequest
{
    UpdateMask = new FieldMask(),
    User = new User(),
};
// Make the request
Operation<User, OperationMetadata> response = cloudFtpClient.UpdateUser(request);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceUpdateUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

UpdateUser(User, FieldMask, CallSettings)

public virtual Operation<User, OperationMetadata> UpdateUser(User user, FieldMask updateMask, CallSettings callSettings = null)

Updates the parameters of a single User.

Parameters
Name	Description
user	User Required. The resource being updated
updateMask	FieldMask Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationUserOperationMetadata	The RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = CloudFtpClient.Create();
// Initialize request argument(s)
User user = new User();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<User, OperationMetadata> response = cloudFtpClient.UpdateUser(user, updateMask);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = cloudFtpClient.PollOnceUpdateUser(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

UpdateUserAsync(UpdateUserRequest, CallSettings)

public virtual Task<Operation<User, OperationMetadata>> UpdateUserAsync(UpdateUserRequest request, CallSettings callSettings = null)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
UpdateUserRequest request = new UpdateUserRequest
{
    UpdateMask = new FieldMask(),
    User = new User(),
};
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.UpdateUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceUpdateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

UpdateUserAsync(UpdateUserRequest, CancellationToken)

public virtual Task<Operation<User, OperationMetadata>> UpdateUserAsync(UpdateUserRequest request, CancellationToken cancellationToken)

Updates the parameters of a single User.

Parameters
Name	Description
request	UpdateUserRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
UpdateUserRequest request = new UpdateUserRequest
{
    UpdateMask = new FieldMask(),
    User = new User(),
};
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.UpdateUserAsync(request);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceUpdateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

UpdateUserAsync(User, FieldMask, CallSettings)

public virtual Task<Operation<User, OperationMetadata>> UpdateUserAsync(User user, FieldMask updateMask, CallSettings callSettings = null)

Updates the parameters of a single User.

Parameters
Name	Description
user	User Required. The resource being updated
updateMask	FieldMask Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
User user = new User();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.UpdateUserAsync(user, updateMask);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceUpdateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}

UpdateUserAsync(User, FieldMask, CancellationToken)

public virtual Task<Operation<User, OperationMetadata>> UpdateUserAsync(User user, FieldMask updateMask, CancellationToken cancellationToken)

Updates the parameters of a single User.

Parameters
Name	Description
user	User Required. The resource being updated
updateMask	FieldMask Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationUserOperationMetadata	A Task containing the RPC response.

Example

// Create client
CloudFtpClient cloudFtpClient = await CloudFtpClient.CreateAsync();
// Initialize request argument(s)
User user = new User();
FieldMask updateMask = new FieldMask();
// Make the request
Operation<User, OperationMetadata> response = await cloudFtpClient.UpdateUserAsync(user, updateMask);

// Poll until the returned long-running operation is complete
Operation<User, OperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
User result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<User, OperationMetadata> retrievedResponse = await cloudFtpClient.PollOnceUpdateUserAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    User retrievedResult = retrievedResponse.Result;
}