Class v3beta1.SecuritySettingsServiceClient (2.15.0)

Service for managing security settings for Dialogflow. v3beta1

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of SecuritySettingsServiceClient.

Parameter

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.

securitySettingsServiceStub

securitySettingsServiceStub?: Promise<{
        [name: string]: Function;
    }>;

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

agentPath(project, location, agent)

agentPath(project: string, location: string, agent: string): string;

Return a fully-qualified agent resource name string.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
changelog	`string`

Returns

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.

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`
continuousTestResult	`string`

Returns

Type	Description
string	{string} Resource name string.

createSecuritySettings(request, options)

createSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, (protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest | undefined), {} | undefined]>;

Create security settings in the specified location.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, (protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest \| undefined), {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [SecuritySettings]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to create an SecuritySettings google.cloud.dialogflow.cx.v3beta1.SecuritySettings  for.
   *  Format: `projects/

createSecuritySettings(request, options, callback)

createSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createSecuritySettings(request, callback)

createSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.ICreateSecuritySettingsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteSecuritySettings(request, options)

deleteSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest | undefined), {} | undefined]>;

Deletes the specified .

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest \| 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.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the SecuritySettings google.cloud.dialogflow.cx.v3beta1.SecuritySettings  to delete.
   *  Format: `projects/

deleteSecuritySettings(request, options, callback)

deleteSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest`
options	`CallOptions`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteSecuritySettings(request, callback)

deleteSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest`
callback	`Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.cx.v3beta1.IDeleteSecuritySettingsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`
deployment	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
entityType	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`
experiment	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`

Returns

Type	Description
string	{string} Resource name string.

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
void

getSecuritySettings(request, options)

getSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, (protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest | undefined), {} | undefined]>;

Retrieves the specified . The returned settings may be stale by up to 1 minute.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, (protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest \| undefined), {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [SecuritySettings]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the settings.
   *  Format: `projects/

getSecuritySettings(request, options, callback)

getSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getSecuritySettings(request, callback)

getSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.IGetSecuritySettingsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

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.

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
intent	`string`

Returns

Type	Description
string	{string} Resource name string.

listSecuritySettings(request, options)

listSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings[], protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsResponse]>;

Returns the list of all security settings in the specified location.

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise<[protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings[], protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest | null, protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [SecuritySettings]. 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 listSecuritySettingsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listSecuritySettings(request, options, callback)

listSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsResponse \| null \| undefined, protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings>`

Returns

Type	Description
void

listSecuritySettings(request, callback)

listSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsResponse | null | undefined, protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest`
callback	`PaginationCallback<protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsResponse \| null \| undefined, protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings>`

Returns

Type	Description
void

listSecuritySettingsAsync(request, options)

listSecuritySettingsAsync(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings>;

Equivalent to listSecuritySettings, but returns an iterable object.

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

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings>

{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 [SecuritySettings]. 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.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The location to list all security settings for.
   *  Format: `projects/

listSecuritySettingsStream(request, options)

listSecuritySettingsStream(request?: protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IListSecuritySettingsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [SecuritySettings] 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 listSecuritySettingsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchAgentFromAgentName(agentName)

matchAgentFromAgentName(agentName: string): string | number;

Parse the agent from Agent resource.

Parameter

Name	Description
agentName	`string` A fully-qualified path representing Agent resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromAgentValidationResultName(agentValidationResultName)

matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the agent from AgentValidationResult resource.

Parameter

Name	Description
agentValidationResultName	`string` A fully-qualified path representing AgentValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromChangelogName(changelogName)

matchAgentFromChangelogName(changelogName: string): string | number;

Parse the agent from Changelog resource.

Parameter

Name	Description
changelogName	`string` A fully-qualified path representing Changelog resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromContinuousTestResultName(continuousTestResultName)

matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the agent from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromDeploymentName(deploymentName)

matchAgentFromDeploymentName(deploymentName: string): string | number;

Parse the agent from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromEntityTypeName(entityTypeName)

matchAgentFromEntityTypeName(entityTypeName: string): string | number;

Parse the agent from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromEnvironmentName(environmentName)

matchAgentFromEnvironmentName(environmentName: string): string | number;

Parse the agent from Environment resource.

Parameter

Name	Description
environmentName	`string` A fully-qualified path representing Environment resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromExperimentName(experimentName)

matchAgentFromExperimentName(experimentName: string): string | number;

Parse the agent from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromFlowName(flowName)

matchAgentFromFlowName(flowName: string): string | number;

Parse the agent from Flow resource.

Parameter

Name	Description
flowName	`string` A fully-qualified path representing Flow resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromFlowValidationResultName(flowValidationResultName)

matchAgentFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the agent from FlowValidationResult resource.

Parameter

Name	Description
flowValidationResultName	`string` A fully-qualified path representing FlowValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromIntentName(intentName)

matchAgentFromIntentName(intentName: string): string | number;

Parse the agent from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromPageName(pageName)

matchAgentFromPageName(pageName: string): string | number;

Parse the agent from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the agent from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromTestCaseName(testCaseName)

matchAgentFromTestCaseName(testCaseName: string): string | number;

Parse the agent from TestCase resource.

Parameter

Name	Description
testCaseName	`string` A fully-qualified path representing TestCase resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromTestCaseResultName(testCaseResultName)

matchAgentFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the agent from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromTransitionRouteGroupName(transitionRouteGroupName)

matchAgentFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the agent from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromVersionName(versionName)

matchAgentFromVersionName(versionName: string): string | number;

Parse the agent from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchAgentFromWebhookName(webhookName)

matchAgentFromWebhookName(webhookName: string): string | number;

Parse the agent from Webhook resource.

Parameter

Name	Description
webhookName	`string` A fully-qualified path representing Webhook resource.

Returns

Type	Description
string \| number	{string} A string representing the agent.

matchChangelogFromChangelogName(changelogName)

matchChangelogFromChangelogName(changelogName: string): string | number;

Parse the changelog from Changelog resource.

Parameter

Name	Description
changelogName	`string` A fully-qualified path representing Changelog resource.

Returns

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.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the continuous_test_result.

matchDeidentifyTemplateFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName)

matchDeidentifyTemplateFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName: string): string | number;

Parse the deidentify_template from OrganizationLocationDeidentifyTemplate resource.

Parameter

Name	Description
organizationLocationDeidentifyTemplateName	`string` A fully-qualified path representing organization_location_deidentify_template resource.

Returns

Type	Description
string \| number	{string} A string representing the deidentify_template.

matchDeidentifyTemplateFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName)

matchDeidentifyTemplateFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName: string): string | number;

Parse the deidentify_template from ProjectLocationDeidentifyTemplate resource.

Parameter

Name	Description
projectLocationDeidentifyTemplateName	`string` A fully-qualified path representing project_location_deidentify_template resource.

Returns

Type	Description
string \| number	{string} A string representing the deidentify_template.

matchDeploymentFromDeploymentName(deploymentName)

matchDeploymentFromDeploymentName(deploymentName: string): string | number;

Parse the deployment from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the deployment.

matchEntityTypeFromEntityTypeName(entityTypeName)

matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;

Parse the entity_type from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

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.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

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.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the entity_type.

matchEnvironmentFromContinuousTestResultName(continuousTestResultName)

matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the environment from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromDeploymentName(deploymentName)

matchEnvironmentFromDeploymentName(deploymentName: string): string | number;

Parse the environment from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromEnvironmentName(environmentName)

matchEnvironmentFromEnvironmentName(environmentName: string): string | number;

Parse the environment from Environment resource.

Parameter

Name	Description
environmentName	`string` A fully-qualified path representing Environment resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromExperimentName(experimentName)

matchEnvironmentFromExperimentName(experimentName: string): string | number;

Parse the environment from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the environment.

matchExperimentFromExperimentName(experimentName)

matchExperimentFromExperimentName(experimentName: string): string | number;

Parse the experiment from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the experiment.

matchFlowFromFlowName(flowName)

matchFlowFromFlowName(flowName: string): string | number;

Parse the flow from Flow resource.

Parameter

Name	Description
flowName	`string` A fully-qualified path representing Flow resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchFlowFromFlowValidationResultName(flowValidationResultName)

matchFlowFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the flow from FlowValidationResult resource.

Parameter

Name	Description
flowValidationResultName	`string` A fully-qualified path representing FlowValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchFlowFromPageName(pageName)

matchFlowFromPageName(pageName: string): string | number;

Parse the flow from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchFlowFromTransitionRouteGroupName(transitionRouteGroupName)

matchFlowFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the flow from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchFlowFromVersionName(versionName)

matchFlowFromVersionName(versionName: string): string | number;

Parse the flow from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the flow.

matchInspectTemplateFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName)

matchInspectTemplateFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName: string): string | number;

Parse the inspect_template from OrganizationLocationInspectTemplate resource.

Parameter

Name	Description
organizationLocationInspectTemplateName	`string` A fully-qualified path representing organization_location_inspect_template resource.

Returns

Type	Description
string \| number	{string} A string representing the inspect_template.

matchInspectTemplateFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName)

matchInspectTemplateFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName: string): string | number;

Parse the inspect_template from ProjectLocationInspectTemplate resource.

Parameter

Name	Description
projectLocationInspectTemplateName	`string` A fully-qualified path representing project_location_inspect_template resource.

Returns

Type	Description
string \| number	{string} A string representing the inspect_template.

matchIntentFromIntentName(intentName)

matchIntentFromIntentName(intentName: string): string | number;

Parse the intent from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the intent.

matchLocationFromAgentName(agentName)

matchLocationFromAgentName(agentName: string): string | number;

Parse the location from Agent resource.

Parameter

Name	Description
agentName	`string` A fully-qualified path representing Agent resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromAgentValidationResultName(agentValidationResultName)

matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the location from AgentValidationResult resource.

Parameter

Name	Description
agentValidationResultName	`string` A fully-qualified path representing AgentValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromChangelogName(changelogName)

matchLocationFromChangelogName(changelogName: string): string | number;

Parse the location from Changelog resource.

Parameter

Name	Description
changelogName	`string` A fully-qualified path representing Changelog resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromContinuousTestResultName(continuousTestResultName)

matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the location from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromDeploymentName(deploymentName)

matchLocationFromDeploymentName(deploymentName: string): string | number;

Parse the location from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromEntityTypeName(entityTypeName)

matchLocationFromEntityTypeName(entityTypeName: string): string | number;

Parse the location from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromEnvironmentName(environmentName)

matchLocationFromEnvironmentName(environmentName: string): string | number;

Parse the location from Environment resource.

Parameter

Name	Description
environmentName	`string` A fully-qualified path representing Environment resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromExperimentName(experimentName)

matchLocationFromExperimentName(experimentName: string): string | number;

Parse the location from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromFlowName(flowName)

matchLocationFromFlowName(flowName: string): string | number;

Parse the location from Flow resource.

Parameter

Name	Description
flowName	`string` A fully-qualified path representing Flow resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromFlowValidationResultName(flowValidationResultName)

matchLocationFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the location from FlowValidationResult resource.

Parameter

Name	Description
flowValidationResultName	`string` A fully-qualified path representing FlowValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromIntentName(intentName)

matchLocationFromIntentName(intentName: string): string | number;

Parse the location from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName)

matchLocationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName: string): string | number;

Parse the location from OrganizationLocationDeidentifyTemplate resource.

Parameter

Name	Description
organizationLocationDeidentifyTemplateName	`string` A fully-qualified path representing organization_location_deidentify_template resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName)

matchLocationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName: string): string | number;

Parse the location from OrganizationLocationInspectTemplate resource.

Parameter

Name	Description
organizationLocationInspectTemplateName	`string` A fully-qualified path representing organization_location_inspect_template resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromPageName(pageName)

matchLocationFromPageName(pageName: string): string | number;

Parse the location from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName)

matchLocationFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName: string): string | number;

Parse the location from ProjectLocationDeidentifyTemplate resource.

Parameter

Name	Description
projectLocationDeidentifyTemplateName	`string` A fully-qualified path representing project_location_deidentify_template resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName)

matchLocationFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName: string): string | number;

Parse the location from ProjectLocationInspectTemplate resource.

Parameter

Name	Description
projectLocationInspectTemplateName	`string` A fully-qualified path representing project_location_inspect_template resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromSecuritySettingsName(securitySettingsName)

matchLocationFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the location from SecuritySettings resource.

Parameter

Name	Description
securitySettingsName	`string` A fully-qualified path representing SecuritySettings resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTestCaseName(testCaseName)

matchLocationFromTestCaseName(testCaseName: string): string | number;

Parse the location from TestCase resource.

Parameter

Name	Description
testCaseName	`string` A fully-qualified path representing TestCase resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTestCaseResultName(testCaseResultName)

matchLocationFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the location from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromTransitionRouteGroupName(transitionRouteGroupName)

matchLocationFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the location from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromVersionName(versionName)

matchLocationFromVersionName(versionName: string): string | number;

Parse the location from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromWebhookName(webhookName)

matchLocationFromWebhookName(webhookName: string): string | number;

Parse the location from Webhook resource.

Parameter

Name	Description
webhookName	`string` A fully-qualified path representing Webhook resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchOrganizationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName)

matchOrganizationFromOrganizationLocationDeidentifyTemplateName(organizationLocationDeidentifyTemplateName: string): string | number;

Parse the organization from OrganizationLocationDeidentifyTemplate resource.

Parameter

Name	Description
organizationLocationDeidentifyTemplateName	`string` A fully-qualified path representing organization_location_deidentify_template resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchOrganizationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName)

matchOrganizationFromOrganizationLocationInspectTemplateName(organizationLocationInspectTemplateName: string): string | number;

Parse the organization from OrganizationLocationInspectTemplate resource.

Parameter

Name	Description
organizationLocationInspectTemplateName	`string` A fully-qualified path representing organization_location_inspect_template resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchPageFromPageName(pageName)

matchPageFromPageName(pageName: string): string | number;

Parse the page from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the page.

matchProjectFromAgentName(agentName)

matchProjectFromAgentName(agentName: string): string | number;

Parse the project from Agent resource.

Parameter

Name	Description
agentName	`string` A fully-qualified path representing Agent resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromAgentValidationResultName(agentValidationResultName)

matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;

Parse the project from AgentValidationResult resource.

Parameter

Name	Description
agentValidationResultName	`string` A fully-qualified path representing AgentValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromChangelogName(changelogName)

matchProjectFromChangelogName(changelogName: string): string | number;

Parse the project from Changelog resource.

Parameter

Name	Description
changelogName	`string` A fully-qualified path representing Changelog resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromContinuousTestResultName(continuousTestResultName)

matchProjectFromContinuousTestResultName(continuousTestResultName: string): string | number;

Parse the project from ContinuousTestResult resource.

Parameter

Name	Description
continuousTestResultName	`string` A fully-qualified path representing ContinuousTestResult resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromDeploymentName(deploymentName)

matchProjectFromDeploymentName(deploymentName: string): string | number;

Parse the project from Deployment resource.

Parameter

Name	Description
deploymentName	`string` A fully-qualified path representing Deployment resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromEntityTypeName(entityTypeName)

matchProjectFromEntityTypeName(entityTypeName: string): string | number;

Parse the project from EntityType resource.

Parameter

Name	Description
entityTypeName	`string` A fully-qualified path representing EntityType resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromEnvironmentName(environmentName)

matchProjectFromEnvironmentName(environmentName: string): string | number;

Parse the project from Environment resource.

Parameter

Name	Description
environmentName	`string` A fully-qualified path representing Environment resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromExperimentName(experimentName)

matchProjectFromExperimentName(experimentName: string): string | number;

Parse the project from Experiment resource.

Parameter

Name	Description
experimentName	`string` A fully-qualified path representing Experiment resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromFlowName(flowName)

matchProjectFromFlowName(flowName: string): string | number;

Parse the project from Flow resource.

Parameter

Name	Description
flowName	`string` A fully-qualified path representing Flow resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromFlowValidationResultName(flowValidationResultName)

matchProjectFromFlowValidationResultName(flowValidationResultName: string): string | number;

Parse the project from FlowValidationResult resource.

Parameter

Name	Description
flowValidationResultName	`string` A fully-qualified path representing FlowValidationResult resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromIntentName(intentName)

matchProjectFromIntentName(intentName: string): string | number;

Parse the project from Intent resource.

Parameter

Name	Description
intentName	`string` A fully-qualified path representing Intent resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromPageName(pageName)

matchProjectFromPageName(pageName: string): string | number;

Parse the project from Page resource.

Parameter

Name	Description
pageName	`string` A fully-qualified path representing Page resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName)

matchProjectFromProjectLocationDeidentifyTemplateName(projectLocationDeidentifyTemplateName: string): string | number;

Parse the project from ProjectLocationDeidentifyTemplate resource.

Parameter

Name	Description
projectLocationDeidentifyTemplateName	`string` A fully-qualified path representing project_location_deidentify_template resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName)

matchProjectFromProjectLocationInspectTemplateName(projectLocationInspectTemplateName: string): string | number;

Parse the project from ProjectLocationInspectTemplate resource.

Parameter

Name	Description
projectLocationInspectTemplateName	`string` A fully-qualified path representing project_location_inspect_template resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromSecuritySettingsName(securitySettingsName)

matchProjectFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the project from SecuritySettings resource.

Parameter

Name	Description
securitySettingsName	`string` A fully-qualified path representing SecuritySettings resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTestCaseName(testCaseName)

matchProjectFromTestCaseName(testCaseName: string): string | number;

Parse the project from TestCase resource.

Parameter

Name	Description
testCaseName	`string` A fully-qualified path representing TestCase resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTestCaseResultName(testCaseResultName)

matchProjectFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the project from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromTransitionRouteGroupName(transitionRouteGroupName)

matchProjectFromTransitionRouteGroupName(transitionRouteGroupName: string): string | number;

Parse the project from TransitionRouteGroup resource.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromVersionName(versionName)

matchProjectFromVersionName(versionName: string): string | number;

Parse the project from Version resource.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromWebhookName(webhookName)

matchProjectFromWebhookName(webhookName: string): string | number;

Parse the project from Webhook resource.

Parameter

Name	Description
webhookName	`string` A fully-qualified path representing Webhook resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchResultFromTestCaseResultName(testCaseResultName)

matchResultFromTestCaseResultName(testCaseResultName: string): string | number;

Parse the result from TestCaseResult resource.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

Type	Description
string \| number	{string} A string representing the result.

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName)

matchSecuritySettingsFromSecuritySettingsName(securitySettingsName: string): string | number;

Parse the security_settings from SecuritySettings resource.

Parameter

Name	Description
securitySettingsName	`string` A fully-qualified path representing SecuritySettings resource.

Returns

Type	Description
string \| number	{string} A string representing the security_settings.

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)

matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentEnvironmentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_environment_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameter

Name	Description
projectLocationAgentSessionEntityTypeName	`string` A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns

Type	Description
string \| number	{string} A string representing the session.

matchTestCaseFromTestCaseName(testCaseName)

matchTestCaseFromTestCaseName(testCaseName: string): string | number;

Parse the test_case from TestCase resource.

Parameter

Name	Description
testCaseName	`string` A fully-qualified path representing TestCase resource.

Returns

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.

Parameter

Name	Description
testCaseResultName	`string` A fully-qualified path representing TestCaseResult resource.

Returns

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.

Parameter

Name	Description
transitionRouteGroupName	`string` A fully-qualified path representing TransitionRouteGroup resource.

Returns

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.

Parameter

Name	Description
versionName	`string` A fully-qualified path representing Version resource.

Returns

Type	Description
string \| number	{string} A string representing the version.

matchWebhookFromWebhookName(webhookName)

matchWebhookFromWebhookName(webhookName: string): string | number;

Parse the webhook from Webhook resource.

Parameter

Name	Description
webhookName	`string` A fully-qualified path representing Webhook resource.

Returns

Type	Description
string \| number	{string} A string representing the webhook.

organizationLocationDeidentifyTemplatePath(organization, location, deidentifyTemplate)

organizationLocationDeidentifyTemplatePath(organization: string, location: string, deidentifyTemplate: string): string;

Return a fully-qualified organizationLocationDeidentifyTemplate resource name string.

Parameters

Name	Description
organization	`string`
location	`string`
deidentifyTemplate	`string`

Returns

Type	Description
string	{string} Resource name string.

organizationLocationInspectTemplatePath(organization, location, inspectTemplate)

organizationLocationInspectTemplatePath(organization: string, location: string, inspectTemplate: string): string;

Return a fully-qualified organizationLocationInspectTemplate resource name string.

Parameters

Name	Description
organization	`string`
location	`string`
inspectTemplate	`string`

Returns

Type	Description
string	{string} Resource name string.

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`
page	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
environment	`string`
session	`string`
entityType	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
session	`string`
entityType	`string`

Returns

Type	Description
string	{string} Resource name string.

projectLocationDeidentifyTemplatePath(project, location, deidentifyTemplate)

projectLocationDeidentifyTemplatePath(project: string, location: string, deidentifyTemplate: string): string;

Return a fully-qualified projectLocationDeidentifyTemplate resource name string.

Parameters

Name	Description
project	`string`
location	`string`
deidentifyTemplate	`string`

Returns

Type	Description
string	{string} Resource name string.

projectLocationInspectTemplatePath(project, location, inspectTemplate)

projectLocationInspectTemplatePath(project: string, location: string, inspectTemplate: string): string;

Return a fully-qualified projectLocationInspectTemplate resource name string.

Parameters

Name	Description
project	`string`
location	`string`
inspectTemplate	`string`

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
securitySettings	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
testCase	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
testCase	`string`
result	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`
transitionRouteGroup	`string`

Returns

Type	Description
string	{string} Resource name string.

updateSecuritySettings(request, options)

updateSecuritySettings(request?: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, (protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest | undefined), {} | undefined]>;

Updates the specified .

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise<[protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, (protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest \| undefined), {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [SecuritySettings]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example


  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. SecuritySettings  object that contains values for each of the
   *  fields to update.
   */
  // const securitySettings = {}
  /**
   *  Required. 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 {SecuritySettingsServiceClient} = require('@google-cloud/dialogflow-cx').v3beta1;

  // Instantiates a client
  const cxClient = new SecuritySettingsServiceClient();

  async function callUpdateSecuritySettings() {
    // Construct request
    const request = {
      securitySettings,
      updateMask,
    };

    // Run request
    const response = await cxClient.updateSecuritySettings(request);
    console.log(response);
  }

  callUpdateSecuritySettings();

updateSecuritySettings(request, options, callback)

updateSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest`
options	`CallOptions`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateSecuritySettings(request, callback)

updateSecuritySettings(request: protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest`
callback	`Callback<protos.google.cloud.dialogflow.cx.v3beta1.ISecuritySettings, protos.google.cloud.dialogflow.cx.v3beta1.IUpdateSecuritySettingsRequest \| null \| undefined, {} \| null \| undefined>`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
flow	`string`
version	`string`

Returns

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.

Parameters

Name	Description
project	`string`
location	`string`
agent	`string`
webhook	`string`

Returns

Type	Description
string	{string} Resource name string.