Cloud KMS V1 Client - Class ListSingleTenantHsmInstancesRequest (2.6.0)

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

Request message for HsmManagement.ListSingleTenantHsmInstances .

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

Namespace

Google \ Cloud \ Kms \ 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 SingleTenantHsmInstances to list, in the format projects/*/locations/* .

↳ page_size
int

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

↳ page_token
string

Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstancesResponse.next_page_token .

↳ filter
string

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

↳ order_by
string

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 .

↳ show_deleted
bool

Optional. If set to true, HsmManagement.ListSingleTenantHsmInstances will also return SingleTenantHsmInstances in DELETED state.

getParent

Required. The resource name of the location associated with the SingleTenantHsmInstances to list, in the format projects/*/locations/* .

Returns
Type
Description
string

setParent

Required. The resource name of the location associated with the SingleTenantHsmInstances to list, in the format projects/*/locations/* .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

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

Returns
Type
Description
string

setPageToken

Optional. Optional pagination token, returned earlier via ListSingleTenantHsmInstancesResponse.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.ListSingleTenantHsmInstances will also return SingleTenantHsmInstances in DELETED state.

Returns
Type
Description
bool

setShowDeleted

Optional. If set to true, HsmManagement.ListSingleTenantHsmInstances will also return SingleTenantHsmInstances 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 location associated with the SingleTenantHsmInstances to list, in the format projects/*/locations/* . Please see HsmManagementClient::locationName() for help formatting this field.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: