Google Cloud Apigee Registry V1 Client - Class ListApiDeploymentsRequest (1.0.0)

Reference documentation and code samples for the Google Cloud Apigee Registry V1 Client class ListApiDeploymentsRequest.

Request message for ListApiDeployments.

Generated from protobuf message google.cloud.apigeeregistry.v1.ListApiDeploymentsRequest

Namespace

Google \ Cloud \ ApigeeRegistry \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/*

↳ page_size int

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

↳ page_token string

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

↳ filter string

An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

getParent

Required. The parent, which owns this collection of deployments.

Format: projects/*/locations/*/apis/*

Returns
Type Description
string

setParent

Required. The parent, which owns this collection of deployments.

Format: projects/*/locations/*/apis/*

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 50 values will be returned. The maximum 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 50 values will be returned. The maximum 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 ListApiDeployments call.

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

Returns
Type Description
string

setPageToken

A page token, received from a previous ListApiDeployments call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

Returns
Type Description
string

setFilter

An expression that can be used to filter the list. Filters use the Common Expression Language and can refer to all message fields.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent, which owns this collection of deployments. Format: projects/*/locations/*/apis/* Please see Google\Cloud\ApigeeRegistry\V1\RegistryClient::apiName() for help formatting this field.

Returns
Type Description
Google\Cloud\ApigeeRegistry\V1\ListApiDeploymentsRequest