Google Cloud Discovery Engine V1beta Client - Class DocumentServiceClient (0.11.3)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class DocumentServiceClient.

Service Description: Service for ingesting Document information of the customer's website.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createDocument

Creates a Document.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient::createDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\CreateDocumentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DiscoveryEngine\V1beta\Document`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\CreateDocumentRequest;
use Google\Cloud\DiscoveryEngine\V1beta\Document;

/**
 * @param string $formattedParent The parent resource name, such as
 *                                `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Please see
 *                                {@see DocumentServiceClient::branchName()} for help formatting this field.
 * @param string $documentId      The ID to use for the
 *                                [Document][google.cloud.discoveryengine.v1beta.Document], which becomes the
 *                                final component of the
 *                                [Document.name][google.cloud.discoveryengine.v1beta.Document.name].
 *
 *                                If the caller does not have permission to create the
 *                                [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 *                                whether or not it exists, a `PERMISSION_DENIED` error is returned.
 *
 *                                This field must be unique among all
 *                                [Document][google.cloud.discoveryengine.v1beta.Document]s with the same
 *                                [parent][google.cloud.discoveryengine.v1beta.CreateDocumentRequest.parent].
 *                                Otherwise, an `ALREADY_EXISTS` error is returned.
 *
 *                                This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 *                                standard with a length limit of 63 characters. Otherwise, an
 *                                `INVALID_ARGUMENT` error is returned.
 */
function create_document_sample(string $formattedParent, string $documentId): void
{
    // Create a client.
    $documentServiceClient = new DocumentServiceClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new CreateDocumentRequest())
        ->setParent($formattedParent)
        ->setDocument($document)
        ->setDocumentId($documentId);

    // Call the API and handle any network failures.
    try {
        /** @var Document $response */
        $response = $documentServiceClient->createDocument($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DocumentServiceClient::branchName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[BRANCH]'
    );
    $documentId = '[DOCUMENT_ID]';

    create_document_sample($formattedParent, $documentId);
}

deleteDocument

Deletes a Document.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient::deleteDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\DeleteDocumentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\DeleteDocumentRequest;

/**
 * @param string $formattedName Full resource name of
 *                              [Document][google.cloud.discoveryengine.v1beta.Document], such as
 *                              `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
 *
 *                              If the caller does not have permission to delete the
 *                              [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 *                              whether or not it exists, a `PERMISSION_DENIED` error is returned.
 *
 *                              If the [Document][google.cloud.discoveryengine.v1beta.Document] to delete
 *                              does not exist, a `NOT_FOUND` error is returned. Please see
 *                              {@see DocumentServiceClient::documentName()} for help formatting this field.
 */
function delete_document_sample(string $formattedName): void
{
    // Create a client.
    $documentServiceClient = new DocumentServiceClient();

    // Prepare the request message.
    $request = (new DeleteDocumentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        $documentServiceClient->deleteDocument($request);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DocumentServiceClient::documentName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[BRANCH]',
        '[DOCUMENT]'
    );

    delete_document_sample($formattedName);
}

getDocument

Gets a Document.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient::getDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\GetDocumentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DiscoveryEngine\V1beta\Document`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Document;
use Google\Cloud\DiscoveryEngine\V1beta\GetDocumentRequest;

/**
 * @param string $formattedName Full resource name of
 *                              [Document][google.cloud.discoveryengine.v1beta.Document], such as
 *                              `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
 *
 *                              If the caller does not have permission to access the
 *                              [Document][google.cloud.discoveryengine.v1beta.Document], regardless of
 *                              whether or not it exists, a `PERMISSION_DENIED` error is returned.
 *
 *                              If the requested [Document][google.cloud.discoveryengine.v1beta.Document]
 *                              does not exist, a `NOT_FOUND` error is returned. Please see
 *                              {@see DocumentServiceClient::documentName()} for help formatting this field.
 */
function get_document_sample(string $formattedName): void
{
    // Create a client.
    $documentServiceClient = new DocumentServiceClient();

    // Prepare the request message.
    $request = (new GetDocumentRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Document $response */
        $response = $documentServiceClient->getDocument($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = DocumentServiceClient::documentName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[BRANCH]',
        '[DOCUMENT]'
    );

    get_document_sample($formattedName);
}

importDocuments

Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created.

Note: It is possible for a subset of the Documents to be successfully updated.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient::importDocumentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ImportDocumentsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\ImportDocumentsRequest;
use Google\Cloud\DiscoveryEngine\V1beta\ImportDocumentsResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent branch resource name, such as
 *                                `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 *                                Requires create/update permission. Please see
 *                                {@see DocumentServiceClient::branchName()} for help formatting this field.
 */
function import_documents_sample(string $formattedParent): void
{
    // Create a client.
    $documentServiceClient = new DocumentServiceClient();

    // Prepare the request message.
    $request = (new ImportDocumentsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $documentServiceClient->importDocuments($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var ImportDocumentsResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DocumentServiceClient::branchName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[BRANCH]'
    );

    import_documents_sample($formattedParent);
}

listDocuments

Gets a list of Documents.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient::listDocumentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ListDocumentsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Document;
use Google\Cloud\DiscoveryEngine\V1beta\ListDocumentsRequest;

/**
 * @param string $formattedParent The parent branch resource name, such as
 *                                `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 *                                Use `default_branch` as the branch ID, to list documents under the default
 *                                branch.
 *
 *                                If the caller does not have permission to list
 *                                [Document][google.cloud.discoveryengine.v1beta.Document]s under this
 *                                branch, regardless of whether or not this branch exists, a
 *                                `PERMISSION_DENIED` error is returned. Please see
 *                                {@see DocumentServiceClient::branchName()} for help formatting this field.
 */
function list_documents_sample(string $formattedParent): void
{
    // Create a client.
    $documentServiceClient = new DocumentServiceClient();

    // Prepare the request message.
    $request = (new ListDocumentsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $documentServiceClient->listDocuments($request);

        /** @var Document $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DocumentServiceClient::branchName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[BRANCH]'
    );

    list_documents_sample($formattedParent);
}

purgeDocuments

Permanently deletes all selected Documents in a branch.

This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments.

To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient::purgeDocumentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\PurgeDocumentsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\PurgeDocumentsRequest;
use Google\Cloud\DiscoveryEngine\V1beta\PurgeDocumentsResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent resource name, such as
 *                                `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Please see
 *                                {@see DocumentServiceClient::branchName()} for help formatting this field.
 * @param string $filter          Filter matching documents to purge. Only currently supported
 *                                value is
 *                                `*` (all items).
 */
function purge_documents_sample(string $formattedParent, string $filter): void
{
    // Create a client.
    $documentServiceClient = new DocumentServiceClient();

    // Prepare the request message.
    $request = (new PurgeDocumentsRequest())
        ->setParent($formattedParent)
        ->setFilter($filter);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $documentServiceClient->purgeDocuments($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var PurgeDocumentsResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = DocumentServiceClient::branchName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATA_STORE]',
        '[BRANCH]'
    );
    $filter = '[FILTER]';

    purge_documents_sample($formattedParent, $filter);
}

updateDocument

Updates a Document.

The async variant is Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient::updateDocumentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\UpdateDocumentRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\DiscoveryEngine\V1beta\Document`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1beta\Client\DocumentServiceClient;
use Google\Cloud\DiscoveryEngine\V1beta\Document;
use Google\Cloud\DiscoveryEngine\V1beta\UpdateDocumentRequest;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_document_sample(): void
{
    // Create a client.
    $documentServiceClient = new DocumentServiceClient();

    // Prepare the request message.
    $document = new Document();
    $request = (new UpdateDocumentRequest())
        ->setDocument($document);

    // Call the API and handle any network failures.
    try {
        /** @var Document $response */
        $response = $documentServiceClient->updateDocument($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

createDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\CreateDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\DeleteDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\GetDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

importDocumentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ImportDocumentsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDocumentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\ListDocumentsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

purgeDocumentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\PurgeDocumentsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateDocumentAsync

Parameters
Name	Description
`request`	`Google\Cloud\DiscoveryEngine\V1beta\UpdateDocumentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\LongRunning\Client\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::branchName

Formats a string containing the fully-qualified path to represent a branch resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`branch`	`string`

Returns
Type	Description
`string`	The formatted branch resource.

static::documentName

Formats a string containing the fully-qualified path to represent a document resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`

Returns
Type	Description
`string`	The formatted document resource.

static::fhirStoreName

Formats a string containing the fully-qualified path to represent a fhir_store resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataset`	`string`
`fhirStore`	`string`

Returns
Type	Description
`string`	The formatted fhir_store resource.

static::projectLocationCollectionDataStoreBranchName

Formats a string containing the fully-qualified path to represent a project_location_collection_data_store_branch resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`branch`	`string`

Returns
Type	Description
`string`	The formatted project_location_collection_data_store_branch resource.

static::projectLocationCollectionDataStoreBranchDocumentName

Formats a string containing the fully-qualified path to represent a project_location_collection_data_store_branch_document resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`collection`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`

Returns
Type	Description
`string`	The formatted project_location_collection_data_store_branch_document resource.

static::projectLocationDataStoreBranchName

Formats a string containing the fully-qualified path to represent a project_location_data_store_branch resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`branch`	`string`

Returns
Type	Description
`string`	The formatted project_location_data_store_branch resource.

static::projectLocationDataStoreBranchDocumentName

Formats a string containing the fully-qualified path to represent a project_location_data_store_branch_document resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`dataStore`	`string`
`branch`	`string`
`document`	`string`

Returns
Type	Description
`string`	The formatted project_location_data_store_branch_document resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

branch: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}
document: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}
fhirStore: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}
projectLocationCollectionDataStoreBranch: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
projectLocationCollectionDataStoreBranchDocument: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}
projectLocationDataStoreBranch: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}
projectLocationDataStoreBranchDocument: projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.