Secret Manager V1 Client - Class ListSecretsRequest (2.3.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

Namespace

Google \ Cloud \ SecretManager \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var int
Returns
Type Description
$this

getPageToken

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

Returns
Type Description
string

setPageToken

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

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the project associated with the Secrets, in the format projects/* or projects/*/locations/* Please see SecretManagerServiceClient::projectName() for help formatting this field.
Returns
Type Description
ListSecretsRequest