Google Certificate Authority Service V1 Client - Class ListCaPoolsRequest (1.7.2)

Reference documentation and code samples for the Google Certificate Authority Service V1 Client class ListCaPoolsRequest.

Request message for CertificateAuthorityService.ListCaPools.

Generated from protobuf message google.cloud.security.privateca.v1.ListCaPoolsRequest

Namespace

Google \ Cloud \ Security \ PrivateCA \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the location associated with the CaPools, in the format projects/*/locations/*.

↳ page_size int

Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

↳ page_token string

Optional. Pagination token, returned earlier via ListCaPoolsResponse.next_page_token.

↳ filter string

Optional. Only include resources that match the filter in the response.

↳ order_by string

Optional. Specify how the results should be sorted.

getParent

Required. The resource name of the location associated with the CaPools, in the format projects/*/locations/*.

Returns
Type Description
string

setParent

Required. The resource name of the location associated with the CaPools, in the format projects/*/locations/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

Returns
Type Description
int

setPageSize

Optional. Limit on the number of CaPools to include in the response. Further CaPools can subsequently be obtained by including the ListCaPoolsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. Pagination token, returned earlier via ListCaPoolsResponse.next_page_token.

Returns
Type Description
string

setPageToken

Optional. Pagination token, returned earlier via ListCaPoolsResponse.next_page_token.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Only include resources that match the filter in the response.

Returns
Type Description
string

setFilter

Optional. Only include resources that match the filter in the response.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Specify how the results should be sorted.

Returns
Type Description
string

setOrderBy

Optional. Specify how the results should be sorted.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the location associated with the CaPools, in the format projects/*/locations/*. Please see Google\Cloud\Security\PrivateCA\V1\CertificateAuthorityServiceClient::locationName() for help formatting this field.

Returns
Type Description
Google\Cloud\Security\PrivateCA\V1\ListCaPoolsRequest