Console
    Contact Us Start free

    REST Resource: projects.locations.lakes.environments

    Resource: Environment

    Environment represents a user-visible compute infrastructure for analytics within a lake.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "displayName" 
 : 
 string 
 , 
 "uid" 
 : 
 string 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "labels" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 , 
 "description" 
 : 
 string 
 , 
 "state" 
 : 
 enum (  State 
 
) 
 , 
 "infrastructureSpec" 
 : 
 { 
 object (  InfrastructureSpec 
 
) 
 } 
 , 
 "sessionSpec" 
 : 
 { 
 object (  SessionSpec 
 
) 
 } 
 , 
 "sessionStatus" 
 : 
 { 
 object (  SessionStatus 
 
) 
 } 
 , 
 "endpoints" 
 : 
 { 
 object (  Endpoints 
 
) 
 } 
 }
    Fields
    name

    string

    Output only. The relative resource name of the environment, of the form: projects/{projectId}/locations/{locationId}/lakes/{lakeId}/environment/{environmentId}
    displayName

    string

    Optional. User friendly display name.
    uid

    string

    Output 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.
    createTime

    string ( Timestamp format)

    Output only. Environment creation time.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    updateTime

    string ( Timestamp format)

    Output only. The time when the environment was last updated.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .
    labels

    map (key: string, value: string)

    Optional. User defined labels for the environment.

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .
    description

    string

    Optional. Description of the environment.
    state

    enum ( State )

    Output only. Current state of the environment.
    infrastructureSpec

    object ( InfrastructureSpec )

    Required. Infrastructure specification for the Environment.
    sessionSpec

    object ( SessionSpec )

    Optional. Configuration for sessions created for this environment.
    sessionStatus

    object ( SessionStatus )

    Output only. Status of sessions created for this environment.
    endpoints

    object ( Endpoints )

    Output only. URI Endpoints to access sessions associated with the Environment.

    InfrastructureSpec

    Configuration for the underlying infrastructure used to run workloads.

    JSON representation 
     { 
 // Union field resources 
can be only one of the following: 
 "compute" 
 : 
 { 
 object (  ComputeResources 
 
) 
 } 
 // End of list of possible types for union field resources 
. 
 // Union field runtime 
can be only one of the following: 
 "osImage" 
 : 
 { 
 object (  OsImageRuntime 
 
) 
 } 
 // End of list of possible types for union field runtime 
. 
 }
    Fields
    Union field resources . Hardware config resources can be only one of the following:
    compute

    object ( ComputeResources )

    Optional. Compute resources needed for analyze interactive workloads.

    Union field runtime . Software config runtime can be only one of the following:
    osImage

    object ( OsImageRuntime )

    Required. Software Runtime Configuration for analyze interactive workloads.

    ComputeResources

    Compute resources associated with the analyze interactive workloads.

    JSON representation 
     { 
 "diskSizeGb" 
 : 
 integer 
 , 
 "nodeCount" 
 : 
 integer 
 , 
 "maxNodeCount" 
 : 
 integer 
 }
    Fields
    diskSizeGb

    integer

    Optional. Size in GB of the disk. Default is 100 GB.
    nodeCount

    integer

    Optional. Total number of nodes in the sessions created for this environment.
    maxNodeCount

    integer

    Optional. Max configurable nodes. If maxNodeCount > nodeCount, then auto-scaling is enabled.

    OsImageRuntime

    Software Runtime Configuration to run Analyze.

    JSON representation 
     { 
 "imageVersion" 
 : 
 string 
 , 
 "javaLibraries" 
 : 
 [ 
 string 
 ] 
 , 
 "pythonPackages" 
 : 
 [ 
 string 
 ] 
 , 
 "properties" 
 : 
 { 
 string 
 : 
 string 
 , 
 ... 
 } 
 }
    Fields
    imageVersion

    string

    Required. Dataplex Universal Catalog Image version.
    javaLibraries[]

    string

    Optional. List of Java jars to be included in the runtime environment. Valid input includes Cloud Storage URIs to Jar binaries. For example, gs://bucket-name/my/path/to/file.jar
    pythonPackages[]

    string

    Optional. A list of python packages to be installed. Valid formats include Cloud Storage URI to a PIP installable library. For example, gs://bucket-name/my/path/to/lib.tar.gz
    properties

    map (key: string, value: string)

    Optional. Spark properties to provide configuration for use in sessions created for this environment. The properties to set on daemon config files. Property keys are specified in prefix:property format. The prefix must be "spark".

    An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

    SessionSpec

    Configuration for sessions created for this environment.

    JSON representation 
     { 
 "maxIdleDuration" 
 : 
 string 
 , 
 "enableFastStartup" 
 : 
 boolean 
 }
    Fields
    maxIdleDuration

    string ( Duration format)

    Optional. The idle time configuration of the session. The session will be auto-terminated at the end of this period.

    A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .
    enableFastStartup

    boolean

    Optional. If True, this causes sessions to be pre-created and available for faster startup to enable interactive exploration use-cases. This defaults to False to avoid additional billed charges. These can only be set to True for the environment with name set to "default", and with default configuration.

    SessionStatus

    Status of sessions created for this environment.

    JSON representation 
     { 
 "active" 
 : 
 boolean 
 }
    Fields
    active

    boolean

    Output only. Queries over sessions to mark whether the environment is currently active or not

    Endpoints

    URI Endpoints to access sessions associated with the Environment.

    JSON representation 
     { 
 "notebooks" 
 : 
 string 
 , 
 "sql" 
 : 
 string 
 }
    Fields
    notebooks

    string

    Output only. URI to serve notebook APIs
    sql

    string

    Output only. URI to serve SQL APIs

    Methods

    create

    		Create an environment resource.

    delete

    		Delete the environment resource.

    get

    		Get environment resource.

    getIamPolicy

    		Gets the access control policy for a resource.

    list

    		Lists environments under the given lake.

    patch

    		Update the environment resource.

    setIamPolicy

    		Sets the access control policy on the specified resource.

    testIamPermissions

    		Returns permissions that a caller has on the specified resource.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: