DocumentServiceClient

DocumentServiceClient

Service to call Cloud DocumentAI to manage document collection (dataset).

Constructor

new DocumentServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of DocumentServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new DocumentServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkBatchDeleteDocumentsProgress(name) → {Promise}

Check the status of the long running operation returned by batchDeleteDocuments().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dataset resource name.
   *  Format:
   *  projects/{project}/locations/{location}/processors/{processor}/dataset
   */
  // const dataset = 'abc123'
  /**
   *  Required. Dataset documents input. If given `filter`, all documents
   *  satisfying the filter will be deleted. If given documentIds, a maximum of
   *  50 documents can be deleted in a batch. The request will be rejected if
   *  more than 50 document_ids are provided.
   */
  // const datasetDocuments = {}

  // Imports the Documentai library
  const {DocumentServiceClient} = require('@google-cloud/documentai').v1beta3;

  // Instantiates a client
  const documentaiClient = new DocumentServiceClient();

  async function callBatchDeleteDocuments() {
    // Construct request
    const request = {
      dataset,
      datasetDocuments,
    };

    // Run request
    const [operation] = await documentaiClient.batchDeleteDocuments(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callBatchDeleteDocuments();

(async) checkImportDocumentsProgress(name) → {Promise}

Check the status of the long running operation returned by importDocuments().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The dataset resource name.
   *  Format:
   *  projects/{project}/locations/{location}/processors/{processor}/dataset
   */
  // const dataset = 'abc123'
  /**
   *  Required. The Cloud Storage uri containing raw documents that must be
   *  imported.
   */
  // const batchDocumentsImportConfigs = [1,2,3,4]

  // Imports the Documentai library
  const {DocumentServiceClient} = require('@google-cloud/documentai').v1beta3;

  // Instantiates a client
  const documentaiClient = new DocumentServiceClient();

  async function callImportDocuments() {
    // Construct request
    const request = {
      dataset,
      batchDocumentsImportConfigs,
    };

    // Run request
    const [operation] = await documentaiClient.importDocuments(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportDocuments();

(async) checkUpdateDatasetProgress(name) → {Promise}

Check the status of the long running operation returned by updateDataset().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The `name` field of the `Dataset` is used to identify the
   *  resource to be updated.
   */
  // const dataset = {}
  /**
   *  The update mask applies to the resource.
   */
  // const updateMask = {}

  // Imports the Documentai library
  const {DocumentServiceClient} = require('@google-cloud/documentai').v1beta3;

  // Instantiates a client
  const documentaiClient = new DocumentServiceClient();

  async function callUpdateDataset() {
    // Construct request
    const request = {
      dataset,
    };

    // Run request
    const [operation] = await documentaiClient.updateDataset(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateDataset();

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

datasetPath(project, location, processor) → {string}

Return a fully-qualified dataset resource name string.

Parameters:
Name Type Description
project string
location string
processor string
Returns:
Type Description
string

Resource name string.

datasetSchemaPath(project, location, processor) → {string}

Return a fully-qualified datasetSchema resource name string.

Parameters:
Name Type Description
project string
location string
processor string
Returns:
Type Description
string

Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

evaluationPath(project, location, processor, processor_version, evaluation) → {string}

Return a fully-qualified evaluation resource name string.

Parameters:
Name Type Description
project string
location string
processor string
processor_version string
evaluation string
Returns:
Type Description
string

Resource name string.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listDocumentsAsync(request, optionsopt) → {Object}

Equivalent to listDocuments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
dataset string

Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
pageSize number

The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken string

A page token, received from a previous ListDocuments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDocuments must match the call that provided the page token.
filter string <optional>

Optional. Query to filter the documents based on https://google.aip.dev/160.

Currently support query strings are:

SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED

  • LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED
  • DisplayName=\"file_name.pdf\"
  • EntityType=abc/def
  • TagName=\"auto-labeling-running\"|\"sampled\"

Note:

  • Only AND, = and != are supported. e.g. DisplayName=file_name AND EntityType!=abc IS supported.
  • Wildcard * is supported only in DisplayName filter
  • No duplicate filter keys are allowed, e.g. EntityType=a AND EntityType=b is NOT supported.
  • String match is case sensitive (for filter DisplayName & EntityType).
returnTotalSize boolean <optional>

Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size.

Enabling this flag may adversely impact performance.

Defaults to false.
skip number <optional>

Optional. Number of results to skip beginning from the page_token if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values will be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, ListDocumentsResponse.document_metadata and ListDocumentsResponse.next_page_token will be empty.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing DocumentMetadata. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
  /**
   * This snippet 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.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the dataset to be listed.
   *  Format:
   *  projects/{project}/locations/{location}/processors/{processor}/dataset
   */
  // const dataset = 'abc123'
  /**
   *  The maximum number of documents to return. The service may return
   *  fewer than this value.
   *  If unspecified, at most 20 documents will be returned.
   *  The maximum value is 100; values above 100 will be coerced to 100.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListDocuments` call.
   *  Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to `ListDocuments`
   *  must match the call that provided the page token.
   */
  // const pageToken = 'abc123'
  /**
   *  Optional. Query to filter the documents based on
   *  https://google.aip.dev/160.
   *  ## Currently support query strings are:
   *  `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED`
   *  - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED`
   *  - `DisplayName=\"file_name.pdf\"`
   *  - `EntityType=abc/def`
   *  - `TagName=\"auto-labeling-running\"|\"sampled\"`
   *  Note:
   *  - Only `AND`, `=` and `!=` are supported.
   *      e.g. `DisplayName=file_name AND EntityType!=abc` IS supported.
   *  - Wildcard `*` is supported only in `DisplayName` filter
   *  - No duplicate filter keys are allowed,
   *      e.g. `EntityType=a AND EntityType=b` is NOT supported.
   *  - String match is case sensitive (for filter `DisplayName` & `EntityType`).
   */
  // const filter = 'abc123'
  /**
   *  Optional. Controls if the request requires a total size of matched
   *  documents. See
   *  ListDocumentsResponse.total_size google.cloud.documentai.v1beta3.ListDocumentsResponse.total_size.
   *  Enabling this flag may adversely impact performance.
   *  Defaults to false.
   */
  // const returnTotalSize = true
  /**
   *  Optional. Number of results to skip beginning from the `page_token` if
   *  provided. https://google.aip.dev/158#skipping-results. It must be a
   *  non-negative integer. Negative values will be rejected. Note that this is
   *  not the number of pages to skip. If this value causes the cursor to move
   *  past the end of results,
   *  ListDocumentsResponse.document_metadata google.cloud.documentai.v1beta3.ListDocumentsResponse.document_metadata 
   *  and
   *  ListDocumentsResponse.next_page_token google.cloud.documentai.v1beta3.ListDocumentsResponse.next_page_token 
   *  will be empty.
   */
  // const skip = 1234

  // Imports the Documentai library
  const {DocumentServiceClient} = require('@google-cloud/documentai').v1beta3;

  // Instantiates a client
  const documentaiClient = new DocumentServiceClient();

  async function callListDocuments() {
    // Construct request
    const request = {
      dataset,
    };

    // Run request
    const iterable = documentaiClient.listDocumentsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListDocuments();

listDocumentsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
dataset string

Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset
pageSize number

The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken string

A page token, received from a previous ListDocuments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDocuments must match the call that provided the page token.
filter string <optional>

Optional. Query to filter the documents based on https://google.aip.dev/160.

Currently support query strings are:

SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED

  • LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED
  • DisplayName=\"file_name.pdf\"
  • EntityType=abc/def
  • TagName=\"auto-labeling-running\"|\"sampled\"

Note:

  • Only AND, = and != are supported. e.g. DisplayName=file_name AND EntityType!=abc IS supported.
  • Wildcard * is supported only in DisplayName filter
  • No duplicate filter keys are allowed, e.g. EntityType=a AND EntityType=b is NOT supported.
  • String match is case sensitive (for filter DisplayName & EntityType).
returnTotalSize boolean <optional>

Optional. Controls if the request requires a total size of matched documents. See ListDocumentsResponse.total_size.

Enabling this flag may adversely impact performance.

Defaults to false.
skip number <optional>

Optional. Number of results to skip beginning from the page_token if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values will be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, ListDocumentsResponse.document_metadata and ListDocumentsResponse.next_page_token will be empty.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing DocumentMetadata on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listDocumentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, optionsopt) → {Object}

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

matchEvaluationFromEvaluationName(evaluationName) → {string}

Parse the evaluation from Evaluation resource.

Parameters:
Name Type Description
evaluationName string

A fully-qualified path representing Evaluation resource.
Returns:
Type Description
string

A string representing the evaluation.

matchLocationFromDatasetName(datasetName) → {string}

Parse the location from Dataset resource.

Parameters:
Name Type Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromDatasetSchemaName(datasetSchemaName) → {string}

Parse the location from DatasetSchema resource.

Parameters:
Name Type Description
datasetSchemaName string

A fully-qualified path representing DatasetSchema resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromEvaluationName(evaluationName) → {string}

Parse the location from Evaluation resource.

Parameters:
Name Type Description
evaluationName string

A fully-qualified path representing Evaluation resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProcessorName(processorName) → {string}

Parse the location from Processor resource.

Parameters:
Name Type Description
processorName string

A fully-qualified path representing Processor resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProcessorTypeName(processorTypeName) → {string}

Parse the location from ProcessorType resource.

Parameters:
Name Type Description
processorTypeName string

A fully-qualified path representing ProcessorType resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProcessorVersionName(processorVersionName) → {string}

Parse the location from ProcessorVersion resource.

Parameters:
Name Type Description
processorVersionName string

A fully-qualified path representing ProcessorVersion resource.
Returns:
Type Description
string

A string representing the location.

matchProcessorFromDatasetName(datasetName) → {string}

Parse the processor from Dataset resource.

Parameters:
Name Type Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns:
Type Description
string

A string representing the processor.

matchProcessorFromDatasetSchemaName(datasetSchemaName) → {string}

Parse the processor from DatasetSchema resource.

Parameters:
Name Type Description
datasetSchemaName string

A fully-qualified path representing DatasetSchema resource.
Returns:
Type Description
string

A string representing the processor.

matchProcessorFromEvaluationName(evaluationName) → {string}

Parse the processor from Evaluation resource.

Parameters:
Name Type Description
evaluationName string

A fully-qualified path representing Evaluation resource.
Returns:
Type Description
string

A string representing the processor.

matchProcessorFromProcessorName(processorName) → {string}

Parse the processor from Processor resource.

Parameters:
Name Type Description
processorName string

A fully-qualified path representing Processor resource.
Returns:
Type Description
string

A string representing the processor.

matchProcessorFromProcessorVersionName(processorVersionName) → {string}

Parse the processor from ProcessorVersion resource.

Parameters:
Name Type Description
processorVersionName string

A fully-qualified path representing ProcessorVersion resource.
Returns:
Type Description
string

A string representing the processor.

matchProcessorTypeFromProcessorTypeName(processorTypeName) → {string}

Parse the processor_type from ProcessorType resource.

Parameters:
Name Type Description
processorTypeName string

A fully-qualified path representing ProcessorType resource.
Returns:
Type Description
string

A string representing the processor_type.

matchProcessorVersionFromEvaluationName(evaluationName) → {string}

Parse the processor_version from Evaluation resource.

Parameters:
Name Type Description
evaluationName string

A fully-qualified path representing Evaluation resource.
Returns:
Type Description
string

A string representing the processor_version.

matchProcessorVersionFromProcessorVersionName(processorVersionName) → {string}

Parse the processor_version from ProcessorVersion resource.

Parameters:
Name Type Description
processorVersionName string

A fully-qualified path representing ProcessorVersion resource.
Returns:
Type Description
string

A string representing the processor_version.

matchProjectFromDatasetName(datasetName) → {string}

Parse the project from Dataset resource.

Parameters:
Name Type Description
datasetName string

A fully-qualified path representing Dataset resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromDatasetSchemaName(datasetSchemaName) → {string}

Parse the project from DatasetSchema resource.

Parameters:
Name Type Description
datasetSchemaName string

A fully-qualified path representing DatasetSchema resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromEvaluationName(evaluationName) → {string}

Parse the project from Evaluation resource.

Parameters:
Name Type Description
evaluationName string

A fully-qualified path representing Evaluation resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProcessorName(processorName) → {string}

Parse the project from Processor resource.

Parameters:
Name Type Description
processorName string

A fully-qualified path representing Processor resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProcessorTypeName(processorTypeName) → {string}

Parse the project from ProcessorType resource.

Parameters:
Name Type Description
processorTypeName string

A fully-qualified path representing ProcessorType resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProcessorVersionName(processorVersionName) → {string}

Parse the project from ProcessorVersion resource.

Parameters:
Name Type Description
processorVersionName string

A fully-qualified path representing ProcessorVersion resource.
Returns:
Type Description
string

A string representing the project.

processorPath(project, location, processor) → {string}

Return a fully-qualified processor resource name string.

Parameters:
Name Type Description
project string
location string
processor string
Returns:
Type Description
string

Resource name string.

processorTypePath(project, location, processor_type) → {string}

Return a fully-qualified processorType resource name string.

Parameters:
Name Type Description
project string
location string
processor_type string
Returns:
Type Description
string

Resource name string.

processorVersionPath(project, location, processor, processor_version) → {string}

Return a fully-qualified processorVersion resource name string.

Parameters:
Name Type Description
project string
location string
processor string
processor_version string
Returns:
Type Description
string

Resource name string.