Google Certificate Authority Service V1 Client - Class ListCaPoolsRequest (1.4.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
NameDescription
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
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Returns
TypeDescription
string

setPageToken

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

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

Returns
TypeDescription
string

setFilter

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Optional. Specify how the results should be sorted.

Returns
TypeDescription
string

setOrderBy

Optional. Specify how the results should be sorted.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\Security\PrivateCA\V1\ListCaPoolsRequest