# Notebooks API . projects . locations . environments

## Instance Methods

Close httplib2 connections.

Creates a new Environment.

Deletes a single Environment.

Gets details of a single Environment.

Lists environments in a project.

Retrieves the next page of results.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, environmentId=None, x__xgafv=None)`

    Creates a new Environment.

    Args:
      parent: string, Required. Format: `projects/{project_id}/locations/{location}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Definition of a software environment that is used to start a notebook instance.
      "containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance.
        "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
        "tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
      },
      "createTime": "A String", # Output only. The time at which this environment was created.
      "description": "A String", # A brief description of this environment.
      "displayName": "A String", # Display name of this environment for the UI.
      "name": "A String", # Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
      "postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"`
      "vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance.
        "imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
        "imageName": "A String", # Use VM image name to find the image.
        "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`
      },
    }

      environmentId: string, Required. User-defined unique ID of this environment. The `environment_id` must be 1 to 63 characters long and contain only lowercase letters, numeric characters, and dashes. The first character must be a lowercase letter and the last character cannot be a dash.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`delete(name, x__xgafv=None)`

    Deletes a single Environment.

    Args:
      name: string, Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`get(name, x__xgafv=None)`

    Gets details of a single Environment.

    Args:
      name: string, Required. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Definition of a software environment that is used to start a notebook instance.
      "containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance.
        "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
        "tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
      },
      "createTime": "A String", # Output only. The time at which this environment was created.
      "description": "A String", # A brief description of this environment.
      "displayName": "A String", # Display name of this environment for the UI.
      "name": "A String", # Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
      "postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"`
      "vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance.
        "imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
        "imageName": "A String", # Use VM image name to find the image.
        "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`
      },
    }

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

    Lists environments in a project.

    Args:
      parent: string, Required. Format: `projects/{project_id}/locations/{location}` (required)
      pageSize: integer, Maximum return size of the list call.
      pageToken: string, A previous returned page token that can be used to continue listing from the last result.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response for listing environments.
      "environments": [ # A list of returned environments.
        { # Definition of a software environment that is used to start a notebook instance.
          "containerImage": { # Definition of a container image for starting a notebook instance with the environment installed in a container. # Use a container image to start the notebook instance.
            "repository": "A String", # Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`
            "tag": "A String", # The tag of the container image. If not specified, this defaults to the latest tag.
          },
          "createTime": "A String", # Output only. The time at which this environment was created.
          "description": "A String", # A brief description of this environment.
          "displayName": "A String", # Display name of this environment for the UI.
          "name": "A String", # Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}`
          "postStartupScript": "A String", # Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"`
          "vmImage": { # Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. # Use a Compute Engine VM image to start the notebook instance.
            "imageFamily": "A String", # Use this VM image family to find the image; the newest image in this family will be used.
            "imageName": "A String", # Use VM image name to find the image.
            "project": "A String", # Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`
          },
        },
      ],
      "nextPageToken": "A String", # A page token that can be used to continue listing from the last result in the next list call.
      "unreachable": [ # Locations that could not be reached.
        "A String",
      ],
    }

`list_next()`

    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.