Google Workspace Add-ons v1 API - Class GSuiteAddOnsClient (2.3.0)

public abstract class GSuiteAddOnsClient

Reference documentation and code samples for the Google Workspace Add-ons v1 API class GSuiteAddOnsClient.

GSuiteAddOns client wrapper, for convenient use.

Inheritance

object > GSuiteAddOnsClient

Derived Types

Namespace

Google.Cloud.GSuiteAddOns.V1

Assembly

Google.Cloud.GSuiteAddOns.V1.dll

Remarks

A service for managing Google Workspace Add-ons deployments.

A Google Workspace Add-on is a third-party embedded component that can be installed in Google Workspace Applications like Gmail, Calendar, Drive, and the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can display UI cards, receive contextual information from the host application, and perform actions in the host application (See: https://developers.google.com/gsuite/add-ons/overview for more information).

A Google Workspace Add-on deployment resource specifies metadata about the add-on, including a specification of the entry points in the host application that trigger add-on executions (see: https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests). Add-on deployments defined via the Google Workspace Add-ons API define their entrypoints using HTTPS URLs (See: https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),

A Google Workspace Add-on deployment can be installed in developer mode, which allows an add-on developer to test the experience an end-user would see when installing and running the add-on in their G Suite applications. When running in developer mode, more detailed error messages are exposed in the add-on UI to aid in debugging.

A Google Workspace Add-on deployment can be published to Google Workspace Marketplace, which allows other Google Workspace users to discover and install the add-on. See: https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview for details.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

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

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default GSuiteAddOns scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default GSuiteAddOns scopes are:

GrpcClient

public virtual GSuiteAddOns.GSuiteAddOnsClient GrpcClient { get; }

The underlying gRPC GSuiteAddOns client

Property Value
Type Description
GSuiteAddOnsGSuiteAddOnsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static GSuiteAddOnsClient Create()

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

Returns
Type Description
GSuiteAddOnsClient

The created GSuiteAddOnsClient.

CreateAsync(CancellationToken)

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

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

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskGSuiteAddOnsClient

The task representing the created GSuiteAddOnsClient.

CreateDeployment(ProjectName, Deployment, string, CallSettings)

public virtual Deployment CreateDeployment(ProjectName parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
parent ProjectName

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

deployment Deployment

Required. The deployment to create (deployment.name cannot be set).

deploymentId string

Required. The id to use for this deployment. The full name of the created resource will be projects/<project_number>/deployments/<deployment_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Deployment

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Deployment response = gSuiteAddOnsClient.CreateDeployment(parent, deployment, deploymentId);

CreateDeployment(CreateDeploymentRequest, CallSettings)

public virtual Deployment CreateDeployment(CreateDeploymentRequest request, CallSettings callSettings = null)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
request CreateDeploymentRequest

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
Deployment

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
CreateDeploymentRequest request = new CreateDeploymentRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    DeploymentId = "",
    Deployment = new Deployment(),
};
// Make the request
Deployment response = gSuiteAddOnsClient.CreateDeployment(request);

CreateDeployment(string, Deployment, string, CallSettings)

public virtual Deployment CreateDeployment(string parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
parent string

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

deployment Deployment

Required. The deployment to create (deployment.name cannot be set).

deploymentId string

Required. The id to use for this deployment. The full name of the created resource will be projects/<project_number>/deployments/<deployment_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Deployment

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Deployment response = gSuiteAddOnsClient.CreateDeployment(parent, deployment, deploymentId);

CreateDeploymentAsync(ProjectName, Deployment, string, CallSettings)

public virtual Task<Deployment> CreateDeploymentAsync(ProjectName parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
parent ProjectName

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

deployment Deployment

Required. The deployment to create (deployment.name cannot be set).

deploymentId string

Required. The id to use for this deployment. The full name of the created resource will be projects/<project_number>/deployments/<deployment_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Deployment response = await gSuiteAddOnsClient.CreateDeploymentAsync(parent, deployment, deploymentId);

CreateDeploymentAsync(ProjectName, Deployment, string, CancellationToken)

public virtual Task<Deployment> CreateDeploymentAsync(ProjectName parent, Deployment deployment, string deploymentId, CancellationToken cancellationToken)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
parent ProjectName

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

deployment Deployment

Required. The deployment to create (deployment.name cannot be set).

deploymentId string

Required. The id to use for this deployment. The full name of the created resource will be projects/<project_number>/deployments/<deployment_id>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Deployment response = await gSuiteAddOnsClient.CreateDeploymentAsync(parent, deployment, deploymentId);

CreateDeploymentAsync(CreateDeploymentRequest, CallSettings)

public virtual Task<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, CallSettings callSettings = null)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
request CreateDeploymentRequest

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
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
CreateDeploymentRequest request = new CreateDeploymentRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    DeploymentId = "",
    Deployment = new Deployment(),
};
// Make the request
Deployment response = await gSuiteAddOnsClient.CreateDeploymentAsync(request);

CreateDeploymentAsync(CreateDeploymentRequest, CancellationToken)

public virtual Task<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, CancellationToken cancellationToken)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
request CreateDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
CreateDeploymentRequest request = new CreateDeploymentRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    DeploymentId = "",
    Deployment = new Deployment(),
};
// Make the request
Deployment response = await gSuiteAddOnsClient.CreateDeploymentAsync(request);

CreateDeploymentAsync(string, Deployment, string, CallSettings)

public virtual Task<Deployment> CreateDeploymentAsync(string parent, Deployment deployment, string deploymentId, CallSettings callSettings = null)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
parent string

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

deployment Deployment

Required. The deployment to create (deployment.name cannot be set).

deploymentId string

Required. The id to use for this deployment. The full name of the created resource will be projects/<project_number>/deployments/<deployment_id>.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Deployment response = await gSuiteAddOnsClient.CreateDeploymentAsync(parent, deployment, deploymentId);

CreateDeploymentAsync(string, Deployment, string, CancellationToken)

public virtual Task<Deployment> CreateDeploymentAsync(string parent, Deployment deployment, string deploymentId, CancellationToken cancellationToken)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
parent string

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

deployment Deployment

Required. The deployment to create (deployment.name cannot be set).

deploymentId string

Required. The id to use for this deployment. The full name of the created resource will be projects/<project_number>/deployments/<deployment_id>.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
Deployment deployment = new Deployment();
string deploymentId = "";
// Make the request
Deployment response = await gSuiteAddOnsClient.CreateDeploymentAsync(parent, deployment, deploymentId);

DeleteDeployment(DeleteDeploymentRequest, CallSettings)

public virtual void DeleteDeployment(DeleteDeploymentRequest request, CallSettings callSettings = null)

Deletes the deployment with the given name.

Parameters
Name Description
request DeleteDeploymentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
DeleteDeploymentRequest request = new DeleteDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
    Etag = "",
};
// Make the request
gSuiteAddOnsClient.DeleteDeployment(request);

DeleteDeployment(DeploymentName, CallSettings)

public virtual void DeleteDeployment(DeploymentName name, CallSettings callSettings = null)

Deletes the deployment with the given name.

Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to delete.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
gSuiteAddOnsClient.DeleteDeployment(name);

DeleteDeployment(string, CallSettings)

public virtual void DeleteDeployment(string name, CallSettings callSettings = null)

Deletes the deployment with the given name.

Parameters
Name Description
name string

Required. The full resource name of the deployment to delete.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
gSuiteAddOnsClient.DeleteDeployment(name);

DeleteDeploymentAsync(DeleteDeploymentRequest, CallSettings)

public virtual Task DeleteDeploymentAsync(DeleteDeploymentRequest request, CallSettings callSettings = null)

Deletes the deployment with the given name.

Parameters
Name Description
request DeleteDeploymentRequest

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
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeleteDeploymentRequest request = new DeleteDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
    Etag = "",
};
// Make the request
await gSuiteAddOnsClient.DeleteDeploymentAsync(request);

DeleteDeploymentAsync(DeleteDeploymentRequest, CancellationToken)

public virtual Task DeleteDeploymentAsync(DeleteDeploymentRequest request, CancellationToken cancellationToken)

Deletes the deployment with the given name.

Parameters
Name Description
request DeleteDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeleteDeploymentRequest request = new DeleteDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
    Etag = "",
};
// Make the request
await gSuiteAddOnsClient.DeleteDeploymentAsync(request);

DeleteDeploymentAsync(DeploymentName, CallSettings)

public virtual Task DeleteDeploymentAsync(DeploymentName name, CallSettings callSettings = null)

Deletes the deployment with the given name.

Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to delete.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
await gSuiteAddOnsClient.DeleteDeploymentAsync(name);

DeleteDeploymentAsync(DeploymentName, CancellationToken)

public virtual Task DeleteDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)

Deletes the deployment with the given name.

Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to delete.

Example: projects/my_project/deployments/my_deployment.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
await gSuiteAddOnsClient.DeleteDeploymentAsync(name);

DeleteDeploymentAsync(string, CallSettings)

public virtual Task DeleteDeploymentAsync(string name, CallSettings callSettings = null)

Deletes the deployment with the given name.

Parameters
Name Description
name string

Required. The full resource name of the deployment to delete.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
await gSuiteAddOnsClient.DeleteDeploymentAsync(name);

DeleteDeploymentAsync(string, CancellationToken)

public virtual Task DeleteDeploymentAsync(string name, CancellationToken cancellationToken)

Deletes the deployment with the given name.

Parameters
Name Description
name string

Required. The full resource name of the deployment to delete.

Example: projects/my_project/deployments/my_deployment.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
await gSuiteAddOnsClient.DeleteDeploymentAsync(name);

GetAuthorization(AuthorizationName, CallSettings)

public virtual Authorization GetAuthorization(AuthorizationName name, CallSettings callSettings = null)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
name AuthorizationName

Required. Name of the project for which to get the Google Workspace Add-ons authorization information.

Example: projects/my_project/authorization.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Authorization

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
AuthorizationName name = AuthorizationName.FromProject("[PROJECT]");
// Make the request
Authorization response = gSuiteAddOnsClient.GetAuthorization(name);

GetAuthorization(GetAuthorizationRequest, CallSettings)

public virtual Authorization GetAuthorization(GetAuthorizationRequest request, CallSettings callSettings = null)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
request GetAuthorizationRequest

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
Authorization

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
GetAuthorizationRequest request = new GetAuthorizationRequest
{
    AuthorizationName = AuthorizationName.FromProject("[PROJECT]"),
};
// Make the request
Authorization response = gSuiteAddOnsClient.GetAuthorization(request);

GetAuthorization(string, CallSettings)

public virtual Authorization GetAuthorization(string name, CallSettings callSettings = null)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
name string

Required. Name of the project for which to get the Google Workspace Add-ons authorization information.

Example: projects/my_project/authorization.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Authorization

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/authorization";
// Make the request
Authorization response = gSuiteAddOnsClient.GetAuthorization(name);

GetAuthorizationAsync(AuthorizationName, CallSettings)

public virtual Task<Authorization> GetAuthorizationAsync(AuthorizationName name, CallSettings callSettings = null)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
name AuthorizationName

Required. Name of the project for which to get the Google Workspace Add-ons authorization information.

Example: projects/my_project/authorization.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthorization

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
AuthorizationName name = AuthorizationName.FromProject("[PROJECT]");
// Make the request
Authorization response = await gSuiteAddOnsClient.GetAuthorizationAsync(name);

GetAuthorizationAsync(AuthorizationName, CancellationToken)

public virtual Task<Authorization> GetAuthorizationAsync(AuthorizationName name, CancellationToken cancellationToken)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
name AuthorizationName

Required. Name of the project for which to get the Google Workspace Add-ons authorization information.

Example: projects/my_project/authorization.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorization

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
AuthorizationName name = AuthorizationName.FromProject("[PROJECT]");
// Make the request
Authorization response = await gSuiteAddOnsClient.GetAuthorizationAsync(name);

GetAuthorizationAsync(GetAuthorizationRequest, CallSettings)

public virtual Task<Authorization> GetAuthorizationAsync(GetAuthorizationRequest request, CallSettings callSettings = null)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
request GetAuthorizationRequest

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
TaskAuthorization

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
GetAuthorizationRequest request = new GetAuthorizationRequest
{
    AuthorizationName = AuthorizationName.FromProject("[PROJECT]"),
};
// Make the request
Authorization response = await gSuiteAddOnsClient.GetAuthorizationAsync(request);

GetAuthorizationAsync(GetAuthorizationRequest, CancellationToken)

public virtual Task<Authorization> GetAuthorizationAsync(GetAuthorizationRequest request, CancellationToken cancellationToken)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
request GetAuthorizationRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorization

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
GetAuthorizationRequest request = new GetAuthorizationRequest
{
    AuthorizationName = AuthorizationName.FromProject("[PROJECT]"),
};
// Make the request
Authorization response = await gSuiteAddOnsClient.GetAuthorizationAsync(request);

GetAuthorizationAsync(string, CallSettings)

public virtual Task<Authorization> GetAuthorizationAsync(string name, CallSettings callSettings = null)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
name string

Required. Name of the project for which to get the Google Workspace Add-ons authorization information.

Example: projects/my_project/authorization.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskAuthorization

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/authorization";
// Make the request
Authorization response = await gSuiteAddOnsClient.GetAuthorizationAsync(name);

GetAuthorizationAsync(string, CancellationToken)

public virtual Task<Authorization> GetAuthorizationAsync(string name, CancellationToken cancellationToken)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
name string

Required. Name of the project for which to get the Google Workspace Add-ons authorization information.

Example: projects/my_project/authorization.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskAuthorization

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/authorization";
// Make the request
Authorization response = await gSuiteAddOnsClient.GetAuthorizationAsync(name);

GetDeployment(DeploymentName, CallSettings)

public virtual Deployment GetDeployment(DeploymentName name, CallSettings callSettings = null)

Gets the deployment with the specified name.

Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to get.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Deployment

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
Deployment response = gSuiteAddOnsClient.GetDeployment(name);

GetDeployment(GetDeploymentRequest, CallSettings)

public virtual Deployment GetDeployment(GetDeploymentRequest request, CallSettings callSettings = null)

Gets the deployment with the specified name.

Parameters
Name Description
request GetDeploymentRequest

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
Deployment

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
GetDeploymentRequest request = new GetDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
Deployment response = gSuiteAddOnsClient.GetDeployment(request);

GetDeployment(string, CallSettings)

public virtual Deployment GetDeployment(string name, CallSettings callSettings = null)

Gets the deployment with the specified name.

Parameters
Name Description
name string

Required. The full resource name of the deployment to get.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Deployment

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
Deployment response = gSuiteAddOnsClient.GetDeployment(name);

GetDeploymentAsync(DeploymentName, CallSettings)

public virtual Task<Deployment> GetDeploymentAsync(DeploymentName name, CallSettings callSettings = null)

Gets the deployment with the specified name.

Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to get.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
Deployment response = await gSuiteAddOnsClient.GetDeploymentAsync(name);

GetDeploymentAsync(DeploymentName, CancellationToken)

public virtual Task<Deployment> GetDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)

Gets the deployment with the specified name.

Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to get.

Example: projects/my_project/deployments/my_deployment.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
Deployment response = await gSuiteAddOnsClient.GetDeploymentAsync(name);

GetDeploymentAsync(GetDeploymentRequest, CallSettings)

public virtual Task<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CallSettings callSettings = null)

Gets the deployment with the specified name.

Parameters
Name Description
request GetDeploymentRequest

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
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
GetDeploymentRequest request = new GetDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
Deployment response = await gSuiteAddOnsClient.GetDeploymentAsync(request);

GetDeploymentAsync(GetDeploymentRequest, CancellationToken)

public virtual Task<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CancellationToken cancellationToken)

Gets the deployment with the specified name.

Parameters
Name Description
request GetDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
GetDeploymentRequest request = new GetDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
Deployment response = await gSuiteAddOnsClient.GetDeploymentAsync(request);

GetDeploymentAsync(string, CallSettings)

public virtual Task<Deployment> GetDeploymentAsync(string name, CallSettings callSettings = null)

Gets the deployment with the specified name.

Parameters
Name Description
name string

Required. The full resource name of the deployment to get.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
Deployment response = await gSuiteAddOnsClient.GetDeploymentAsync(name);

GetDeploymentAsync(string, CancellationToken)

public virtual Task<Deployment> GetDeploymentAsync(string name, CancellationToken cancellationToken)

Gets the deployment with the specified name.

Parameters
Name Description
name string

Required. The full resource name of the deployment to get.

Example: projects/my_project/deployments/my_deployment.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
Deployment response = await gSuiteAddOnsClient.GetDeploymentAsync(name);

GetInstallStatus(GetInstallStatusRequest, CallSettings)

public virtual InstallStatus GetInstallStatus(GetInstallStatusRequest request, CallSettings callSettings = null)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
request GetInstallStatusRequest

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
InstallStatus

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
GetInstallStatusRequest request = new GetInstallStatusRequest
{
    InstallStatusName = InstallStatusName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
InstallStatus response = gSuiteAddOnsClient.GetInstallStatus(request);

GetInstallStatus(InstallStatusName, CallSettings)

public virtual InstallStatus GetInstallStatus(InstallStatusName name, CallSettings callSettings = null)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
name InstallStatusName

Required. The full resource name of the deployment.

Example: projects/my_project/deployments/my_deployment/installStatus.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
InstallStatus

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
InstallStatusName name = InstallStatusName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
InstallStatus response = gSuiteAddOnsClient.GetInstallStatus(name);

GetInstallStatus(string, CallSettings)

public virtual InstallStatus GetInstallStatus(string name, CallSettings callSettings = null)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
name string

Required. The full resource name of the deployment.

Example: projects/my_project/deployments/my_deployment/installStatus.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
InstallStatus

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]/installStatus";
// Make the request
InstallStatus response = gSuiteAddOnsClient.GetInstallStatus(name);

GetInstallStatusAsync(GetInstallStatusRequest, CallSettings)

public virtual Task<InstallStatus> GetInstallStatusAsync(GetInstallStatusRequest request, CallSettings callSettings = null)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
request GetInstallStatusRequest

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
TaskInstallStatus

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
GetInstallStatusRequest request = new GetInstallStatusRequest
{
    InstallStatusName = InstallStatusName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
InstallStatus response = await gSuiteAddOnsClient.GetInstallStatusAsync(request);

GetInstallStatusAsync(GetInstallStatusRequest, CancellationToken)

public virtual Task<InstallStatus> GetInstallStatusAsync(GetInstallStatusRequest request, CancellationToken cancellationToken)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
request GetInstallStatusRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstallStatus

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
GetInstallStatusRequest request = new GetInstallStatusRequest
{
    InstallStatusName = InstallStatusName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
InstallStatus response = await gSuiteAddOnsClient.GetInstallStatusAsync(request);

GetInstallStatusAsync(InstallStatusName, CallSettings)

public virtual Task<InstallStatus> GetInstallStatusAsync(InstallStatusName name, CallSettings callSettings = null)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
name InstallStatusName

Required. The full resource name of the deployment.

Example: projects/my_project/deployments/my_deployment/installStatus.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInstallStatus

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
InstallStatusName name = InstallStatusName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
InstallStatus response = await gSuiteAddOnsClient.GetInstallStatusAsync(name);

GetInstallStatusAsync(InstallStatusName, CancellationToken)

public virtual Task<InstallStatus> GetInstallStatusAsync(InstallStatusName name, CancellationToken cancellationToken)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
name InstallStatusName

Required. The full resource name of the deployment.

Example: projects/my_project/deployments/my_deployment/installStatus.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstallStatus

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
InstallStatusName name = InstallStatusName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
InstallStatus response = await gSuiteAddOnsClient.GetInstallStatusAsync(name);

GetInstallStatusAsync(string, CallSettings)

public virtual Task<InstallStatus> GetInstallStatusAsync(string name, CallSettings callSettings = null)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
name string

Required. The full resource name of the deployment.

Example: projects/my_project/deployments/my_deployment/installStatus.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskInstallStatus

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]/installStatus";
// Make the request
InstallStatus response = await gSuiteAddOnsClient.GetInstallStatusAsync(name);

GetInstallStatusAsync(string, CancellationToken)

public virtual Task<InstallStatus> GetInstallStatusAsync(string name, CancellationToken cancellationToken)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
name string

Required. The full resource name of the deployment.

Example: projects/my_project/deployments/my_deployment/installStatus.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskInstallStatus

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]/installStatus";
// Make the request
InstallStatus response = await gSuiteAddOnsClient.GetInstallStatusAsync(name);

InstallDeployment(DeploymentName, CallSettings)

public virtual void InstallDeployment(DeploymentName name, CallSettings callSettings = null)
Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
gSuiteAddOnsClient.InstallDeployment(name);

InstallDeployment(InstallDeploymentRequest, CallSettings)

public virtual void InstallDeployment(InstallDeploymentRequest request, CallSettings callSettings = null)
Parameters
Name Description
request InstallDeploymentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
InstallDeploymentRequest request = new InstallDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
gSuiteAddOnsClient.InstallDeployment(request);

InstallDeployment(string, CallSettings)

public virtual void InstallDeployment(string name, CallSettings callSettings = null)
Parameters
Name Description
name string

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
gSuiteAddOnsClient.InstallDeployment(name);

InstallDeploymentAsync(DeploymentName, CallSettings)

public virtual Task InstallDeploymentAsync(DeploymentName name, CallSettings callSettings = null)
Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
await gSuiteAddOnsClient.InstallDeploymentAsync(name);

InstallDeploymentAsync(DeploymentName, CancellationToken)

public virtual Task InstallDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)
Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
await gSuiteAddOnsClient.InstallDeploymentAsync(name);

InstallDeploymentAsync(InstallDeploymentRequest, CallSettings)

public virtual Task InstallDeploymentAsync(InstallDeploymentRequest request, CallSettings callSettings = null)
Parameters
Name Description
request InstallDeploymentRequest

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
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
InstallDeploymentRequest request = new InstallDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
await gSuiteAddOnsClient.InstallDeploymentAsync(request);

InstallDeploymentAsync(InstallDeploymentRequest, CancellationToken)

public virtual Task InstallDeploymentAsync(InstallDeploymentRequest request, CancellationToken cancellationToken)
Parameters
Name Description
request InstallDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
InstallDeploymentRequest request = new InstallDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
await gSuiteAddOnsClient.InstallDeploymentAsync(request);

InstallDeploymentAsync(string, CallSettings)

public virtual Task InstallDeploymentAsync(string name, CallSettings callSettings = null)
Parameters
Name Description
name string

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
await gSuiteAddOnsClient.InstallDeploymentAsync(name);

InstallDeploymentAsync(string, CancellationToken)

public virtual Task InstallDeploymentAsync(string name, CancellationToken cancellationToken)
Parameters
Name Description
name string

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
await gSuiteAddOnsClient.InstallDeploymentAsync(name);

ListDeployments(ProjectName, string, int?, CallSettings)

public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all deployments in a particular project.

Parameters
Name Description
parent ProjectName

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

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
PagedEnumerableListDeploymentsResponseDeployment

A pageable sequence of Deployment resources.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedEnumerable<ListDeploymentsResponse, Deployment> response = gSuiteAddOnsClient.ListDeployments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Deployment 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 (ListDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeployments(ListDeploymentsRequest, CallSettings)

public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(ListDeploymentsRequest request, CallSettings callSettings = null)

Lists all deployments in a particular project.

Parameters
Name Description
request ListDeploymentsRequest

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
PagedEnumerableListDeploymentsResponseDeployment

A pageable sequence of Deployment resources.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
ListDeploymentsRequest request = new ListDeploymentsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedEnumerable<ListDeploymentsResponse, Deployment> response = gSuiteAddOnsClient.ListDeployments(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (Deployment 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 (ListDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeployments(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListDeploymentsResponse, Deployment> ListDeployments(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all deployments in a particular project.

Parameters
Name Description
parent string

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

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
PagedEnumerableListDeploymentsResponseDeployment

A pageable sequence of Deployment resources.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedEnumerable<ListDeploymentsResponse, Deployment> response = gSuiteAddOnsClient.ListDeployments(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (Deployment 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 (ListDeploymentsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeploymentsAsync(ProjectName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(ProjectName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all deployments in a particular project.

Parameters
Name Description
parent ProjectName

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

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
PagedAsyncEnumerableListDeploymentsResponseDeployment

A pageable asynchronous sequence of Deployment resources.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
// Make the request
PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> response = gSuiteAddOnsClient.ListDeploymentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Deployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeploymentsAsync(ListDeploymentsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(ListDeploymentsRequest request, CallSettings callSettings = null)

Lists all deployments in a particular project.

Parameters
Name Description
request ListDeploymentsRequest

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
PagedAsyncEnumerableListDeploymentsResponseDeployment

A pageable asynchronous sequence of Deployment resources.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
ListDeploymentsRequest request = new ListDeploymentsRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
};
// Make the request
PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> response = gSuiteAddOnsClient.ListDeploymentsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Deployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ListDeploymentsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> ListDeploymentsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists all deployments in a particular project.

Parameters
Name Description
parent string

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

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
PagedAsyncEnumerableListDeploymentsResponseDeployment

A pageable asynchronous sequence of Deployment resources.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
// Make the request
PagedAsyncEnumerable<ListDeploymentsResponse, Deployment> response = gSuiteAddOnsClient.ListDeploymentsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((Deployment item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((ListDeploymentsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (Deployment 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<Deployment> 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 (Deployment 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;

ReplaceDeployment(Deployment, CallSettings)

public virtual Deployment ReplaceDeployment(Deployment deployment, CallSettings callSettings = null)

Creates or replaces a deployment with the specified name.

Parameters
Name Description
deployment Deployment

Required. The deployment to create or replace.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Deployment

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
Deployment deployment = new Deployment();
// Make the request
Deployment response = gSuiteAddOnsClient.ReplaceDeployment(deployment);

ReplaceDeployment(ReplaceDeploymentRequest, CallSettings)

public virtual Deployment ReplaceDeployment(ReplaceDeploymentRequest request, CallSettings callSettings = null)

Creates or replaces a deployment with the specified name.

Parameters
Name Description
request ReplaceDeploymentRequest

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
Deployment

The RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
ReplaceDeploymentRequest request = new ReplaceDeploymentRequest
{
    Deployment = new Deployment(),
};
// Make the request
Deployment response = gSuiteAddOnsClient.ReplaceDeployment(request);

ReplaceDeploymentAsync(Deployment, CallSettings)

public virtual Task<Deployment> ReplaceDeploymentAsync(Deployment deployment, CallSettings callSettings = null)

Creates or replaces a deployment with the specified name.

Parameters
Name Description
deployment Deployment

Required. The deployment to create or replace.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
Deployment deployment = new Deployment();
// Make the request
Deployment response = await gSuiteAddOnsClient.ReplaceDeploymentAsync(deployment);

ReplaceDeploymentAsync(Deployment, CancellationToken)

public virtual Task<Deployment> ReplaceDeploymentAsync(Deployment deployment, CancellationToken cancellationToken)

Creates or replaces a deployment with the specified name.

Parameters
Name Description
deployment Deployment

Required. The deployment to create or replace.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
Deployment deployment = new Deployment();
// Make the request
Deployment response = await gSuiteAddOnsClient.ReplaceDeploymentAsync(deployment);

ReplaceDeploymentAsync(ReplaceDeploymentRequest, CallSettings)

public virtual Task<Deployment> ReplaceDeploymentAsync(ReplaceDeploymentRequest request, CallSettings callSettings = null)

Creates or replaces a deployment with the specified name.

Parameters
Name Description
request ReplaceDeploymentRequest

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
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
ReplaceDeploymentRequest request = new ReplaceDeploymentRequest
{
    Deployment = new Deployment(),
};
// Make the request
Deployment response = await gSuiteAddOnsClient.ReplaceDeploymentAsync(request);

ReplaceDeploymentAsync(ReplaceDeploymentRequest, CancellationToken)

public virtual Task<Deployment> ReplaceDeploymentAsync(ReplaceDeploymentRequest request, CancellationToken cancellationToken)

Creates or replaces a deployment with the specified name.

Parameters
Name Description
request ReplaceDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskDeployment

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
ReplaceDeploymentRequest request = new ReplaceDeploymentRequest
{
    Deployment = new Deployment(),
};
// Make the request
Deployment response = await gSuiteAddOnsClient.ReplaceDeploymentAsync(request);

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.

UninstallDeployment(DeploymentName, CallSettings)

public virtual void UninstallDeployment(DeploymentName name, CallSettings callSettings = null)
Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
gSuiteAddOnsClient.UninstallDeployment(name);

UninstallDeployment(UninstallDeploymentRequest, CallSettings)

public virtual void UninstallDeployment(UninstallDeploymentRequest request, CallSettings callSettings = null)
Parameters
Name Description
request UninstallDeploymentRequest

The request object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
UninstallDeploymentRequest request = new UninstallDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
gSuiteAddOnsClient.UninstallDeployment(request);

UninstallDeployment(string, CallSettings)

public virtual void UninstallDeployment(string name, CallSettings callSettings = null)
Parameters
Name Description
name string

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
gSuiteAddOnsClient.UninstallDeployment(name);

UninstallDeploymentAsync(DeploymentName, CallSettings)

public virtual Task UninstallDeploymentAsync(DeploymentName name, CallSettings callSettings = null)
Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
await gSuiteAddOnsClient.UninstallDeploymentAsync(name);

UninstallDeploymentAsync(DeploymentName, CancellationToken)

public virtual Task UninstallDeploymentAsync(DeploymentName name, CancellationToken cancellationToken)
Parameters
Name Description
name DeploymentName

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
DeploymentName name = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]");
// Make the request
await gSuiteAddOnsClient.UninstallDeploymentAsync(name);

UninstallDeploymentAsync(UninstallDeploymentRequest, CallSettings)

public virtual Task UninstallDeploymentAsync(UninstallDeploymentRequest request, CallSettings callSettings = null)
Parameters
Name Description
request UninstallDeploymentRequest

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
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
UninstallDeploymentRequest request = new UninstallDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
await gSuiteAddOnsClient.UninstallDeploymentAsync(request);

UninstallDeploymentAsync(UninstallDeploymentRequest, CancellationToken)

public virtual Task UninstallDeploymentAsync(UninstallDeploymentRequest request, CancellationToken cancellationToken)
Parameters
Name Description
request UninstallDeploymentRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
UninstallDeploymentRequest request = new UninstallDeploymentRequest
{
    DeploymentName = DeploymentName.FromProjectDeployment("[PROJECT]", "[DEPLOYMENT]"),
};
// Make the request
await gSuiteAddOnsClient.UninstallDeploymentAsync(request);

UninstallDeploymentAsync(string, CallSettings)

public virtual Task UninstallDeploymentAsync(string name, CallSettings callSettings = null)
Parameters
Name Description
name string

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
await gSuiteAddOnsClient.UninstallDeploymentAsync(name);

UninstallDeploymentAsync(string, CancellationToken)

public virtual Task UninstallDeploymentAsync(string name, CancellationToken cancellationToken)
Parameters
Name Description
name string

Required. The full resource name of the deployment to install.

Example: projects/my_project/deployments/my_deployment.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
GSuiteAddOnsClient gSuiteAddOnsClient = await GSuiteAddOnsClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/deployments/[DEPLOYMENT]";
// Make the request
await gSuiteAddOnsClient.UninstallDeploymentAsync(name);