Google Cloud Discovery Engine V1 Client - Class BatchGetDocumentsMetadataRequest (1.1.0)

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

Request message for DocumentService.BatchGetDocumentsMetadata method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
↳ matcher Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest\Matcher

Required. Matcher for the Documents.

getParent

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Returns
Type Description
string

setParent

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

Parameter
Name Description
var string
Returns
Type Description
$this

getMatcher

Required. Matcher for the Documents.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest\Matcher|null

hasMatcher

clearMatcher

setMatcher

Required. Matcher for the Documents.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest\Matcher
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Please see Google\Cloud\DiscoveryEngine\V1\DocumentServiceClient::branchName() for help formatting this field.
Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\BatchGetDocumentsMetadataRequest