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

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
NameDescription
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
TypeDescription
string

setParent

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

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

getPageToken

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

Returns
TypeDescription
string

setPageToken

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

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

getOrderBy

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

Returns
TypeDescription
string

setOrderBy

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

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