Dialogflow API . projects . locations . agents . environments . deployments

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Retrieves the specified Deployment.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Returns the list of all deployments in the specified Environment.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Retrieves the specified Deployment.

Args:
  name: string, Required. The name of the Deployment. Format: `projects//locations//agents//environments//deployments/`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents an deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.
  "endTime": "A String", # End time of this deployment.
  "flowVersion": "A String", # The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.
  "name": "A String", # The name of the deployment. Format: projects//locations//agents//environments//deployments/.
  "result": { # Result of the deployment. # Result of the deployment.
    "deploymentTestResults": [ # Results of test cases running before the deployment. Format: `projects//locations//agents//testCases//results/`.
      "A String",
    ],
    "experiment": "A String", # The name of the experiment triggered by this deployment. Format: projects//locations//agents//environments//experiments/.
  },
  "startTime": "A String", # Start time of this deployment.
  "state": "A String", # The current state of the deployment.
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all deployments in the specified Environment.

Args:
  parent: string, Required. The Environment to list all environments for. Format: `projects//locations//agents//environments/`. (required)
  pageSize: integer, The maximum number of items to return in a single page. By default 20 and at most 100.
  pageToken: string, The next_page_token value returned from a previous list request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for Deployments.ListDeployments.
  "deployments": [ # The list of deployments. There will be a maximum number of items returned based on the page_size field in the request. The list may in some cases be empty or contain fewer entries than page_size even if this isn't the last page.
    { # Represents an deployment in an environment. A deployment happens when a flow version configured to be active in the environment. You can configure running pre-deployment steps, e.g. running validation test cases, experiment auto-rollout, etc.
      "endTime": "A String", # End time of this deployment.
      "flowVersion": "A String", # The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/.
      "name": "A String", # The name of the deployment. Format: projects//locations//agents//environments//deployments/.
      "result": { # Result of the deployment. # Result of the deployment.
        "deploymentTestResults": [ # Results of test cases running before the deployment. Format: `projects//locations//agents//testCases//results/`.
          "A String",
        ],
        "experiment": "A String", # The name of the experiment triggered by this deployment. Format: projects//locations//agents//environments//experiments/.
      },
      "startTime": "A String", # Start time of this deployment.
      "state": "A String", # The current state of the deployment.
    },
  ],
  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.