Package com.google.cloud.gsuiteaddons.v1 (2.22.0)

A client to Google Workspace Add-ons API

The interfaces provided are listed below, along with usage samples.

GSuiteAddOnsClient

Service Description: 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.

Sample for GSuiteAddOnsClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.create()) {
   AuthorizationName name = AuthorizationName.of("[PROJECT]");
   Authorization response = gSuiteAddOnsClient.getAuthorization(name);
 }

Classes

AddOns

A Google Workspace Add-on configuration.

Protobuf type google.cloud.gsuiteaddons.v1.AddOns

AddOns.Builder

A Google Workspace Add-on configuration.

Protobuf type google.cloud.gsuiteaddons.v1.AddOns

Authorization

The authorization information used when invoking deployment endpoints.

Protobuf type google.cloud.gsuiteaddons.v1.Authorization

Authorization.Builder

The authorization information used when invoking deployment endpoints.

Protobuf type google.cloud.gsuiteaddons.v1.Authorization

AuthorizationName

AuthorizationName.Builder

Builder for projects/{project}/authorization.

CreateDeploymentRequest

Request message to create a deployment.

Protobuf type google.cloud.gsuiteaddons.v1.CreateDeploymentRequest

CreateDeploymentRequest.Builder

Request message to create a deployment.

Protobuf type google.cloud.gsuiteaddons.v1.CreateDeploymentRequest

DeleteDeploymentRequest

Request message to delete a deployment.

Protobuf type google.cloud.gsuiteaddons.v1.DeleteDeploymentRequest

DeleteDeploymentRequest.Builder

Request message to delete a deployment.

Protobuf type google.cloud.gsuiteaddons.v1.DeleteDeploymentRequest

Deployment

A Google Workspace Add-on deployment

Protobuf type google.cloud.gsuiteaddons.v1.Deployment

Deployment.Builder

A Google Workspace Add-on deployment

Protobuf type google.cloud.gsuiteaddons.v1.Deployment

DeploymentName

DeploymentName.Builder

Builder for projects/{project}/deployments/{deployment}.

GSuiteAddOnsClient

Service Description: A service for managing Google Workspace Add-ons deployments.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.create()) {
   AuthorizationName name = AuthorizationName.of("[PROJECT]");
   Authorization response = gSuiteAddOnsClient.getAuthorization(name);
 }

Note: close() needs to be called on the GSuiteAddOnsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of GSuiteAddOnsSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GSuiteAddOnsSettings gSuiteAddOnsSettings =
     GSuiteAddOnsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.create(gSuiteAddOnsSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GSuiteAddOnsSettings gSuiteAddOnsSettings =
     GSuiteAddOnsSettings.newBuilder().setEndpoint(myEndpoint).build();
 GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.create(gSuiteAddOnsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GSuiteAddOnsSettings gSuiteAddOnsSettings = GSuiteAddOnsSettings.newHttpJsonBuilder().build();
 GSuiteAddOnsClient gSuiteAddOnsClient = GSuiteAddOnsClient.create(gSuiteAddOnsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

GSuiteAddOnsClient.ListDeploymentsFixedSizeCollection

GSuiteAddOnsClient.ListDeploymentsPage

GSuiteAddOnsClient.ListDeploymentsPagedResponse

GSuiteAddOnsGrpc

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.

The default service address (gsuiteaddons.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getAuthorization to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 GSuiteAddOnsSettings.Builder gSuiteAddOnsSettingsBuilder = GSuiteAddOnsSettings.newBuilder();
 gSuiteAddOnsSettingsBuilder
     .getAuthorizationSettings()
     .setRetrySettings(
         gSuiteAddOnsSettingsBuilder
             .getAuthorizationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 GSuiteAddOnsSettings gSuiteAddOnsSettings = gSuiteAddOnsSettingsBuilder.build();

GSuiteAddOnsSettings.Builder

Builder for GSuiteAddOnsSettings.

GetAuthorizationRequest

Request message to get Google Workspace Add-ons authorization information.

Protobuf type google.cloud.gsuiteaddons.v1.GetAuthorizationRequest

GetAuthorizationRequest.Builder

Request message to get Google Workspace Add-ons authorization information.

Protobuf type google.cloud.gsuiteaddons.v1.GetAuthorizationRequest

GetDeploymentRequest

Request message to get a deployment.

Protobuf type google.cloud.gsuiteaddons.v1.GetDeploymentRequest

GetDeploymentRequest.Builder

Request message to get a deployment.

Protobuf type google.cloud.gsuiteaddons.v1.GetDeploymentRequest

GetInstallStatusRequest

Request message to get the install status of a developer mode deployment.

Protobuf type google.cloud.gsuiteaddons.v1.GetInstallStatusRequest

GetInstallStatusRequest.Builder

Request message to get the install status of a developer mode deployment.

Protobuf type google.cloud.gsuiteaddons.v1.GetInstallStatusRequest

InstallDeploymentRequest

Request message to install a developer mode deployment.

Protobuf type google.cloud.gsuiteaddons.v1.InstallDeploymentRequest

InstallDeploymentRequest.Builder

Request message to install a developer mode deployment.

Protobuf type google.cloud.gsuiteaddons.v1.InstallDeploymentRequest

InstallStatus

Developer mode install status of a deployment

Protobuf type google.cloud.gsuiteaddons.v1.InstallStatus

InstallStatus.Builder

Developer mode install status of a deployment

Protobuf type google.cloud.gsuiteaddons.v1.InstallStatus

InstallStatusName

InstallStatusName.Builder

Builder for projects/{project}/deployments/{deployment}/installStatus.

ListDeploymentsRequest

Request message to list deployments for a project.

Protobuf type google.cloud.gsuiteaddons.v1.ListDeploymentsRequest

ListDeploymentsRequest.Builder

Request message to list deployments for a project.

Protobuf type google.cloud.gsuiteaddons.v1.ListDeploymentsRequest

ListDeploymentsResponse

Response message to list deployments.

Protobuf type google.cloud.gsuiteaddons.v1.ListDeploymentsResponse

ListDeploymentsResponse.Builder

Response message to list deployments.

Protobuf type google.cloud.gsuiteaddons.v1.ListDeploymentsResponse

ProjectName

ProjectName.Builder

Builder for projects/{project}.

ReplaceDeploymentRequest

Request message to create or replace a deployment.

Protobuf type google.cloud.gsuiteaddons.v1.ReplaceDeploymentRequest

ReplaceDeploymentRequest.Builder

Request message to create or replace a deployment.

Protobuf type google.cloud.gsuiteaddons.v1.ReplaceDeploymentRequest

UninstallDeploymentRequest

Request message to uninstall a developer mode deployment.

Protobuf type google.cloud.gsuiteaddons.v1.UninstallDeploymentRequest

UninstallDeploymentRequest.Builder

Request message to uninstall a developer mode deployment.

Protobuf type google.cloud.gsuiteaddons.v1.UninstallDeploymentRequest

Package com.google.cloud.gsuiteaddons.v1 (2.22.0)

GSuiteAddOnsClient

Classes

Interfaces