Google Cloud Sql Admin V1 Client - Class ListBlueGreenDeploymentsRequest (1.13.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class ListBlueGreenDeploymentsRequest.

The request message for listing blue-green deployment resources.

Generated from protobuf message google.cloud.sql.v1.ListBlueGreenDeploymentsRequest

Namespace

Google \ Cloud \ Sql \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location}

↳ page_size int

Optional. The maximum number of deployments to return. The service may return fewer deployments than this value. If unspecified, at most 500 deployments are returned. The maximum value is 1000; values above 1000 are treated as 1000.

↳ page_token string

Optional. A page token, received from a previous ListBlueGreenDeployments call. Provide this to retrieve the subsequent page.

↳ filter string

Optional. A filter expression that filters the results.

↳ order_by string

Optional. A comma-separated list of fields to order the results by.

getParent

Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location}

Returns
Type Description
string

setParent

Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. The maximum number of deployments to return. The service may return fewer deployments than this value. If unspecified, at most 500 deployments are returned. The maximum value is 1000; values above 1000 are treated as 1000.

Returns
Type Description
int

setPageSize

Optional. The maximum number of deployments to return. The service may return fewer deployments than this value. If unspecified, at most 500 deployments are returned. The maximum value is 1000; values above 1000 are treated as 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. A page token, received from a previous ListBlueGreenDeployments call. Provide this to retrieve the subsequent page.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListBlueGreenDeployments call. Provide this to retrieve the subsequent page.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. A filter expression that filters the results.

Returns
Type Description
string

setFilter

Optional. A filter expression that filters the results.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. A comma-separated list of fields to order the results by.

Returns
Type Description
string

setOrderBy

Optional. A comma-separated list of fields to order the results by.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location} Please see BlueGreenDeploymentsServiceClient::locationName() for help formatting this field.

Returns
Type Description
ListBlueGreenDeploymentsRequest