Skip to main content

environments

Overview

Nameenvironments
TypeResource
Idgoogle.dataplex.environments

Fields

NameDatatypeDescription
namestringOutput only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}
descriptionstringOptional. Description of the environment.
createTimestringOutput only. Environment creation time.
displayNamestringOptional. User friendly display name.
endpointsobjectURI Endpoints to access sessions associated with the Environment.
infrastructureSpecobjectConfiguration for the underlying infrastructure used to run workloads.
labelsobjectOptional. User defined labels for the environment.
sessionSpecobjectConfiguration for sessions created for this environment.
sessionStatusobjectStatus of sessions created for this environment.
statestringOutput only. Current state of the environment.
uidstringOutput only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name.
updateTimestringOutput only. The time when the environment was last updated.

Methods

NameAccessible byRequired ParamsDescription
projects_locations_lakes_environments_getSELECTenvironmentsId, lakesId, locationsId, projectsIdGet environment resource.
projects_locations_lakes_environments_listSELECTlakesId, locationsId, projectsIdLists environments under the given lake.
projects_locations_lakes_environments_createINSERTlakesId, locationsId, projectsIdCreate an environment resource.
projects_locations_lakes_environments_deleteDELETEenvironmentsId, lakesId, locationsId, projectsIdDelete the environment resource. All the child resources must have been deleted before environment deletion can be initiated.
_projects_locations_lakes_environments_listEXEClakesId, locationsId, projectsIdLists environments under the given lake.
projects_locations_lakes_environments_patchEXECenvironmentsId, lakesId, locationsId, projectsIdUpdate the environment resource.