Dialogflow API . projects . locations . agent . environments

Instance Methods

users()

Returns the users Resource.

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

Returns the list of all non-draft environments of the specified agent.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all non-draft environments of the specified agent.

Args:
  parent: string, Required. The agent to list all environments from.
Format:
- `projects/<Project Number / ID>/agent`
- `projects/<Project Number / ID>/locations/<Location
ID>/agent (required)
  pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and
at most 1000.
  pageToken: string, Optional. 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 Environments.ListEnvironments.
    "environments": [ # The list of agent environments. There will be a maximum number of items
        # returned based on the page_size field in the request.
      { # You can create multiple versions of your agent and publish them to separate
          # environments.
          #
          # When you edit an agent, you are editing the draft agent. At any point, you
          # can save the draft agent as an agent version, which is an immutable snapshot
          # of your agent.
          #
          # When you save the draft agent, it is published to the default environment.
          # When you create agent versions, you can publish them to custom environments.
          # You can create a variety of custom environments for:
          #
          # - testing
          # - development
          # - production
          # - etc.
          #
          # For more information, see the [versions and environments
          # guide](https://cloud.google.com/dialogflow/docs/agents-versions).
        "state": "A String", # Output only. The state of this environment. This field is read-only, i.e., it cannot be
            # set by create and update methods.
        "description": "A String", # Optional. The developer-provided description for this environment.
            # The maximum length is 500 characters. If exceeded, the request is rejected.
        "updateTime": "A String", # Output only. The last update time of this environment. This field is read-only, i.e., it
            # cannot be set by create and update methods.
        "name": "A String", # Output only. The unique identifier of this agent environment.
            # Format:
            # - `projects/<Project Number / ID>/agent/environments/<Environment ID>`
            # - `projects/<Project Number / ID>/locations/<Location
            # ID>/agent/environments/<Environment ID>`
        "agentVersion": "A String", # Optional. The agent version loaded into this environment.
            # Format: `projects/<Project ID>/agent/versions/<Version ID>`.
      },
    ],
    "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.