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

public class GSuiteAddOns.GSuiteAddOnsClient : ClientBase<GSuiteAddOns.GSuiteAddOnsClient>

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

Client for GSuiteAddOns

Inheritance

object > ClientBase > ClientBase GSuiteAddOns GSuiteAddOnsClient > GSuiteAddOns.GSuiteAddOnsClient

Inherited Members

ClientBase<GSuiteAddOns.GSuiteAddOnsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.GSuiteAddOns.V1

Assembly

Google.Cloud.GSuiteAddOns.V1.dll

Constructors

GSuiteAddOnsClient()

protected GSuiteAddOnsClient()

Protected parameterless constructor to allow creation of test doubles.

GSuiteAddOnsClient(CallInvoker)

public GSuiteAddOnsClient(CallInvoker callInvoker)

Creates a new client for GSuiteAddOns that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

GSuiteAddOnsClient(ChannelBase)

public GSuiteAddOnsClient(ChannelBase channel)

Creates a new client for GSuiteAddOns

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

GSuiteAddOnsClient(ClientBaseConfiguration)

protected GSuiteAddOnsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration` The client configuration.

Methods

CreateDeployment(CreateDeploymentRequest, CallOptions)

public virtual Deployment CreateDeployment(CreateDeploymentRequest request, CallOptions options)

Creates a deployment with the specified name and configuration.

Parameters
Name	Description
`request`	`CreateDeploymentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Deployment`	The response received from the server.

CreateDeployment(CreateDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual Deployment CreateDeployment(CreateDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a deployment with the specified name and configuration.

Parameters
Name	Description
`request`	`CreateDeploymentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Deployment`	The response received from the server.

CreateDeploymentAsync(CreateDeploymentRequest, CallOptions)

public virtual AsyncUnaryCall<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, CallOptions options)

Creates a deployment with the specified name and configuration.

Parameters
Name	Description
`request`	`CreateDeploymentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallDeployment`	The call object.

CreateDeploymentAsync(CreateDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Deployment> CreateDeploymentAsync(CreateDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a deployment with the specified name and configuration.

Parameters
Name	Description
`request`	`CreateDeploymentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallDeployment`	The call object.

DeleteDeployment(DeleteDeploymentRequest, CallOptions)

public virtual Empty DeleteDeployment(DeleteDeploymentRequest request, CallOptions options)

Deletes the deployment with the given name.

Parameters
Name	Description
`request`	`DeleteDeploymentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteDeployment(DeleteDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteDeployment(DeleteDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the deployment with the given name.

Parameters
Name	Description
`request`	`DeleteDeploymentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteDeploymentAsync(DeleteDeploymentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteDeploymentAsync(DeleteDeploymentRequest request, CallOptions options)

Deletes the deployment with the given name.

Parameters
Name	Description
`request`	`DeleteDeploymentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

DeleteDeploymentAsync(DeleteDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteDeploymentAsync(DeleteDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes the deployment with the given name.

Parameters
Name	Description
`request`	`DeleteDeploymentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

GetAuthorization(GetAuthorizationRequest, CallOptions)

public virtual Authorization GetAuthorization(GetAuthorizationRequest request, CallOptions options)

Gets the authorization information for deployments in a given project.

Parameters
Name	Description
`request`	`GetAuthorizationRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Authorization`	The response received from the server.

GetAuthorization(GetAuthorizationRequest, Metadata, DateTime?, CancellationToken)

public virtual Authorization GetAuthorization(GetAuthorizationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the authorization information for deployments in a given project.

Parameters
Name	Description
`request`	`GetAuthorizationRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Authorization`	The response received from the server.

GetAuthorizationAsync(GetAuthorizationRequest, CallOptions)

public virtual AsyncUnaryCall<Authorization> GetAuthorizationAsync(GetAuthorizationRequest request, CallOptions options)

Gets the authorization information for deployments in a given project.

Parameters
Name	Description
`request`	`GetAuthorizationRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallAuthorization`	The call object.

GetAuthorizationAsync(GetAuthorizationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Authorization> GetAuthorizationAsync(GetAuthorizationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the authorization information for deployments in a given project.

Parameters
Name	Description
`request`	`GetAuthorizationRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallAuthorization`	The call object.

GetDeployment(GetDeploymentRequest, CallOptions)

public virtual Deployment GetDeployment(GetDeploymentRequest request, CallOptions options)

Gets the deployment with the specified name.

Parameters
Name	Description
`request`	`GetDeploymentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Deployment`	The response received from the server.

GetDeployment(GetDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual Deployment GetDeployment(GetDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the deployment with the specified name.

Parameters
Name	Description
`request`	`GetDeploymentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Deployment`	The response received from the server.

GetDeploymentAsync(GetDeploymentRequest, CallOptions)

public virtual AsyncUnaryCall<Deployment> GetDeploymentAsync(GetDeploymentRequest request, CallOptions options)

Gets the deployment with the specified name.

Parameters
Name	Description
`request`	`GetDeploymentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallDeployment`	The call object.

GetDeploymentAsync(GetDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Deployment> GetDeploymentAsync(GetDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the deployment with the specified name.

Parameters
Name	Description
`request`	`GetDeploymentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallDeployment`	The call object.

GetInstallStatus(GetInstallStatusRequest, CallOptions)

public virtual InstallStatus GetInstallStatus(GetInstallStatusRequest request, CallOptions options)

Fetches the install status of a developer mode deployment.

Parameters
Name	Description
`request`	`GetInstallStatusRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`InstallStatus`	The response received from the server.

GetInstallStatus(GetInstallStatusRequest, Metadata, DateTime?, CancellationToken)

public virtual InstallStatus GetInstallStatus(GetInstallStatusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Fetches the install status of a developer mode deployment.

Parameters
Name	Description
`request`	`GetInstallStatusRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`InstallStatus`	The response received from the server.

GetInstallStatusAsync(GetInstallStatusRequest, CallOptions)

public virtual AsyncUnaryCall<InstallStatus> GetInstallStatusAsync(GetInstallStatusRequest request, CallOptions options)

Fetches the install status of a developer mode deployment.

Parameters
Name	Description
`request`	`GetInstallStatusRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallInstallStatus`	The call object.

GetInstallStatusAsync(GetInstallStatusRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InstallStatus> GetInstallStatusAsync(GetInstallStatusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Fetches the install status of a developer mode deployment.

Parameters
Name	Description
`request`	`GetInstallStatusRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallInstallStatus`	The call object.

InstallDeployment(InstallDeploymentRequest, CallOptions)

public virtual Empty InstallDeployment(InstallDeploymentRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

InstallDeployment(InstallDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty InstallDeployment(InstallDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

InstallDeploymentAsync(InstallDeploymentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> InstallDeploymentAsync(InstallDeploymentRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

InstallDeploymentAsync(InstallDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> InstallDeploymentAsync(InstallDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

ListDeployments(ListDeploymentsRequest, CallOptions)

public virtual ListDeploymentsResponse ListDeployments(ListDeploymentsRequest request, CallOptions options)

Lists all deployments in a particular project.

Parameters
Name	Description
`request`	`ListDeploymentsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListDeploymentsResponse`	The response received from the server.

ListDeployments(ListDeploymentsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDeploymentsResponse ListDeployments(ListDeploymentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all deployments in a particular project.

Parameters
Name	Description
`request`	`ListDeploymentsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListDeploymentsResponse`	The response received from the server.

ListDeploymentsAsync(ListDeploymentsRequest, CallOptions)

public virtual AsyncUnaryCall<ListDeploymentsResponse> ListDeploymentsAsync(ListDeploymentsRequest request, CallOptions options)

Lists all deployments in a particular project.

Parameters
Name	Description
`request`	`ListDeploymentsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallListDeploymentsResponse`	The call object.

ListDeploymentsAsync(ListDeploymentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDeploymentsResponse> ListDeploymentsAsync(ListDeploymentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all deployments in a particular project.

Parameters
Name	Description
`request`	`ListDeploymentsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallListDeploymentsResponse`	The call object.

NewInstance(ClientBaseConfiguration)

protected override GSuiteAddOns.GSuiteAddOnsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`GSuiteAddOnsGSuiteAddOnsClient`

Overrides

ClientBase<GSuiteAddOns.GSuiteAddOnsClient>.NewInstance(ClientBase.ClientBaseConfiguration)

ReplaceDeployment(ReplaceDeploymentRequest, CallOptions)

public virtual Deployment ReplaceDeployment(ReplaceDeploymentRequest request, CallOptions options)

Creates or replaces a deployment with the specified name.

Parameters
Name	Description
`request`	`ReplaceDeploymentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Deployment`	The response received from the server.

ReplaceDeployment(ReplaceDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual Deployment ReplaceDeployment(ReplaceDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates or replaces a deployment with the specified name.

Parameters
Name	Description
`request`	`ReplaceDeploymentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Deployment`	The response received from the server.

ReplaceDeploymentAsync(ReplaceDeploymentRequest, CallOptions)

public virtual AsyncUnaryCall<Deployment> ReplaceDeploymentAsync(ReplaceDeploymentRequest request, CallOptions options)

Creates or replaces a deployment with the specified name.

Parameters
Name	Description
`request`	`ReplaceDeploymentRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallDeployment`	The call object.

ReplaceDeploymentAsync(ReplaceDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Deployment> ReplaceDeploymentAsync(ReplaceDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates or replaces a deployment with the specified name.

Parameters
Name	Description
`request`	`ReplaceDeploymentRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallDeployment`	The call object.

UninstallDeployment(UninstallDeploymentRequest, CallOptions)

public virtual Empty UninstallDeployment(UninstallDeploymentRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

UninstallDeployment(UninstallDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty UninstallDeployment(UninstallDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

UninstallDeploymentAsync(UninstallDeploymentRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> UninstallDeploymentAsync(UninstallDeploymentRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.

UninstallDeploymentAsync(UninstallDeploymentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> UninstallDeploymentAsync(UninstallDeploymentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`DateTime` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCallEmpty`	The call object.