Interface GSuiteAddOnsGrpc.AsyncService (2.52.0) 

public static interface GSuiteAddOnsGrpc.AsyncService

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.

Methods

createDeployment(CreateDeploymentRequest request, StreamObserver<Deployment> responseObserver)

public default void createDeployment(CreateDeploymentRequest request, StreamObserver<Deployment> responseObserver)

Creates a deployment with the specified name and configuration.

Parameters
Name Description
request CreateDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<Deployment>

deleteDeployment(DeleteDeploymentRequest request, StreamObserver<Empty> responseObserver)

public default void deleteDeployment(DeleteDeploymentRequest request, StreamObserver<Empty> responseObserver)

Deletes the deployment with the given name.

Parameters
Name Description
request DeleteDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

getAuthorization(GetAuthorizationRequest request, StreamObserver<Authorization> responseObserver)

public default void getAuthorization(GetAuthorizationRequest request, StreamObserver<Authorization> responseObserver)

Gets the authorization information for deployments in a given project.

Parameters
Name Description
request GetAuthorizationRequest
responseObserver io.grpc.stub.StreamObserver<Authorization>

getDeployment(GetDeploymentRequest request, StreamObserver<Deployment> responseObserver)

public default void getDeployment(GetDeploymentRequest request, StreamObserver<Deployment> responseObserver)

Gets the deployment with the specified name.

Parameters
Name Description
request GetDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<Deployment>

getInstallStatus(GetInstallStatusRequest request, StreamObserver<InstallStatus> responseObserver)

public default void getInstallStatus(GetInstallStatusRequest request, StreamObserver<InstallStatus> responseObserver)

Fetches the install status of a developer mode deployment.

Parameters
Name Description
request GetInstallStatusRequest
responseObserver io.grpc.stub.StreamObserver<InstallStatus>

installDeployment(InstallDeploymentRequest request, StreamObserver<Empty> responseObserver)

public default void installDeployment(InstallDeploymentRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name Description
request InstallDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

listDeployments(ListDeploymentsRequest request, StreamObserver<ListDeploymentsResponse> responseObserver)

public default void listDeployments(ListDeploymentsRequest request, StreamObserver<ListDeploymentsResponse> responseObserver)

Lists all deployments in a particular project.

Parameters
Name Description
request ListDeploymentsRequest
responseObserver io.grpc.stub.StreamObserver<ListDeploymentsResponse>

replaceDeployment(ReplaceDeploymentRequest request, StreamObserver<Deployment> responseObserver)

public default void replaceDeployment(ReplaceDeploymentRequest request, StreamObserver<Deployment> responseObserver)

Creates or replaces a deployment with the specified name.

Parameters
Name Description
request ReplaceDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<Deployment>

uninstallDeployment(UninstallDeploymentRequest request, StreamObserver<Empty> responseObserver)

public default void uninstallDeployment(UninstallDeploymentRequest request, StreamObserver<Empty> responseObserver)

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

Parameters
Name Description
request UninstallDeploymentRequest
responseObserver io.grpc.stub.StreamObserver<Empty>