This service lets you manage document-links. Document-Links are treated as sub-resources under source documents. v1
Package
@google-cloud/contentwarehouseConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of DocumentLinkServiceClient.
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof gax.fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
documentLinkServiceStub
documentLinkServiceStub?: Promise<{
[name: string]: Function;
}>;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createDocumentLink(request, options)
createDocumentLink(request?: protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest, options?: CallOptions): Promise<[
protos.google.cloud.contentwarehouse.v1.IDocumentLink,
(protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest | undefined),
{} | undefined
]>;
Create a link between a source document and a target document.
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.contentwarehouse.v1.IDocumentLink, (protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest | undefined), {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [DocumentLink]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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. Parent of the document-link to be created.
* parent of document-link should be a document.
* Format:
* projects/{project_number}/locations/{location}/documents/{source_document_id}.
*/
// const parent = 'abc123'
/**
* Required. Document links associated with the source documents (source_document_id).
*/
// const documentLink = {}
/**
* The meta information collected about the document creator, used to enforce
* access control for the service.
*/
// const requestMetadata = {}
// Imports the Contentwarehouse library
const {DocumentLinkServiceClient} = require('@google-cloud/contentwarehouse').v1;
// Instantiates a client
const contentwarehouseClient = new DocumentLinkServiceClient();
async function callCreateDocumentLink() {
// Construct request
const request = {
parent,
documentLink,
};
// Run request
const response = await contentwarehouseClient.createDocumentLink(request);
console.log(response);
}
callCreateDocumentLink();
createDocumentLink(request, options, callback)
createDocumentLink(request: protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest, options: CallOptions, callback: Callback<protos.google.cloud.contentwarehouse.v1.IDocumentLink, protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.contentwarehouse.v1.IDocumentLink, protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createDocumentLink(request, callback)
createDocumentLink(request: protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest, callback: Callback<protos.google.cloud.contentwarehouse.v1.IDocumentLink, protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest
|
callback |
Callback<protos.google.cloud.contentwarehouse.v1.IDocumentLink, protos.google.cloud.contentwarehouse.v1.ICreateDocumentLinkRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteDocumentLink(request, options)
deleteDocumentLink(request?: protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest, options?: CallOptions): Promise<[
protos.google.protobuf.IEmpty,
(protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest | undefined),
{} | undefined
]>;
Remove the link between the source and target documents.
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.protobuf.IEmpty, (protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest | undefined), {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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 of the document-link to be deleted.
* Format:
* projects/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
*/
// const name = 'abc123'
/**
* The meta information collected about the document creator, used to enforce
* access control for the service.
*/
// const requestMetadata = {}
// Imports the Contentwarehouse library
const {DocumentLinkServiceClient} = require('@google-cloud/contentwarehouse').v1;
// Instantiates a client
const contentwarehouseClient = new DocumentLinkServiceClient();
async function callDeleteDocumentLink() {
// Construct request
const request = {
name,
};
// Run request
const response = await contentwarehouseClient.deleteDocumentLink(request);
console.log(response);
}
callDeleteDocumentLink();
deleteDocumentLink(request, options, callback)
deleteDocumentLink(request: protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteDocumentLink(request, callback)
deleteDocumentLink(request: protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.contentwarehouse.v1.IDeleteDocumentLinkRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
documentLinkPath(project, location, document, documentLink)
documentLinkPath(project: string, location: string, document: string, documentLink: string): string;
Return a fully-qualified documentLink resource name string.
Name | Description |
project |
string
|
location |
string
|
document |
string
|
documentLink |
string
|
Type | Description |
string | {string} Resource name string. |
documentSchemaPath(project, location, documentSchema)
documentSchemaPath(project: string, location: string, documentSchema: string): string;
Return a fully-qualified documentSchema resource name string.
Name | Description |
project |
string
|
location |
string
|
documentSchema |
string
|
Type | Description |
string | {string} Resource name string. |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Type | Description |
void |
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
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.
Type | Description |
Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
listLinkedSources(request, options)
listLinkedSources(request?: protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, options?: CallOptions): Promise<[
protos.google.cloud.contentwarehouse.v1.IDocumentLink[],
protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest | null,
protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesResponse
]>;
Return all source document-links from the document.
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.contentwarehouse.v1.IDocumentLink[], protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest | null, protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesResponse ]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [DocumentLink]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listLinkedSources(request, options, callback)
listLinkedSources(request: protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesResponse | null | undefined, protos.google.cloud.contentwarehouse.v1.IDocumentLink>): void;
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesResponse | null | undefined, protos.google.cloud.contentwarehouse.v1.IDocumentLink>
|
Type | Description |
void |
listLinkedSources(request, callback)
listLinkedSources(request: protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, callback: PaginationCallback<protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesResponse | null | undefined, protos.google.cloud.contentwarehouse.v1.IDocumentLink>): void;
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest
|
callback |
PaginationCallback<protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesResponse | null | undefined, protos.google.cloud.contentwarehouse.v1.IDocumentLink>
|
Type | Description |
void |
listLinkedSourcesAsync(request, options)
listLinkedSourcesAsync(request?: protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.contentwarehouse.v1.IDocumentLink>;
Equivalent to listLinkedSources
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.contentwarehouse.v1.IDocumentLink> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [DocumentLink]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* 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 of the document, for which all source links are returned.
* Format:
* projects/{project_number}/locations/{location}/documents/{source_document_id}.
*/
// const parent = 'abc123'
/**
* The maximum number of document-links to return. The service may return
* fewer than this value.
* If unspecified, at most 50 document-links will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* A page token, received from a previous `ListLinkedSources` call.
* Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to `ListLinkedSources`
* must match the call that provided the page token.
*/
// const pageToken = 'abc123'
/**
* The meta information collected about the document creator, used to enforce
* access control for the service.
*/
// const requestMetadata = {}
// Imports the Contentwarehouse library
const {DocumentLinkServiceClient} = require('@google-cloud/contentwarehouse').v1;
// Instantiates a client
const contentwarehouseClient = new DocumentLinkServiceClient();
async function callListLinkedSources() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await contentwarehouseClient.listLinkedSourcesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListLinkedSources();
listLinkedSourcesStream(request, options)
listLinkedSourcesStream(request?: protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IListLinkedSourcesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {Stream} An object stream which emits an object representing [DocumentLink] 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 |
listLinkedTargets(request, options)
listLinkedTargets(request?: protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest, options?: CallOptions): Promise<[
protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsResponse,
(protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest | undefined),
{} | undefined
]>;
Return all target document-links from the document.
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[ protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsResponse, (protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest | undefined), {} | undefined ]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [ListLinkedTargetsResponse]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* 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 of the document, for which all target links are returned.
* Format:
* projects/{project_number}/locations/{location}/documents/{target_document_id}.
*/
// const parent = 'abc123'
/**
* The meta information collected about the document creator, used to enforce
* access control for the service.
*/
// const requestMetadata = {}
// Imports the Contentwarehouse library
const {DocumentLinkServiceClient} = require('@google-cloud/contentwarehouse').v1;
// Instantiates a client
const contentwarehouseClient = new DocumentLinkServiceClient();
async function callListLinkedTargets() {
// Construct request
const request = {
parent,
};
// Run request
const response = await contentwarehouseClient.listLinkedTargets(request);
console.log(response);
}
callListLinkedTargets();
listLinkedTargets(request, options, callback)
listLinkedTargets(request: protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest, options: CallOptions, callback: Callback<protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsResponse, protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsResponse, protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
listLinkedTargets(request, callback)
listLinkedTargets(request: protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest, callback: Callback<protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsResponse, protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest
|
callback |
Callback<protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsResponse, protos.google.cloud.contentwarehouse.v1.IListLinkedTargetsRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
matchContextFromSynonymSetName(synonymSetName)
matchContextFromSynonymSetName(synonymSetName: string): string | number;
Parse the context from SynonymSet resource.
Name | Description |
synonymSetName |
string
A fully-qualified path representing SynonymSet resource. |
Type | Description |
string | number | {string} A string representing the context. |
matchDocumentFromDocumentLinkName(documentLinkName)
matchDocumentFromDocumentLinkName(documentLinkName: string): string | number;
Parse the document from DocumentLink resource.
Name | Description |
documentLinkName |
string
A fully-qualified path representing DocumentLink resource. |
Type | Description |
string | number | {string} A string representing the document. |
matchDocumentFromProjectLocationDocumentName(projectLocationDocumentName)
matchDocumentFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number;
Parse the document from ProjectLocationDocument resource.
Name | Description |
projectLocationDocumentName |
string
A fully-qualified path representing project_location_document resource. |
Type | Description |
string | number | {string} A string representing the document. |
matchDocumentLinkFromDocumentLinkName(documentLinkName)
matchDocumentLinkFromDocumentLinkName(documentLinkName: string): string | number;
Parse the document_link from DocumentLink resource.
Name | Description |
documentLinkName |
string
A fully-qualified path representing DocumentLink resource. |
Type | Description |
string | number | {string} A string representing the document_link. |
matchDocumentSchemaFromDocumentSchemaName(documentSchemaName)
matchDocumentSchemaFromDocumentSchemaName(documentSchemaName: string): string | number;
Parse the document_schema from DocumentSchema resource.
Name | Description |
documentSchemaName |
string
A fully-qualified path representing DocumentSchema resource. |
Type | Description |
string | number | {string} A string representing the document_schema. |
matchLocationFromDocumentLinkName(documentLinkName)
matchLocationFromDocumentLinkName(documentLinkName: string): string | number;
Parse the location from DocumentLink resource.
Name | Description |
documentLinkName |
string
A fully-qualified path representing DocumentLink resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromDocumentSchemaName(documentSchemaName)
matchLocationFromDocumentSchemaName(documentSchemaName: string): string | number;
Parse the location from DocumentSchema resource.
Name | Description |
documentSchemaName |
string
A fully-qualified path representing DocumentSchema resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationDocumentName(projectLocationDocumentName)
matchLocationFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number;
Parse the location from ProjectLocationDocument resource.
Name | Description |
projectLocationDocumentName |
string
A fully-qualified path representing project_location_document resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName)
matchLocationFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number;
Parse the location from ProjectLocationDocumentsReferenceId resource.
Name | Description |
projectLocationDocumentsReferenceIdName |
string
A fully-qualified path representing project_location_documents_reference_id resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromRuleSetName(ruleSetName)
matchLocationFromRuleSetName(ruleSetName: string): string | number;
Parse the location from RuleSet resource.
Name | Description |
ruleSetName |
string
A fully-qualified path representing RuleSet resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromSynonymSetName(synonymSetName)
matchLocationFromSynonymSetName(synonymSetName: string): string | number;
Parse the location from SynonymSet resource.
Name | Description |
synonymSetName |
string
A fully-qualified path representing SynonymSet resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchProjectFromDocumentLinkName(documentLinkName)
matchProjectFromDocumentLinkName(documentLinkName: string): string | number;
Parse the project from DocumentLink resource.
Name | Description |
documentLinkName |
string
A fully-qualified path representing DocumentLink resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromDocumentSchemaName(documentSchemaName)
matchProjectFromDocumentSchemaName(documentSchemaName: string): string | number;
Parse the project from DocumentSchema resource.
Name | Description |
documentSchemaName |
string
A fully-qualified path representing DocumentSchema resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationDocumentName(projectLocationDocumentName)
matchProjectFromProjectLocationDocumentName(projectLocationDocumentName: string): string | number;
Parse the project from ProjectLocationDocument resource.
Name | Description |
projectLocationDocumentName |
string
A fully-qualified path representing project_location_document resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName)
matchProjectFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number;
Parse the project from ProjectLocationDocumentsReferenceId resource.
Name | Description |
projectLocationDocumentsReferenceIdName |
string
A fully-qualified path representing project_location_documents_reference_id resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromRuleSetName(ruleSetName)
matchProjectFromRuleSetName(ruleSetName: string): string | number;
Parse the project from RuleSet resource.
Name | Description |
ruleSetName |
string
A fully-qualified path representing RuleSet resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromSynonymSetName(synonymSetName)
matchProjectFromSynonymSetName(synonymSetName: string): string | number;
Parse the project from SynonymSet resource.
Name | Description |
synonymSetName |
string
A fully-qualified path representing SynonymSet resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchReferenceIdFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName)
matchReferenceIdFromProjectLocationDocumentsReferenceIdName(projectLocationDocumentsReferenceIdName: string): string | number;
Parse the reference_id from ProjectLocationDocumentsReferenceId resource.
Name | Description |
projectLocationDocumentsReferenceIdName |
string
A fully-qualified path representing project_location_documents_reference_id resource. |
Type | Description |
string | number | {string} A string representing the reference_id. |
matchRuleSetFromRuleSetName(ruleSetName)
matchRuleSetFromRuleSetName(ruleSetName: string): string | number;
Parse the rule_set from RuleSet resource.
Name | Description |
ruleSetName |
string
A fully-qualified path representing RuleSet resource. |
Type | Description |
string | number | {string} A string representing the rule_set. |
projectLocationDocumentPath(project, location, document)
projectLocationDocumentPath(project: string, location: string, document: string): string;
Return a fully-qualified projectLocationDocument resource name string.
Name | Description |
project |
string
|
location |
string
|
document |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationDocumentsReferenceIdPath(project, location, referenceId)
projectLocationDocumentsReferenceIdPath(project: string, location: string, referenceId: string): string;
Return a fully-qualified projectLocationDocumentsReferenceId resource name string.
Name | Description |
project |
string
|
location |
string
|
referenceId |
string
|
Type | Description |
string | {string} Resource name string. |
ruleSetPath(project, location, ruleSet)
ruleSetPath(project: string, location: string, ruleSet: string): string;
Return a fully-qualified ruleSet resource name string.
Name | Description |
project |
string
|
location |
string
|
ruleSet |
string
|
Type | Description |
string | {string} Resource name string. |
synonymSetPath(project, location, context)
synonymSetPath(project: string, location: string, context: string): string;
Return a fully-qualified synonymSet resource name string.
Name | Description |
project |
string
|
location |
string
|
context |
string
|
Type | Description |
string | {string} Resource name string. |