Cloud KMS V1 Client - Class ListSingleTenantHsmInstanceProposalsRequest (2.8.0)

Reference documentation and code samples for the Cloud KMS V1 Client class ListSingleTenantHsmInstanceProposalsRequest.

Request message for HsmManagement.ListSingleTenantHsmInstanceProposals.

Generated from protobuf message google.cloud.kms.v1.ListSingleTenantHsmInstanceProposalsRequest

Namespace

Google \ Cloud \ Kms \ V1

Methods

__construct

Constructor.

Parameter
Name Description
data mixed

getParent

Required. The resource name of the single tenant HSM instance associated with the SingleTenantHsmInstanceProposals to list, in the format projects/*/locations/*/singleTenantHsmInstances/*.

Returns
Type Description
string

setParent

Required. The resource name of the single tenant HSM instance associated with the SingleTenantHsmInstanceProposals to list, in the format projects/*/locations/*/singleTenantHsmInstances/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Optional limit on the number of SingleTenantHsmInstanceProposals to include in the response. Further SingleTenantHsmInstanceProposals can subsequently be obtained by including the ListSingleTenantHsmInstanceProposalsResponse.next_page_token in a subsequent request. If unspecified, the server will pick an appropriate default.

Returns
Type Description
int

setPageSize

Optional. Optional limit on the number of SingleTenantHsmInstanceProposals to include in the response. Further SingleTenantHsmInstanceProposals can subsequently be obtained by including the ListSingleTenantHsmInstanceProposalsResponse.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. Optional pagination token, returned earlier via ListSingleTenantHsmInstanceProposalsResponse.next_page_token.

Returns
Type Description
string

setPageToken

Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstanceProposalsResponse.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 more information, see Sorting and filtering list results.

Returns
Type Description
string

setFilter

Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.

Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

Returns
Type Description
string

setOrderBy

Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.

Parameter
Name Description
var string
Returns
Type Description
$this

getShowDeleted

Optional. If set to true, HsmManagement.ListSingleTenantHsmInstanceProposals will also return SingleTenantHsmInstanceProposals in DELETED state.

Returns
Type Description
bool

setShowDeleted

Optional. If set to true, HsmManagement.ListSingleTenantHsmInstanceProposals will also return SingleTenantHsmInstanceProposals in DELETED state.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The resource name of the single tenant HSM instance associated with the SingleTenantHsmInstanceProposals to list, in the format projects/*/locations/*/singleTenantHsmInstances/*. Please see HsmManagementClient::singleTenantHsmInstanceName() for help formatting this field.
Returns
Type Description
ListSingleTenantHsmInstanceProposalsRequest