Google Cloud Functions V2 Client - Class ListFunctionsRequest (1.3.1)

Version 1.3.1

• 2.0.0 (latest)
• 2.0.0-RC1
• 1.7.0
• 1.6.5
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.0
• 1.1.2
• 1.0.3

Reference documentation and code samples for the Google Cloud Functions V2 Client class ListFunctionsRequest.

Request for the ListFunctions method.

Generated from protobuf message google.cloud.functions.v2.ListFunctionsRequest

Namespace

Google \ Cloud \ Functions \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ parent	string Required. The project and location from which the function should be listed, specified in the format projects/*/locations/* If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.
↳ page_size	int Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters.
↳ page_token	string The value returned by the last ListFunctionsResponse; indicates that this is a continuation of a prior ListFunctions call, and that the system should return the next page of data.
↳ filter	string The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
↳ order_by	string The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.

getParent

Required. The project and location from which the function should be listed, specified in the format projects/*/locations/* If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.

Returns
Type	Description
string

setParent

Required. The project and location from which the function should be listed, specified in the format projects/*/locations/* If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPageSize

Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters.

Returns
Type	Description
int

setPageSize

Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getPageToken

The value returned by the last ListFunctionsResponse; indicates that this is a continuation of a prior ListFunctions call, and that the system should return the next page of data.

Returns
Type	Description
string

setPageToken

The value returned by the last ListFunctionsResponse; indicates that this is a continuation of a prior ListFunctions call, and that the system should return the next page of data.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFilter

The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Returns
Type	Description
string

setFilter

The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getOrderBy

The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending.

See https://google.aip.dev/132#ordering.

Returns
Type	Description
string

setOrderBy

The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending.

See https://google.aip.dev/132#ordering.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameter
Name	Description
parent	string Required. The project and location from which the function should be listed, specified in the format projects/*/locations/* If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations. Please see Google\Cloud\Functions\V2\FunctionServiceClient::locationName() for help formatting this field.

Returns
Type	Description
Google\Cloud\Functions\V2\ListFunctionsRequest