Google Certificate Authority Service V1 Client - Class ListCertificatesRequest (1.7.3)

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

Request message for CertificateAuthorityService.ListCertificates.

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

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 Certificates, in the format projects/*/locations/*/caPools/*.

↳ page_size int

Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.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 ListCertificatesResponse.next_page_token.

↳ filter string

Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.

↳ order_by string

Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Limit on the number of Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.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 Certificates to include in the response. Further Certificates can subsequently be obtained by including the ListCertificatesResponse.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 ListCertificatesResponse.next_page_token.

Returns
Type Description
string

setPageToken

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.

Returns
Type Description
string

setFilter

Optional. Only include resources that match the filter in the response. For details on supported filters and syntax, see Certificates Filtering documentation.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.

Returns
Type Description
string

setOrderBy

Optional. Specify how the results should be sorted. For details on supported fields and syntax, see Certificates Sorting documentation.

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 Certificates, in the format projects/*/locations/*/caPools/*. Please see Google\Cloud\Security\PrivateCA\V1\CertificateAuthorityServiceClient::caPoolName() for help formatting this field.

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