Service for managing . v3
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of WebhooksClient.
Name | Description |
opts |
ClientOptions
|
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;
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;
webhooksStub
webhooksStub?: Promise<{
[name: string]: Function;
}>;
Methods
agentPath(project, location, agent)
agentPath(project: string, location: string, agent: string): string;
Return a fully-qualified agent resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
Type | Description |
string | {string} Resource name string. |
agentValidationResultPath(project, location, agent)
agentValidationResultPath(project: string, location: string, agent: string): string;
Return a fully-qualified agentValidationResult resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
Type | Description |
string | {string} Resource name string. |
changelogPath(project, location, agent, changelog)
changelogPath(project: string, location: string, agent: string, changelog: string): string;
Return a fully-qualified changelog resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
changelog |
string
|
Type | Description |
string | {string} Resource name string. |
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. |
continuousTestResultPath(project, location, agent, environment, continuousTestResult)
continuousTestResultPath(project: string, location: string, agent: string, environment: string, continuousTestResult: string): string;
Return a fully-qualified continuousTestResult resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
continuousTestResult |
string
|
Type | Description |
string | {string} Resource name string. |
createWebhook(request, options)
createWebhook(request?: protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest | undefined, {} | undefined]>;
Creates a webhook in the specified agent.
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Webhook]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The agent to create a webhook for.
* Format: `projects/
createWebhook(request, options, callback)
createWebhook(request: protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createWebhook(request, callback)
createWebhook(request: protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.ICreateWebhookRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteWebhook(request, options)
deleteWebhook(request?: protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest | undefined, {} | undefined]>;
Deletes the specified webhook.
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest
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.dialogflow.cx.v3.IDeleteWebhookRequest | 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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the webhook to delete.
* Format: `projects/
deleteWebhook(request, options, callback)
deleteWebhook(request: protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteWebhook(request, callback)
deleteWebhook(request: protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3.IDeleteWebhookRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deploymentPath(project, location, agent, environment, deployment)
deploymentPath(project: string, location: string, agent: string, environment: string, deployment: string): string;
Return a fully-qualified deployment resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
deployment |
string
|
Type | Description |
string | {string} Resource name string. |
entityTypePath(project, location, agent, entityType)
entityTypePath(project: string, location: string, agent: string, entityType: string): string;
Return a fully-qualified entityType resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
environmentPath(project, location, agent, environment)
environmentPath(project: string, location: string, agent: string, environment: string): string;
Return a fully-qualified environment resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
Type | Description |
string | {string} Resource name string. |
experimentPath(project, location, agent, environment, experiment)
experimentPath(project: string, location: string, agent: string, environment: string, experiment: string): string;
Return a fully-qualified experiment resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
experiment |
string
|
Type | Description |
string | {string} Resource name string. |
flowPath(project, location, agent, flow)
flowPath(project: string, location: string, agent: string, flow: string): string;
Return a fully-qualified flow resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
Type | Description |
string | {string} Resource name string. |
flowValidationResultPath(project, location, agent, flow)
flowValidationResultPath(project: string, location: string, agent: string, flow: string): string;
Return a fully-qualified flowValidationResult resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
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 |
getWebhook(request, options)
getWebhook(request?: protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest | undefined, {} | undefined]>;
Retrieves the specified webhook.
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Webhook]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the webhook.
* Format: `projects/
getWebhook(request, options, callback)
getWebhook(request: protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getWebhook(request, callback)
getWebhook(request: protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IGetWebhookRequest | null | undefined, {} | null | 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. |
intentPath(project, location, agent, intent)
intentPath(project: string, location: string, agent: string, intent: string): string;
Return a fully-qualified intent resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
intent |
string
|
Type | Description |
string | {string} Resource name string. |
listWebhooks(request, options)
listWebhooks(request?: protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3.IWebhook[], protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest | null, protos.google.cloud.dialogflow.cx.v3.IListWebhooksResponse]>;
Returns the list of all webhooks in the specified agent.
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.dialogflow.cx.v3.IWebhook[], protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest | null, protos.google.cloud.dialogflow.cx.v3.IListWebhooksResponse]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [Webhook]. 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 |
listWebhooks(request, options, callback)
listWebhooks(request: protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, protos.google.cloud.dialogflow.cx.v3.IListWebhooksResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IWebhook>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, protos.google.cloud.dialogflow.cx.v3.IListWebhooksResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IWebhook>
|
Type | Description |
void |
listWebhooks(request, callback)
listWebhooks(request: protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, protos.google.cloud.dialogflow.cx.v3.IListWebhooksResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IWebhook>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest
|
callback |
PaginationCallback<protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, protos.google.cloud.dialogflow.cx.v3.IListWebhooksResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3.IWebhook>
|
Type | Description |
void |
listWebhooksAsync(request, options)
listWebhooksAsync(request?: protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IWebhook>;
Equivalent to listWebhooks
, 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.dialogflow.cx.v3.IListWebhooksRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.dialogflow.cx.v3.IWebhook> | {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 [Webhook]. 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. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The agent to list all webhooks for.
* Format: `projects/
listWebhooksStream(request, options)
listWebhooksStream(request?: protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IListWebhooksRequest
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 [Webhook] 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 |
locationPath(project, location)
locationPath(project: string, location: string): string;
Return a fully-qualified location resource name string.
Name | Description |
project |
string
|
location |
string
|
Type | Description |
string | {string} Resource name string. |
matchAgentFromAgentName(agentName)
matchAgentFromAgentName(agentName: string): string | number;
Parse the agent from Agent resource.
Name | Description |
agentName |
string
A fully-qualified path representing Agent resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromAgentValidationResultName(agentValidationResultName)
matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;
Parse the agent from AgentValidationResult resource.
Name | Description |
agentValidationResultName |
string
A fully-qualified path representing AgentValidationResult resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromChangelogName(changelogName)
matchAgentFromChangelogName(changelogName: string): string | number;
Parse the agent from Changelog resource.
Name | Description |
changelogName |
string
A fully-qualified path representing Changelog resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromContinuousTestResultName(continuousTestResultName)
matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the agent from ContinuousTestResult resource.
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromDeploymentName(deploymentName)
matchAgentFromDeploymentName(deploymentName: string): string | number;
Parse the agent from Deployment resource.
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromEntityTypeName(entityTypeName)
matchAgentFromEntityTypeName(entityTypeName: string): string | number;
Parse the agent from EntityType resource.
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromEnvironmentName(environmentName)
matchAgentFromEnvironmentName(environmentName: string): string | number;
Parse the agent from Environment resource.
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromExperimentName(experimentName)
matchAgentFromExperimentName(experimentName: string): string | number;
Parse the agent from Experiment resource.
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromFlowName(flowName)
matchAgentFromFlowName(flowName: string): string | number;
Parse the agent from Flow resource.
Name | Description |
flowName |
string
A fully-qualified path representing Flow resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromFlowValidationResultName(flowValidationResultName)
matchAgentFromFlowValidationResultName(flowValidationResultName: string): string | number;
Parse the agent from FlowValidationResult resource.
Name | Description |
flowValidationResultName |
string
A fully-qualified path representing FlowValidationResult resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromIntentName(intentName)
matchAgentFromIntentName(intentName: string): string | number;
Parse the agent from Intent resource.
Name | Description |
intentName |
string
A fully-qualified path representing Intent resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromPageName(pageName)
matchAgentFromPageName(pageName: string): string | number;
Parse the agent from Page resource.
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchAgentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the agent from ProjectLocationAgentEnvironmentSession resource.
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the agent from ProjectLocationAgentSessionEntityType resource.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchAgentFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;
Parse the agent from ProjectLocationAgentSession resource.
Name | Description |
projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromTestCaseName(testCaseName)
matchAgentFromTestCaseName(testCaseName: string): string | number;
Parse the agent from TestCase resource.
Name | Description |
testCaseName |
string
A fully-qualified path representing TestCase resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromTestCaseResultName(testCaseResultName)
matchAgentFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the agent from TestCaseResult resource.
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromTransitionRouteGroupName(transitionRouteGroupName)
matchAgentFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;
Parse the agent from TransitionRouteGroup resource.
Name | Description |
transitionRouteGroupName |
string
A fully-qualified path representing TransitionRouteGroup resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromVersionName(versionName)
matchAgentFromVersionName(versionName: string): string | number;
Parse the agent from Version resource.
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchAgentFromWebhookName(webhookName)
matchAgentFromWebhookName(webhookName: string): string | number;
Parse the agent from Webhook resource.
Name | Description |
webhookName |
string
A fully-qualified path representing Webhook resource. |
Type | Description |
string | number | {string} A string representing the agent. |
matchChangelogFromChangelogName(changelogName)
matchChangelogFromChangelogName(changelogName: string): string | number;
Parse the changelog from Changelog resource.
Name | Description |
changelogName |
string
A fully-qualified path representing Changelog resource. |
Type | Description |
string | number | {string} A string representing the changelog. |
matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName)
matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the continuous_test_result from ContinuousTestResult resource.
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Type | Description |
string | number | {string} A string representing the continuous_test_result. |
matchDeploymentFromDeploymentName(deploymentName)
matchDeploymentFromDeploymentName(deploymentName: string): string | number;
Parse the deployment from Deployment resource.
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Type | Description |
string | number | {string} A string representing the deployment. |
matchEntityTypeFromEntityTypeName(entityTypeName)
matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;
Parse the entity_type from EntityType resource.
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource. |
Type | Description |
string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the entity_type from ProjectLocationAgentSessionEntityType resource.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the entity_type. |
matchEnvironmentFromContinuousTestResultName(continuousTestResultName)
matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the environment from ContinuousTestResult resource.
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromDeploymentName(deploymentName)
matchEnvironmentFromDeploymentName(deploymentName: string): string | number;
Parse the environment from Deployment resource.
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromEnvironmentName(environmentName)
matchEnvironmentFromEnvironmentName(environmentName: string): string | number;
Parse the environment from Environment resource.
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromExperimentName(experimentName)
matchEnvironmentFromExperimentName(experimentName: string): string | number;
Parse the environment from Experiment resource.
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchEnvironmentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironmentSession resource.
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchExperimentFromExperimentName(experimentName)
matchExperimentFromExperimentName(experimentName: string): string | number;
Parse the experiment from Experiment resource.
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Type | Description |
string | number | {string} A string representing the experiment. |
matchFlowFromFlowName(flowName)
matchFlowFromFlowName(flowName: string): string | number;
Parse the flow from Flow resource.
Name | Description |
flowName |
string
A fully-qualified path representing Flow resource. |
Type | Description |
string | number | {string} A string representing the flow. |
matchFlowFromFlowValidationResultName(flowValidationResultName)
matchFlowFromFlowValidationResultName(flowValidationResultName: string): string | number;
Parse the flow from FlowValidationResult resource.
Name | Description |
flowValidationResultName |
string
A fully-qualified path representing FlowValidationResult resource. |
Type | Description |
string | number | {string} A string representing the flow. |
matchFlowFromPageName(pageName)
matchFlowFromPageName(pageName: string): string | number;
Parse the flow from Page resource.
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Type | Description |
string | number | {string} A string representing the flow. |
matchFlowFromTransitionRouteGroupName(transitionRouteGroupName)
matchFlowFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;
Parse the flow from TransitionRouteGroup resource.
Name | Description |
transitionRouteGroupName |
string
A fully-qualified path representing TransitionRouteGroup resource. |
Type | Description |
string | number | {string} A string representing the flow. |
matchFlowFromVersionName(versionName)
matchFlowFromVersionName(versionName: string): string | number;
Parse the flow from Version resource.
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Type | Description |
string | number | {string} A string representing the flow. |
matchIntentFromIntentName(intentName)
matchIntentFromIntentName(intentName: string): string | number;
Parse the intent from Intent resource.
Name | Description |
intentName |
string
A fully-qualified path representing Intent resource. |
Type | Description |
string | number | {string} A string representing the intent. |
matchLocationFromAgentName(agentName)
matchLocationFromAgentName(agentName: string): string | number;
Parse the location from Agent resource.
Name | Description |
agentName |
string
A fully-qualified path representing Agent resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromAgentValidationResultName(agentValidationResultName)
matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;
Parse the location from AgentValidationResult resource.
Name | Description |
agentValidationResultName |
string
A fully-qualified path representing AgentValidationResult resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromChangelogName(changelogName)
matchLocationFromChangelogName(changelogName: string): string | number;
Parse the location from Changelog resource.
Name | Description |
changelogName |
string
A fully-qualified path representing Changelog resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromContinuousTestResultName(continuousTestResultName)
matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the location from ContinuousTestResult resource.
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromDeploymentName(deploymentName)
matchLocationFromDeploymentName(deploymentName: string): string | number;
Parse the location from Deployment resource.
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromEntityTypeName(entityTypeName)
matchLocationFromEntityTypeName(entityTypeName: string): string | number;
Parse the location from EntityType resource.
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromEnvironmentName(environmentName)
matchLocationFromEnvironmentName(environmentName: string): string | number;
Parse the location from Environment resource.
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromExperimentName(experimentName)
matchLocationFromExperimentName(experimentName: string): string | number;
Parse the location from Experiment resource.
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFlowName(flowName)
matchLocationFromFlowName(flowName: string): string | number;
Parse the location from Flow resource.
Name | Description |
flowName |
string
A fully-qualified path representing Flow resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromFlowValidationResultName(flowValidationResultName)
matchLocationFromFlowValidationResultName(flowValidationResultName: string): string | number;
Parse the location from FlowValidationResult resource.
Name | Description |
flowValidationResultName |
string
A fully-qualified path representing FlowValidationResult resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromIntentName(intentName)
matchLocationFromIntentName(intentName: string): string | number;
Parse the location from Intent resource.
Name | Description |
intentName |
string
A fully-qualified path representing Intent resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromLocationName(locationName)
matchLocationFromLocationName(locationName: string): string | number;
Parse the location from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromPageName(pageName)
matchLocationFromPageName(pageName: string): string | number;
Parse the location from Page resource.
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchLocationFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the location from ProjectLocationAgentEnvironmentSession resource.
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentSessionEntityType resource.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchLocationFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;
Parse the location from ProjectLocationAgentSession resource.
Name | Description |
projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromSecuritySettingsName(securitySettingsName)
matchLocationFromSecuritySettingsName(securitySettingsName: string): string | number;
Parse the location from SecuritySettings resource.
Name | Description |
securitySettingsName |
string
A fully-qualified path representing SecuritySettings resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromTestCaseName(testCaseName)
matchLocationFromTestCaseName(testCaseName: string): string | number;
Parse the location from TestCase resource.
Name | Description |
testCaseName |
string
A fully-qualified path representing TestCase resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromTestCaseResultName(testCaseResultName)
matchLocationFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the location from TestCaseResult resource.
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromTransitionRouteGroupName(transitionRouteGroupName)
matchLocationFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;
Parse the location from TransitionRouteGroup resource.
Name | Description |
transitionRouteGroupName |
string
A fully-qualified path representing TransitionRouteGroup resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromVersionName(versionName)
matchLocationFromVersionName(versionName: string): string | number;
Parse the location from Version resource.
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromWebhookName(webhookName)
matchLocationFromWebhookName(webhookName: string): string | number;
Parse the location from Webhook resource.
Name | Description |
webhookName |
string
A fully-qualified path representing Webhook resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchPageFromPageName(pageName)
matchPageFromPageName(pageName: string): string | number;
Parse the page from Page resource.
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Type | Description |
string | number | {string} A string representing the page. |
matchProjectFromAgentName(agentName)
matchProjectFromAgentName(agentName: string): string | number;
Parse the project from Agent resource.
Name | Description |
agentName |
string
A fully-qualified path representing Agent resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromAgentValidationResultName(agentValidationResultName)
matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;
Parse the project from AgentValidationResult resource.
Name | Description |
agentValidationResultName |
string
A fully-qualified path representing AgentValidationResult resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromChangelogName(changelogName)
matchProjectFromChangelogName(changelogName: string): string | number;
Parse the project from Changelog resource.
Name | Description |
changelogName |
string
A fully-qualified path representing Changelog resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromContinuousTestResultName(continuousTestResultName)
matchProjectFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the project from ContinuousTestResult resource.
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromDeploymentName(deploymentName)
matchProjectFromDeploymentName(deploymentName: string): string | number;
Parse the project from Deployment resource.
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromEntityTypeName(entityTypeName)
matchProjectFromEntityTypeName(entityTypeName: string): string | number;
Parse the project from EntityType resource.
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromEnvironmentName(environmentName)
matchProjectFromEnvironmentName(environmentName: string): string | number;
Parse the project from Environment resource.
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromExperimentName(experimentName)
matchProjectFromExperimentName(experimentName: string): string | number;
Parse the project from Experiment resource.
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromFlowName(flowName)
matchProjectFromFlowName(flowName: string): string | number;
Parse the project from Flow resource.
Name | Description |
flowName |
string
A fully-qualified path representing Flow resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromFlowValidationResultName(flowValidationResultName)
matchProjectFromFlowValidationResultName(flowValidationResultName: string): string | number;
Parse the project from FlowValidationResult resource.
Name | Description |
flowValidationResultName |
string
A fully-qualified path representing FlowValidationResult resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromIntentName(intentName)
matchProjectFromIntentName(intentName: string): string | number;
Parse the project from Intent resource.
Name | Description |
intentName |
string
A fully-qualified path representing Intent resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromLocationName(locationName)
matchProjectFromLocationName(locationName: string): string | number;
Parse the project from Location resource.
Name | Description |
locationName |
string
A fully-qualified path representing Location resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromPageName(pageName)
matchProjectFromPageName(pageName: string): string | number;
Parse the project from Page resource.
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchProjectFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the project from ProjectLocationAgentEnvironmentSession resource.
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the project from ProjectLocationAgentSessionEntityType resource.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchProjectFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;
Parse the project from ProjectLocationAgentSession resource.
Name | Description |
projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromSecuritySettingsName(securitySettingsName)
matchProjectFromSecuritySettingsName(securitySettingsName: string): string | number;
Parse the project from SecuritySettings resource.
Name | Description |
securitySettingsName |
string
A fully-qualified path representing SecuritySettings resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromTestCaseName(testCaseName)
matchProjectFromTestCaseName(testCaseName: string): string | number;
Parse the project from TestCase resource.
Name | Description |
testCaseName |
string
A fully-qualified path representing TestCase resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromTestCaseResultName(testCaseResultName)
matchProjectFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the project from TestCaseResult resource.
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromTransitionRouteGroupName(transitionRouteGroupName)
matchProjectFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;
Parse the project from TransitionRouteGroup resource.
Name | Description |
transitionRouteGroupName |
string
A fully-qualified path representing TransitionRouteGroup resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromVersionName(versionName)
matchProjectFromVersionName(versionName: string): string | number;
Parse the project from Version resource.
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromWebhookName(webhookName)
matchProjectFromWebhookName(webhookName: string): string | number;
Parse the project from Webhook resource.
Name | Description |
webhookName |
string
A fully-qualified path representing Webhook resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchResultFromTestCaseResultName(testCaseResultName)
matchResultFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the result from TestCaseResult resource.
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Type | Description |
string | number | {string} A string representing the result. |
matchSecuritySettingsFromSecuritySettingsName(securitySettingsName)
matchSecuritySettingsFromSecuritySettingsName(securitySettingsName: string): string | number;
Parse the security_settings from SecuritySettings resource.
Name | Description |
securitySettingsName |
string
A fully-qualified path representing SecuritySettings resource. |
Type | Description |
string | number | {string} A string representing the security_settings. |
matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchSessionFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the session from ProjectLocationAgentEnvironmentSession resource.
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the session from ProjectLocationAgentSessionEntityType resource.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchSessionFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;
Parse the session from ProjectLocationAgentSession resource.
Name | Description |
projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchTestCaseFromTestCaseName(testCaseName)
matchTestCaseFromTestCaseName(testCaseName: string): string | number;
Parse the test_case from TestCase resource.
Name | Description |
testCaseName |
string
A fully-qualified path representing TestCase resource. |
Type | Description |
string | number | {string} A string representing the test_case. |
matchTestCaseFromTestCaseResultName(testCaseResultName)
matchTestCaseFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the test_case from TestCaseResult resource.
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Type | Description |
string | number | {string} A string representing the test_case. |
matchTransitionRouteGroupFromTransitionRouteGroupName(transitionRouteGroupName)
matchTransitionRouteGroupFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;
Parse the transition_route_group from TransitionRouteGroup resource.
Name | Description |
transitionRouteGroupName |
string
A fully-qualified path representing TransitionRouteGroup resource. |
Type | Description |
string | number | {string} A string representing the transition_route_group. |
matchVersionFromVersionName(versionName)
matchVersionFromVersionName(versionName: string): string | number;
Parse the version from Version resource.
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Type | Description |
string | number | {string} A string representing the version. |
matchWebhookFromWebhookName(webhookName)
matchWebhookFromWebhookName(webhookName: string): string | number;
Parse the webhook from Webhook resource.
Name | Description |
webhookName |
string
A fully-qualified path representing Webhook resource. |
Type | Description |
string | number | {string} A string representing the webhook. |
pagePath(project, location, agent, flow, page)
pagePath(project: string, location: string, agent: string, flow: string, page: string): string;
Return a fully-qualified page resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
page |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentEnvironmentSessionEntityTypePath(project, location, agent, environment, session, entityType)
projectLocationAgentEnvironmentSessionEntityTypePath(project: string, location: string, agent: string, environment: string, session: string, entityType: string): string;
Return a fully-qualified projectLocationAgentEnvironmentSessionEntityType resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
session |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentEnvironmentSessionPath(project, location, agent, environment, session)
projectLocationAgentEnvironmentSessionPath(project: string, location: string, agent: string, environment: string, session: string): string;
Return a fully-qualified projectLocationAgentEnvironmentSession resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
session |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentSessionEntityTypePath(project, location, agent, session, entityType)
projectLocationAgentSessionEntityTypePath(project: string, location: string, agent: string, session: string, entityType: string): string;
Return a fully-qualified projectLocationAgentSessionEntityType resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
session |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentSessionPath(project, location, agent, session)
projectLocationAgentSessionPath(project: string, location: string, agent: string, session: string): string;
Return a fully-qualified projectLocationAgentSession resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
session |
string
|
Type | Description |
string | {string} Resource name string. |
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Name | Description |
project |
string
|
Type | Description |
string | {string} Resource name string. |
securitySettingsPath(project, location, securitySettings)
securitySettingsPath(project: string, location: string, securitySettings: string): string;
Return a fully-qualified securitySettings resource name string.
Name | Description |
project |
string
|
location |
string
|
securitySettings |
string
|
Type | Description |
string | {string} Resource name string. |
testCasePath(project, location, agent, testCase)
testCasePath(project: string, location: string, agent: string, testCase: string): string;
Return a fully-qualified testCase resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
testCase |
string
|
Type | Description |
string | {string} Resource name string. |
testCaseResultPath(project, location, agent, testCase, result)
testCaseResultPath(project: string, location: string, agent: string, testCase: string, result: string): string;
Return a fully-qualified testCaseResult resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
testCase |
string
|
result |
string
|
Type | Description |
string | {string} Resource name string. |
transitionRouteGroupPath(project, location, agent, flow, transitionRouteGroup)
transitionRouteGroupPath(project: string, location: string, agent: string, flow: string, transitionRouteGroup: string): string;
Return a fully-qualified transitionRouteGroup resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
transitionRouteGroup |
string
|
Type | Description |
string | {string} Resource name string. |
updateWebhook(request, options)
updateWebhook(request?: protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest | undefined, {} | undefined]>;
Updates the specified webhook.
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Webhook]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The webhook to update.
*/
// const webhook = {}
/**
* The mask to control which fields get updated. If the mask is not present,
* all fields will be updated.
*/
// const updateMask = {}
// Imports the Cx library
const {WebhooksClient} = require('@google-cloud/dialogflow-cx').v3;
// Instantiates a client
const cxClient = new WebhooksClient();
async function callUpdateWebhook() {
// Construct request
const request = {
webhook,
};
// Run request
const response = await cxClient.updateWebhook(request);
console.log(response);
}
callUpdateWebhook();
updateWebhook(request, options, callback)
updateWebhook(request: protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
updateWebhook(request, callback)
updateWebhook(request: protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IWebhook, protos.google.cloud.dialogflow.cx.v3.IUpdateWebhookRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
versionPath(project, location, agent, flow, version)
versionPath(project: string, location: string, agent: string, flow: string, version: string): string;
Return a fully-qualified version resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
version |
string
|
Type | Description |
string | {string} Resource name string. |
webhookPath(project, location, agent, webhook)
webhookPath(project: string, location: string, agent: string, webhook: string): string;
Return a fully-qualified webhook resource name string.
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
webhook |
string
|
Type | Description |
string | {string} Resource name string. |