Google Workspace Add-ons V1 Client - Class ListDeploymentsRequest (0.3.4)

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

Request message to list deployments for a project.

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

Namespace

Google \ Cloud \ GSuiteAddOns \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Name of the project in which to create the deployment. Example: projects/my_project.

↳ page_size int

The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 1000 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

A page token, received from a previous ListDeployments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDeployments must match the call that provided the page token.

getParent

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

Returns
Type Description
string

setParent

Required. Name of the project in which to create the deployment.

Example: projects/my_project.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of deployments to return. The service may return fewer than this value.

If unspecified, at most 1000 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

The maximum number of deployments to return. The service may return fewer than this value.

If unspecified, at most 1000 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous ListDeployments call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDeployments must match the call that provided the page token.

Returns
Type Description
string

setPageToken

A page token, received from a previous ListDeployments call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDeployments must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Name of the project in which to create the deployment.

Example: projects/my_project. Please see Google\Cloud\GSuiteAddOns\V1\GSuiteAddOnsClient::projectName() for help formatting this field.

Returns
Type Description
Google\Cloud\GSuiteAddOns\V1\ListDeploymentsRequest