Google Workspace Add-ons v1 API - Class GSuiteAddOnsClientImpl (2.4.0)

public sealed class GSuiteAddOnsClientImpl : GSuiteAddOnsClient

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

GSuiteAddOns client wrapper implementation, for convenient use.

Inheritance

object > GSuiteAddOnsClient > GSuiteAddOnsClientImpl

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.

Constructors

GSuiteAddOnsClientImpl(GSuiteAddOnsClient, GSuiteAddOnsSettings, ILogger)

public GSuiteAddOnsClientImpl(GSuiteAddOns.GSuiteAddOnsClient grpcClient, GSuiteAddOnsSettings settings, ILogger logger)

Constructs a client wrapper for the GSuiteAddOns service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient GSuiteAddOnsGSuiteAddOnsClient

The underlying gRPC client.
settings GSuiteAddOnsSettings

The base GSuiteAddOnsSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override GSuiteAddOns.GSuiteAddOnsClient GrpcClient { get; }

The underlying gRPC GSuiteAddOns client

Property Value
Type Description
GSuiteAddOnsGSuiteAddOnsClient
Overrides

Methods

CreateDeployment(CreateDeploymentRequest, CallSettings)

public override 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.
Overrides

CreateDeploymentAsync(CreateDeploymentRequest, CallSettings)

public override 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.
Overrides

DeleteDeployment(DeleteDeploymentRequest, CallSettings)

public override 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.
Overrides

DeleteDeploymentAsync(DeleteDeploymentRequest, CallSettings)

public override 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.
Overrides

GetAuthorization(GetAuthorizationRequest, CallSettings)

public override 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.
Overrides

GetAuthorizationAsync(GetAuthorizationRequest, CallSettings)

public override 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.
Overrides

GetDeployment(GetDeploymentRequest, CallSettings)

public override 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.
Overrides

GetDeploymentAsync(GetDeploymentRequest, CallSettings)

public override 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.
Overrides

GetInstallStatus(GetInstallStatusRequest, CallSettings)

public override 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.
Overrides

GetInstallStatusAsync(GetInstallStatusRequest, CallSettings)

public override 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.
Overrides

InstallDeployment(InstallDeploymentRequest, CallSettings)

public override void InstallDeployment(InstallDeploymentRequest request, CallSettings callSettings = null)

Installs a deployment in developer mode. See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

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.
Overrides

InstallDeploymentAsync(InstallDeploymentRequest, CallSettings)

public override Task InstallDeploymentAsync(InstallDeploymentRequest request, CallSettings callSettings = null)

Installs a deployment in developer mode. See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

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.
Overrides

ListDeployments(ListDeploymentsRequest, CallSettings)

public override 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.
Overrides

ListDeploymentsAsync(ListDeploymentsRequest, CallSettings)

public override 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.
Overrides

ReplaceDeployment(ReplaceDeploymentRequest, CallSettings)

public override 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.
Overrides

ReplaceDeploymentAsync(ReplaceDeploymentRequest, CallSettings)

public override 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.
Overrides

UninstallDeployment(UninstallDeploymentRequest, CallSettings)

public override void UninstallDeployment(UninstallDeploymentRequest request, CallSettings callSettings = null)

Uninstalls a developer mode deployment. See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

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.
Overrides

UninstallDeploymentAsync(UninstallDeploymentRequest, CallSettings)

public override Task UninstallDeploymentAsync(UninstallDeploymentRequest request, CallSettings callSettings = null)

Uninstalls a developer mode deployment. See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

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.
Overrides