1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Dialogflow
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsAgentsEnvironments

ProjectsLocationsAgentsEnvironments

class ProjectsLocationsAgentsEnvironments extends Resource (View source)

The "environments" collection of methods.

Typical usage is:

 $dialogflowService = new Google\Service\Dialogflow(...);
 $environments = $dialogflowService->projects_locations_agents_environments;

Methods

GoogleLongrunningOperation
create(string $parent, GoogleCloudDialogflowCxV3Environment $postBody, array $optParams = [])

Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment (environments.create)

GoogleProtobufEmpty
delete(string $name, array $optParams = [])

Deletes the specified Environment. (environments.delete)

GoogleLongrunningOperation
deployFlow(string $environment, GoogleCloudDialogflowCxV3DeployFlowRequest $postBody, array $optParams = [])

Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployFlowMetadata - response: DeployFlowResponse (environments.deployFlow)

GoogleCloudDialogflowCxV3Environment
get(string $name, array $optParams = [])

Retrieves the specified Environment. (environments.get)

GoogleCloudDialogflowCxV3ListEnvironmentsResponse
listProjectsLocationsAgentsEnvironments(string $parent, array $optParams = [])

Returns the list of all environments in the specified Agent.

GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse
lookupEnvironmentHistory(string $name, array $optParams = [])

Looks up the history of the specified Environment.

GoogleLongrunningOperation
patch(string $name, GoogleCloudDialogflowCxV3Environment $postBody, array $optParams = [])

Updates the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment (environments.patch)

GoogleLongrunningOperation
runContinuousTest(string $environment, GoogleCloudDialogflowCxV3RunContinuousTestRequest $postBody, array $optParams = [])

Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse (environments.runContinuousTest)

Details

at line 54
GoogleLongrunningOperation create(string $parent, GoogleCloudDialogflowCxV3Environment $postBody, array $optParams = [])

Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment (environments.create)

Parameters

string $parent

Required. The Agent to create an Environment for. Format: projects//locations//agents/.
GoogleCloudDialogflowCxV3Environment $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 69
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes the specified Environment. (environments.delete)

Parameters

string $name

Required. The name of the Environment to delete. Format: projects//locations//agents//environments/.
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 89
GoogleLongrunningOperation deployFlow(string $environment, GoogleCloudDialogflowCxV3DeployFlowRequest $postBody, array $optParams = [])

Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployFlowMetadata - response: DeployFlowResponse (environments.deployFlow)

Parameters

string $environment

Required. The environment to deploy the flow to. Format: projects//locations//agents//environments/.
GoogleCloudDialogflowCxV3DeployFlowRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 104
GoogleCloudDialogflowCxV3Environment get(string $name, array $optParams = [])

Retrieves the specified Environment. (environments.get)

Parameters

string $name

Required. The name of the Environment. Format: projects//locations//agents//environments/.
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3Environment

Exceptions

Exception

at line 125
GoogleCloudDialogflowCxV3ListEnvironmentsResponse listProjectsLocationsAgentsEnvironments(string $parent, array $optParams = [])

Returns the list of all environments in the specified Agent.

(environments.listProjectsLocationsAgentsEnvironments)

Parameters

string $parent

Required. The Agent to list all environments for. Format: projects//locations//agents/.
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3ListEnvironmentsResponse

Exceptions

Exception

at line 146
GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse lookupEnvironmentHistory(string $name, array $optParams = [])

Looks up the history of the specified Environment.

(environments.lookupEnvironmentHistory)

Parameters

string $name

Required. Resource name of the environment to look up the history for. Format: projects//locations//agents//environments/.
array $optParams

Optional parameters.

Return Value

GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse

Exceptions

Exception

at line 171
GoogleLongrunningOperation patch(string $name, GoogleCloudDialogflowCxV3Environment $postBody, array $optParams = [])

Updates the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message - response: Environment (environments.patch)

Parameters

string $name

The name of the environment. Format: projects//locations//agents//environments/.
GoogleCloudDialogflowCxV3Environment $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 192
GoogleLongrunningOperation runContinuousTest(string $environment, GoogleCloudDialogflowCxV3RunContinuousTestRequest $postBody, array $optParams = [])

Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse (environments.runContinuousTest)

Parameters

string $environment

Required. Format: projects//locations//agents//environments/.
GoogleCloudDialogflowCxV3RunContinuousTestRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception