Secret Manager V1 Client - Class ListSecretsRequest (1.11.0)

Reference documentation and code samples for the Secret Manager V1 Client class ListSecretsRequest.

Request message for SecretManagerService.ListSecrets.

Generated from protobuf message google.cloud.secretmanager.v1.ListSecretsRequest

Methods

build

Parameter
NameDescription
parent string

Required. The resource name of the project associated with the Secrets, in the format projects/*. Please see {@see \Google\Cloud\SecretManager\V1\SecretManagerServiceClient::projectName()} for help formatting this field.

Returns
TypeDescription
Google\Cloud\SecretManager\V1\ListSecretsRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the project associated with the Secrets, in the format projects/*.

↳ page_size int

Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

↳ page_token string

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

↳ filter string

Optional. Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all secrets are listed.

getParent

Required. The resource name of the project associated with the Secrets, in the format projects/*.

Returns
TypeDescription
string

setParent

Required. The resource name of the project associated with the Secrets, in the format projects/*.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

Returns
TypeDescription
int

setPageSize

Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

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

Returns
TypeDescription
string

setPageToken

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Optional. Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all secrets are listed.

Returns
TypeDescription
string

setFilter

Optional. Filter string, adhering to the rules in List-operation filtering. List only secrets matching the filter. If filter is empty, all secrets are listed.

Parameter
NameDescription
var string
Returns
TypeDescription
$this