Google Workspace Add-ons V1 Client - Class Deployment (0.1.6)

Reference documentation and code samples for the Google Workspace Add-ons V1 Client class Deployment.

A Google Workspace Add-on deployment

Generated from protobuf message google.cloud.gsuiteaddons.v1.Deployment

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The deployment resource name. Example: projects/123/deployments/my_deployment.

↳ oauth_scopes array

The list of Google OAuth scopes for which to request consent from the end user before executing an add-on endpoint.

↳ add_ons Google\Cloud\GSuiteAddOns\V1\AddOns

The Google Workspace Add-on configuration.

↳ etag string

This value is computed by the server based on the version of the deployment in storage, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

getName

The deployment resource name.

Example: projects/123/deployments/my_deployment.

Returns
TypeDescription
string

setName

The deployment resource name.

Example: projects/123/deployments/my_deployment.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOauthScopes

The list of Google OAuth scopes for which to request consent from the end user before executing an add-on endpoint.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setOauthScopes

The list of Google OAuth scopes for which to request consent from the end user before executing an add-on endpoint.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getAddOns

The Google Workspace Add-on configuration.

Returns
TypeDescription
Google\Cloud\GSuiteAddOns\V1\AddOns|null

hasAddOns

clearAddOns

setAddOns

The Google Workspace Add-on configuration.

Parameter
NameDescription
var Google\Cloud\GSuiteAddOns\V1\AddOns
Returns
TypeDescription
$this

getEtag

This value is computed by the server based on the version of the deployment in storage, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
TypeDescription
string

setEtag

This value is computed by the server based on the version of the deployment in storage, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this