Google Cloud Discovery Engine V1 Client - Class ListIdentityMappingsRequest (1.6.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListIdentityMappingsRequest.

Request message for IdentityMappingStoreService.ListIdentityMappings

Generated from protobuf message google.cloud.discoveryengine.v1.ListIdentityMappingsRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ identity_mapping_store string

Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

↳ page_size int

Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.

↳ page_token string

A page token, received from a previous ListIdentityMappings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIdentityMappings must match the call that provided the page token.

getIdentityMappingStore

Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Returns
Type Description
string

setIdentityMappingStore

Required. The name of the Identity Mapping Store to list Identity Mapping Entries in. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.

Returns
Type Description
int

setPageSize

Maximum number of IdentityMappings to return. If unspecified, defaults to 2000. The maximum allowed value is 10000. Values above 10000 will be coerced to 10000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous ListIdentityMappings call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIdentityMappings must match the call that provided the page token.

Returns
Type Description
string

setPageToken

A page token, received from a previous ListIdentityMappings call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListIdentityMappings must match the call that provided the page token.

Parameter
Name Description
var string
Returns
Type Description
$this